mirror of
https://github.com/optim-enterprises-bv/openstack-helm.git
synced 2025-12-25 17:27:33 +00:00
docs: general updates to documentation (#247)
* doc mods and etcd-rabbitmq additions * second pass doc updates * removal of 0.1.0 references in minikube and gs docs
This commit is contained in:
Brandon B. Jozsa
committed by
Alan Meadows
Alan Meadows
parent
c7b518b0e2
commit
3e62cd54e2
@@ -16,9 +16,9 @@ Install a recent version of [Kubernetes/Helm](https://github.com/kubernetes/helm
|
||||
Helm Installation Quickstart:
|
||||
|
||||
```
|
||||
$ curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get > get_helm.sh
|
||||
$ chmod 700 get_helm.sh
|
||||
$ ./get_helm.sh
|
||||
curl https://raw.githubusercontent.com/kubernetes/helm/master/scripts/get > get_helm.sh
|
||||
chmod 700 get_helm.sh
|
||||
./get_helm.sh
|
||||
```
|
||||
|
||||
# TLDR;
|
||||
@@ -32,8 +32,9 @@ git clone https://github.com/att-comdev/openstack-helm.git && cd openstack-helm
|
||||
# Get a list of the current tags:
|
||||
git tag -l
|
||||
|
||||
# Checkout the tag you want to work with (if desired, or use master for development):
|
||||
git checkout 0.1.0
|
||||
# Checkout the tag you want to work with (use master for development):
|
||||
# For stability and testing, checkout the latest stable branch.
|
||||
git checkout 0.2.0
|
||||
|
||||
# Start a local Helm Server:
|
||||
helm serve &
|
||||
@@ -64,6 +65,7 @@ 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=etcd-rabbitmq local/etcd --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
|
||||
@@ -79,7 +81,7 @@ helm install --name=horizon local/horizon --namespace=openstack
|
||||
After installation, start Minikube with the flags listed below. Ensure that you have supplied enough disk, memory, and the current version flag for Kubernetes during `minikube start`. More information can be found [HERE](https://github.com/kubernetes/minikube/blob/master/docs/minikube_start.md).
|
||||
|
||||
```
|
||||
$ minikube start \
|
||||
minikube start \
|
||||
--network-plugin=cni \
|
||||
--kubernetes-version v1.5.1 \
|
||||
--disk-size 40g \
|
||||
@@ -89,71 +91,80 @@ $ minikube start \
|
||||
Next, deploy the [Calico](http://docs.projectcalico.org/master/getting-started/kubernetes/installation/hosted/hosted) manifest. This is not a requirement in cases where you want to use your own CNI-enabled SDN, however you are doing so at your own experience. Note which versions of Calico are recommended for the project in our [Installation Guide](https://github.com/att-comdev/openstack-helm/blob/master/docs/installation/getting-started.md#overview).
|
||||
|
||||
```
|
||||
$ kubectl create -f http://docs.projectcalico.org/v2.0/getting-started/kubernetes/installation/hosted/calico.yaml
|
||||
kubectl create -f http://docs.projectcalico.org/v2.0/getting-started/kubernetes/installation/hosted/calico.yaml
|
||||
```
|
||||
|
||||
Wait for the environment to come up without error (like shown below).
|
||||
|
||||
```
|
||||
$ kubectl get pods -o wide --all-namespaces -w
|
||||
NAMESPACE NAME READY STATUS RESTARTS AGE IP NODE
|
||||
kube-system calico-node-r9b9s 2/2 Running 0 3m 192.168.99.100 minikube
|
||||
kube-system calico-policy-controller-2974666449-hm0zr 1/1 Running 0 3m 192.168.99.100 minikube
|
||||
kube-system configure-calico-r6lnw 0/1 Completed 0 3m 192.168.99.100 minikube
|
||||
kube-system kube-addon-manager-minikube 1/1 Running 0 7m 192.168.99.100 minikube
|
||||
kube-system kube-dns-v20-sh5gp 3/3 Running 0 7m 192.168.120.64 minikube
|
||||
kube-system kubernetes-dashboard-m24s8 1/1 Running 0 7m 192.168.120.65 minikube
|
||||
kubectl get pods -o wide --all-namespaces -w
|
||||
|
||||
# NAMESPACE NAME READY STATUS RESTARTS AGE IP NODE
|
||||
# kube-system calico-node-r9b9s 2/2 Running 0 3m 192.168.99.100 minikube
|
||||
# kube-system calico-policy-controller-2974666449-hm0zr 1/1 Running 0 3m 192.168.99.100 minikube
|
||||
# kube-system configure-calico-r6lnw 0/1 Completed 0 3m 192.168.99.100 minikube
|
||||
# kube-system kube-addon-manager-minikube 1/1 Running 0 7m 192.168.99.100 minikube
|
||||
# kube-system kube-dns-v20-sh5gp 3/3 Running 0 7m 192.168.120.64 minikube
|
||||
# kube-system kubernetes-dashboard-m24s8 1/1 Running 0 7m 192.168.120.65 minikube
|
||||
```
|
||||
|
||||
Next, initialize [Helm](https://github.com/kubernetes/helm/blob/master/docs/install.md#easy-in-cluster-installation) (which includes deploying tiller).
|
||||
|
||||
```
|
||||
$ helm init
|
||||
Creating /Users/admin/.helm
|
||||
Creating /Users/admin/.helm/repository
|
||||
Creating /Users/admin/.helm/repository/cache
|
||||
Creating /Users/admin/.helm/repository/local
|
||||
Creating /Users/admin/.helm/plugins
|
||||
Creating /Users/admin/.helm/starters
|
||||
Creating /Users/admin/.helm/repository/repositories.yaml
|
||||
Creating /Users/admin/.helm/repository/local/index.yaml
|
||||
$HELM_HOME has been configured at $HOME/.helm.
|
||||
helm init
|
||||
|
||||
Tiller (the helm server side component) has been installed into your Kubernetes Cluster.
|
||||
Happy Helming!
|
||||
# Creating /Users/admin/.helm
|
||||
# Creating /Users/admin/.helm/repository
|
||||
# Creating /Users/admin/.helm/repository/cache
|
||||
# Creating /Users/admin/.helm/repository/local
|
||||
# Creating /Users/admin/.helm/plugins
|
||||
# Creating /Users/admin/.helm/starters
|
||||
# Creating /Users/admin/.helm/repository/repositories.yaml
|
||||
# Creating /Users/admin/.helm/repository/local/index.yaml
|
||||
# $HELM_HOME has been configured at $HOME/.helm.
|
||||
|
||||
$ kubectl get pods -o wide --all-namespaces | grep tiller
|
||||
kube-system tiller-deploy-3299276078-n98ct 1/1 Running 0 39s 192.168.120.66 minikube
|
||||
# Tiller (the helm server side component) has been installed into your Kubernetes Cluster.
|
||||
# Happy Helming!
|
||||
```
|
||||
|
||||
Ensure that Tiller is deployed successfully:
|
||||
|
||||
```
|
||||
kubectl get pods -o wide --all-namespaces | grep tiller
|
||||
|
||||
# kube-system tiller-deploy-3299276078-n98ct 1/1 Running 0 39s 192.168.120.66 minikube
|
||||
```
|
||||
|
||||
With Helm installed, you will need to start a local [Helm server](https://github.com/kubernetes/helm/blob/7a15ad381eae794a36494084972e350306e498fd/docs/helm/helm_serve.md#helm-serve) (in the background), and point to a locally configured Helm [repository](https://github.com/kubernetes/helm/blob/7a15ad381eae794a36494084972e350306e498fd/docs/helm/helm_repo_index.md#helm-repo-index):
|
||||
|
||||
```
|
||||
$ helm serve &
|
||||
$ helm repo add local http://localhost:8879/charts
|
||||
"local" has been added to your repositories
|
||||
helm serve &
|
||||
helm repo add local http://localhost:8879/charts
|
||||
|
||||
# "local" has been added to your repositories
|
||||
```
|
||||
|
||||
Verify that the local repository is configured correctly:
|
||||
|
||||
```
|
||||
$ helm repo list
|
||||
NAME URL
|
||||
stable https://kubernetes-charts.storage.googleapis.com/
|
||||
local http://localhost:8879/charts
|
||||
helm repo list
|
||||
|
||||
# NAME URL
|
||||
# stable https://kubernetes-charts.storage.googleapis.com/
|
||||
# local http://localhost:8879/charts
|
||||
```
|
||||
|
||||
Download the latest release of the project, preferably from `master` since you are following the "developer" instructions.
|
||||
|
||||
```
|
||||
$ git clone https://github.com/att-comdev/openstack-helm.git
|
||||
git clone https://github.com/att-comdev/openstack-helm.git
|
||||
```
|
||||
|
||||
Run `make` against the newly cloned project, which will automatically build secrets for the deployment and push the charts to your new local Helm repository:
|
||||
|
||||
```
|
||||
$ cd openstack-helm
|
||||
$ make
|
||||
cd openstack-helm
|
||||
make
|
||||
```
|
||||
|
||||
Perfect! You’re ready to install, develop, deploy, destroy, and repeat (when necessary)!
|
||||
@@ -181,7 +192,7 @@ To deploy Openstack-Helm in development mode, ensure you've created a minikube-a
|
||||
As a result of this guidence, we recommend creating the following for MariaDB like shown below.
|
||||
|
||||
```
|
||||
$ sudo mkdir -p /data/openstack-helm/mariadb
|
||||
sudo mkdir -p /data/openstack-helm/mariadb
|
||||
```
|
||||
|
||||
### Label Minikube Node
|
||||
@@ -189,7 +200,7 @@ $ sudo mkdir -p /data/openstack-helm/mariadb
|
||||
Be sure to label your minikube node according to the documentation in our installation guide (this remains exactly the same).
|
||||
|
||||
```
|
||||
$ kubectl label nodes openstack-control-plane=enabled --all --namespace=openstack
|
||||
kubectl label nodes openstack-control-plane=enabled --all --namespace=openstack
|
||||
|
||||
```
|
||||
***NOTE:*** *You do not need to label your minikube cluster for `ceph-storage`, since development mode uses hostPath.*
|
||||
@@ -200,7 +211,7 @@ $ kubectl label nodes openstack-control-plane=enabled --all --namespace=openstac
|
||||
Now you can deploy the MariaDB chart, which is required by all other child charts.
|
||||
|
||||
```
|
||||
$ helm install --name mariadb --set development.enabled=true local/mariadb --namespace=openstack
|
||||
helm install --name mariadb --set development.enabled=true local/mariadb --namespace=openstack
|
||||
```
|
||||
***IMPORTANT:*** *MariaDB seeding tasks run for quite a while. This is expected behavior, as several checks are completed prior to completion. Please wait for a few minutes for these jobs to finish.*
|
||||
|
||||
@@ -210,15 +221,16 @@ $ helm install --name mariadb --set development.enabled=true local/mariadb --nam
|
||||
Once MariaDB is deployed complete, deploy the other charts as needed.
|
||||
|
||||
```
|
||||
$ 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=horizon local/horizon --namespace=openstack
|
||||
$ helm install --name=cinder local/cinder --namespace=openstack
|
||||
$ helm install --name=glance local/glance --namespace=openstack
|
||||
$ helm install --name=nova local/nova --namespace=openstack
|
||||
$ helm install --name=neutron local/neutron --namespace=openstack
|
||||
$ helm install --name=heat local/heat --namespace=openstack
|
||||
helm install --name=memcached local/memcached --namespace=openstack
|
||||
helm install --name=etcd-rabbitmq local/etcd --namespace=openstack
|
||||
helm install --name=rabbitmq local/rabbitmq --namespace=openstack
|
||||
helm install --name=keystone local/keystone --namespace=openstack
|
||||
helm install --name=horizon local/horizon --namespace=openstack
|
||||
helm install --name=cinder local/cinder --namespace=openstack
|
||||
helm install --name=glance local/glance --namespace=openstack
|
||||
helm install --name=nova local/nova --namespace=openstack
|
||||
helm install --name=neutron local/neutron --namespace=openstack
|
||||
helm install --name=heat local/heat --namespace=openstack
|
||||
```
|
||||
|
||||
# Horizon Management
|
||||
@@ -226,7 +238,7 @@ $ helm install --name=heat local/heat --namespace=openstack
|
||||
After each chart is deployed, you may wish to change the typical service endpoint for Horizon to a `nodePort` service endpoint (this is unique to Minikube deployments). Use the `kubectl edit` command to edit this service manually.
|
||||
|
||||
```
|
||||
$ sudo kubectl edit svc horizon -n openstack
|
||||
sudo kubectl edit svc horizon -n openstack
|
||||
```
|
||||
|
||||
With the deployed manifest in edit mode, you can enable `nodePort` by replicating some of the fields below (specifically, the `nodePort` lines).
|
||||
@@ -267,5 +279,3 @@ If you have any questions, comments, or find any bugs, please submit an issue so
|
||||
# Troubleshooting
|
||||
|
||||
* [Openstack-Helm Minikube Troubleshooting](../troubleshooting/ts-minikube.md)
|
||||
|
||||
|
||||
|
||||
Reference in New Issue
Block a user