X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_quickstart_guide.rst;h=79a30567fbfe54f67f8b6bb170bccf64a233c452;hb=370c6dc33e55bfee7b3b79bcc21481b02a3f1e24;hp=2fedc091d8e708b738e079d9df5af15f901a9b3f;hpb=8e34a4ba53b5e2a280eed6517ed6549bab4cd516;p=oom.git diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index 2fedc091d8..79a30567fb 100644 --- a/docs/oom_quickstart_guide.rst +++ b/docs/oom_quickstart_guide.rst @@ -27,25 +27,39 @@ where can be an official release tag, such as * 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:: > cp -R ~/oom/kubernetes/helm/plugins/ ~/.local/share/helm/plugins - > helm plugin install https://github.com/chartmuseum/helm-push.git + > helm plugin install https://github.com/chartmuseum/helm-push.git \ + --version 0.9.0 -**Step 3** Install Chartmuseum:: +.. 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.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or +**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 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 @@ -56,20 +70,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). - - - -.. note:: - If you want to use CMPv2 certificate onboarding, Cert-Manager must be installed. - :doc:`Click here ` to see how to install Cert-Manager. + e. Add in the command line a value for the global master password + (global.masterPassword). @@ -154,7 +163,7 @@ Example Keystone v3 (required for Rocky and later releases) :language: yaml -**Step 5.** 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:: > chartmuseum --storage local --storage-local-rootdir ~/helm3-storage -port 8879 & @@ -163,13 +172,13 @@ follows:: > helm repo add local http://127.0.0.1:8879 -**Step 6.** 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 7.** 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=] onap @@ -177,7 +186,7 @@ follows:: Sets the helm binary to be used. The default value use helm from PATH -**Step 8.** Display the onap charts that available to be deployed:: +**Step 9.** Display the onap charts that available to be deployed:: > helm repo update > helm search repo onap @@ -189,7 +198,7 @@ follows:: to your deployment charts or values be sure to use ``make`` to update your local Helm repository. -**Step 9.** 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:: @@ -237,7 +246,7 @@ needs. you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests. -**Step 10.** Verify ONAP installation +**Step 11.** Verify ONAP installation Use the following to monitor your deployment and determine when ONAP is ready for use:: @@ -245,15 +254,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 -**Step 11.** Undeploy ONAP +**Step 12.** Undeploy ONAP :: > 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