X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_quickstart_guide.rst;h=27d7a063e87b62f087a9b4dbea4907d762f3b6fb;hb=1660a8c5518c45b8a424b15b8c63b71ae0b39c69;hp=6b1c69cc445696cda258d6701040ee9d4b78b45e;hpb=3199b55c0dfde135bbb2854841fb2f06e1dc5351;p=oom.git diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 6b1c69cc44..27d7a063e8 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -8,7 +8,7 @@ OOM Quick Start Guide ##################### -.. figure:: oomLogoV2-medium.png +.. figure:: images/oom_logo/oomLogoV2-medium.png :align: right Once a Kubernetes environment is available (follow the instructions in @@ -26,19 +26,52 @@ where can be an official release tag, such as * 5.0.1-ONAP for El Alto * 6.0.0 for Frankfurt * 7.0.0 for Guilin +* 8.0.0 for Honolulu +* 9.0.0 for Istanbul +* 10.0.0 for Jakarta **Step 2.** Install Helm Plugins required to deploy ONAP:: - > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm + > cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins + > helm plugin install https://github.com/chartmuseum/helm-push.git \ + --version 0.9.0 +.. note:: + The ``--version 0.9.0`` is required as new version of helm (3.7.0 and up) is + now using ``push`` directly and helm-push is using ``cm-push`` starting + version ``0.10.0`` and up. + +**Step 3.** Install Chartmuseum:: + + > curl -LO https://s3.amazonaws.com/chartmuseum/release/latest/bin/linux/amd64/chartmuseum + > chmod +x ./chartmuseum + > mv ./chartmuseum /usr/local/bin + +**Step 4.** Install Cert-Manager:: + + > kubectl apply -f https://github.com/jetstack/cert-manager/releases/download/v1.2.0/cert-manager.yaml + +More details can be found :doc:`here `. + +**Step 4.1** Install Strimzi Kafka Operator: + +- Add the helm repo:: -**Step 3.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or + > helm repo add strimzi https://strimzi.io/charts/ + +- Install the operator:: + + > helm install strimzi-kafka-operator strimzi/strimzi-kafka-operator --namespace strimzi-system --version 0.28.0 --set watchAnyNamespace=true --create-namespace + +More details can be found :doc:`here `. + +**Step 5.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or an override file like `onap-all.yaml`, `onap-vfw.yaml` or `openstack.yaml` file to suit your deployment with items like the OpenStack tenant information. .. note:: - Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) can be found in - the `oom/kubernetes/onap/resources/overrides/` directory. + Standard and example override files (e.g. `onap-all.yaml`, `openstack.yaml`) + can be found in the `oom/kubernetes/onap/resources/overrides/` directory. a. You may want to selectively enable or disable ONAP components by changing @@ -49,14 +82,15 @@ to suit your deployment with items like the OpenStack tenant information. the Robot Helm charts or Robot section of `openstack.yaml` - c. Encrypt the OpenStack password using the java based script for SO Helm charts - or SO section of `openstack.yaml`. + c. Encrypt the OpenStack password using the java based script for SO Helm + charts or SO section of `openstack.yaml`. d. Update the OpenStack parameters that will be used by Robot, SO and APPC Helm charts or use an override file to replace them. - e. Add in the command line a value for the global master password (global.masterPassword). + e. Add in the command line a value for the global master password + (global.masterPassword). @@ -132,56 +166,58 @@ observe the following constraints. Example Keystone v2.0 -.. literalinclude:: example-integration-override.yaml +.. literalinclude:: yaml/example-integration-override.yaml :language: yaml Example Keystone v3 (required for Rocky and later releases) -.. literalinclude:: example-integration-override-v3.yaml +.. literalinclude:: yaml/example-integration-override-v3.yaml :language: yaml -**Step 4.** To setup a local Helm server to server up the ONAP charts:: +**Step 6.** To setup a local Helm server to server up the ONAP charts:: - > helm serve & + > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 & Note the port number that is listed and use it in the Helm repo add as follows:: > helm repo add local http://127.0.0.1:8879 -**Step 5.** Verify your Helm repository setup with:: +**Step 7.** Verify your Helm repository setup with:: > helm repo list NAME URL local http://127.0.0.1:8879 -**Step 6.** Build a local Helm repository (from the kubernetes directory):: +**Step 8.** Build a local Helm repository (from the kubernetes directory):: - > make SKIP_LINT=TRUE [HELM_BIN=] all + > make SKIP_LINT=TRUE [HELM_BIN=] all ; make SKIP_LINT=TRUE [HELM_BIN=] onap `HELM_BIN` - Sets the helm binary to be used. The default value use helm from PATH. Allow the user to have - multiple version of helm in operating system and choose which one to use. + Sets the helm binary to be used. The default value use helm from PATH -**Step 7.** Display the onap charts that available to be deployed:: - > helm search onap -l +**Step 9.** Display the onap charts that available to be deployed:: -.. literalinclude:: helm-search.txt + > helm repo update + > helm search repo onap + +.. literalinclude:: helm/helm-search.txt .. note:: The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use ``make`` to update your local Helm repository. -**Step 8.** Once the repo is setup, installation of ONAP can be done with a +**Step 10.** Once the repo is setup, installation of ONAP can be done with a single command .. note:: - The ``--timeout 900`` is currently required in Guilin and up to address long - running initialization tasks for DMaaP and SO. Without this timeout value both - applications may fail to deploy. + The ``--timeout 900s`` is currently required in Dublin and later + versions up to address long running initialization tasks for DMaaP + and SO. Without this timeout value both applications may fail to + deploy. .. danger:: We've added the master password on the command line. @@ -195,7 +231,7 @@ single command To deploy all ONAP applications use this command:: > cd oom/kubernetes - > helm deploy dev local/onap --namespace onap --set global.masterPassword=myAwesomePasswordThatINeedToChange -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900 + > helm deploy dev local/onap --namespace onap --create-namespace --set global.masterPassword=myAwesomePasswordThatINeedToChange -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900s All override files may be customized (or replaced by other overrides) as per needs. @@ -222,7 +258,7 @@ needs. you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests. -**Step 9.** Verify ONAP installation +**Step 11.** Verify ONAP installation Use the following to monitor your deployment and determine when ONAP is ready for use:: @@ -230,19 +266,18 @@ for use:: > kubectl get pods -n onap -o=wide .. note:: - While all pods may be in a Running state, it is not a guarantee that all components are running fine. + While all pods may be in a Running state, it is not a guarantee that all + components are running fine. - Launch the healthcheck tests using Robot to verify that the components are healthy:: + Launch the healthcheck tests using Robot to verify that the components are + healthy:: > ~/oom/kubernetes/robot/ete-k8s.sh onap health - Launch Robot distribute health checks to verify whether ONAP runtime components are healthy:: - - > ~/oom/kubernetes/robot/ete-k8s.sh onap healthdist - -**Step 10.** Undeploy ONAP +**Step 12.** Undeploy ONAP :: - > helm undeploy dev --purge + > helm undeploy dev -More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins +More examples of using the deploy and undeploy plugins can be found here: +https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins