Initial Commit for Community Readme Docs (#146)

* initial readme.md for docs

* initial readme.md for docs

* initial readme.md for docs

* formatting, updates, and additions to minikube docs

docs/README.md

@@ -0,0 +1,51 @@
+# Openstack-Helm Documentation
+
+
+## Table of Contents
+
+##  1. [Openstack-Helm Design Principals]()   
+###    1.1 [Mission]()
+#####      1.1.1 [Resiliency]()
+#####      1.1.2 [Scaling]()
+###    1.2 [Helm Overrides]()
+#####      1.2.1 [Resource Limits]()
+#####      1.2.2 [Conditionals]()
+###    1.3 [Init-Containers]()
+#####      1.3.1 [Dependency Checking]()
+###    1.4 [Kubernetes Jobs]()
+#####      1.4.1 [Service Registration]()
+#####      1.4.2 [User Registration]()
+#####      1.4.3 [Database Creation]()
+#####      1.4.4 [Database Migration]()
+###    1.5 [Complimentary Efforts]()
+####      1.5.1 [Image-Based Project Considerations]()
+###    1.6 [Kubernetes State]()
+####      1.6.1 [Third Party Resources]()
+####      1.6.2 [Add-Ons]()
+##  2. [Repository Structure]()
+###    2.1 [Infrastructure Components]()
+###    2.2 [Openstack-Helm Core Services]()
+###    2.3 [Openstack-Helm Add-Ons]()
+##  3. [Operator Resources]()
+###     3.1 [Installation](https://github.com/att-comdev/openstack-helm/blob/master/docs/installation/getting-started.md)
+###     3.2 [Openstack-Helm Chart Definition Overrides]()
+###     3.2 [Openstacak-Helm Upgrades]()
+##  4. [Openstack-Helm Networking]()
+###    4.1 [Kubernetes Control Plane]()
+####     4.1.1 [CNI SDN Considerations]()
+####     4.1.2 [Calico Networking]()
+###    4.2 [Ingress Philosophy]()
+###    4.3 [Openstack Networking]()
+####     4.3.1 [Flat Networking]()
+####     4.3.1 [L2 Networking]()
+##  5. [Security Guidelines]()
+###    5.1 [Network Policies]()
+###    5.2 [Advanced Network Policies]()
+###    5.3 [Role-Based Access Controls]()
+###    5.4 [Security Contexts]()
+###    5.5 [Security Add-Ons]()
+##  6. [Developer Resources](https://github.com/att-comdev/openstack-helm/tree/master/docs/developer)
+###    6.1 [Contributions and Guidelines]()
+###    6.2 [Development Tools]()
+####     6.2.1 [Minikube Development](https://github.com/att-comdev/openstack-helm/blob/master/docs/developer/minikube.md)
+###    6.3 [Tips and Considerations]()

docs/developer/minikube.md

@@ -3,7 +3,9 @@
 Community development is extremely important to us. As an open source development team, we want the development of Openstack-Helm to be an easy experience. Please evaluate, and make recommendations. We want developers to feel welcome to contribute to this project. Below are some instructions and suggestions to help you get started.
 
 # Requirements
-We've tried to minimize the number of prerequisites required in order to get started. The main prerequisite is to install the most recent versions of Minikube and Helm.
+We've tried to minimize the number of prerequisites required in order to get started. For most users, the main prerequisites are to install the most recent versions of Minikube and Helm. For fresh installations, you may also need to install a Hypervisor that works for your system (that is supported by [Minikube](https://kubernetes.io/docs/getting-started-guides/minikube/#requirements)).
+
+**Kubectl:** Download and install the version of [`kubectl`](https://kubernetes.io/docs/getting-started-guides/kubectl/) that matches your Kubernetes deployment.
 
 **Kubernetes Minikube:**
 Ensure that you have installed a recent version of [Kubernetes/Minikube](http://kubernetes.io/docs/getting-started-guides/minikube/).
@@ -19,6 +21,58 @@ $ chmod 700 get_helm.sh
 $ ./get_helm.sh
 ```
 
+# TLDR;
+
+If your environment meets all of the prerequisites above, you can simply use the following commands:
+
+```
+# Clone the project:
+$ git clone https://github.com/att-comdev/openstack-helm.git && cd openstack-helm
+
+# Get a list of the current tags:
+$ git tag -l
+0.1.0
+
+# Checkout the tag you want to work with (if desired, or use master for development):
+$ git checkout 0.1.0
+
+# Start a local Helm Server:
+$ helm serve &
+
+# You may need to change these params for your environment. Look up use of --iso-url if needed:
+$ minikube start \
+        --network-plugin=cni \
+        --kubernetes-version v1.5.1 \
+        --disk-size 40g \
+        --memory 16384 \
+        --cpus 4 \
+        --vm-driver kvm \
+        --iso-url=https://storage.googleapis.com/minikube/iso/minikube-v1.0.4.iso
+
+# Deploy a CNI/SDN:
+kubectl create -f http://docs.projectcalico.org/v2.0/getting-started/kubernetes/installation/hosted/calico.yaml
+
+# Initialize Helm/Deploy Tiller:
+$ helm init
+
+# Package the Openstack-Helm Charts, and push them to your local Helm repository:
+$ make
+
+# Label the Minikube as an Openstack Control Plane node:
+$ kubectl label nodes openstack-control-plane=enabled --all --namespace=openstack
+
+# Deploy each chart:
+$ helm install --name mariadb --set development.enabled=true local/mariadb --namespace=openstack
+$ helm install --name=memcached local/memcached --namespace=openstack
+$ helm install --name=rabbitmq local/rabbitmq --namespace=openstack
+$ helm install --name=keystone local/keystone --namespace=openstack
+$ helm install --name=cinder local/cinder --namespace=openstack
+$ helm install --name=glance local/glance --namespace=openstack
+$ helm install --name=heat local/heat --namespace=openstack
+$ helm install --name=nova local/nova --namespace=openstack
+$ helm install --name=neutron local/neutron --namespace=openstack
+$ helm install --name=horizon local/horizon --namespace=openstack
+```
 
 # Getting Started