diff options
Diffstat (limited to 'docs/oom_user_guide.rst')
| -rw-r--r-- | docs/oom_user_guide.rst | 53 |
1 files changed, 48 insertions, 5 deletions
diff --git a/docs/oom_user_guide.rst b/docs/oom_user_guide.rst index 97b2fde01a..5dd6b57889 100644 --- a/docs/oom_user_guide.rst +++ b/docs/oom_user_guide.rst @@ -48,7 +48,48 @@ The OOM team with assistance from the ONAP project teams, have built a comprehensive set of Helm charts, yaml files very similar to TOSCA files, that describe the composition of each of the ONAP components and the relationship within and between components. Using this model Helm is able to deploy all of -ONAP this simple command:: +ONAP with a few simple commands. + +Pre-requisites +-------------- +Your environment must have both the Kubernetes `kubectl` and Helm setup as a one time activity. + +Install Kubectl +~~~~~~~~~~~~~~~ +Enter the following to install kubectl (on Ubuntu, there are slight differences on other O/Ss), the Kubernetes command line interface used to manage a Kubernetes cluster:: + + > curl -LO https://storage.googleapis.com/kubernetes-release/release/v1.8.6/bin/linux/amd64/kubectl + > chmod +x ./kubectl + > sudo mv ./kubectl /usr/local/bin/kubectl + > mkdir ~/.kube + +Paste kubectl config from Rancher (see the :ref:`cloud-setup-guide-label` for alternative Kubenetes environment setups) into the `~/.kube/config` file. + +Verify that the Kubernetes config is correct:: + + > kubectl get pods --all-namespaces + +At this point you should see six Kubernetes pods running. + +Install Helm +~~~~~~~~~~~~ +Helm is used by OOM for package and configuration management. To install Helm, enter the following:: + + > wget http://storage.googleapis.com/kubernetes-helm/helm-v2.7.2-linux-amd64.tar.gz + > tar -zxvf helm-v2.7.2-linux-amd64.tar.gz + > sudo mv linux-amd64/helm /usr/local/bin/helm + +Verify the Helm version with:: + + > helm version + +Install the Helm Tiller application and initialize with:: + + > helm init + +Install the Helm Repo +--------------------- +Once kubectl and Helm are setup, one needs to setup a local Helm server to server up the ONAP charts:: > helm install osn/onap @@ -68,10 +109,12 @@ stable which should be removed to avoid confusion:: To prepare your system for an installation of ONAP, you'll need to:: > git clone http://gerrit.onap.org/r/oom - > cd kubernetes + > cd oom/kubernetes + To setup a local Helm server to server up the ONAP charts:: + > helm init > helm serve & Note the port number that is listed and use it in the Helm repo add as follows:: @@ -104,13 +147,13 @@ In any case, setup of the Helm repository is a one time activity. Once the repo is setup, installation of ONAP can be done with a single command:: - > helm install local/onap -name development + > helm install local/onap --name development This will install ONAP from a local repository in a 'development' Helm release. As described below, to override the default configuration values provided by OOM, an environment file can be provided on the command line as follows:: - > helm install local/onap -name development -f onap-development.yaml + > helm install local/onap --name development -f onap-development.yaml To get a summary of the status of all of the pods (containers) running in your deployment:: @@ -127,7 +170,7 @@ deployment:: was created for each of the ONAP components. .. note:: - The Helm `-name` option refers to a release name and not a Kubernetes namespace. + The Helm `--name` option refers to a release name and not a Kubernetes namespace. To install a specific version of a single ONAP component (`so` in this example) |