X-Git-Url: https://gerrit.onap.org/r/gitweb?a=blobdiff_plain;f=docs%2Foom_quickstart_guide.rst;h=27d7a063e87b62f087a9b4dbea4907d762f3b6fb;hb=1660a8c5518c45b8a424b15b8c63b71ae0b39c69;hp=d573c94bb0732edf8fd1da3905c04db506cd9ffe;hpb=b01d1397e222f66c244c6ed7387f8440e4260c18;p=oom.git diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst index d573c94bb0..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 @@ -27,11 +27,19 @@ 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 + +.. 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:: @@ -45,13 +53,25 @@ where can be an official release tag, such as More details can be found :doc:`here `. +**Step 4.1** Install Strimzi Kafka Operator: + +- Add the helm repo:: + + > 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 @@ -62,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). @@ -145,12 +166,12 @@ 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 @@ -182,7 +203,7 @@ follows:: > helm repo update > helm search repo onap -.. literalinclude:: helm-search.txt +.. literalinclude:: helm/helm-search.txt .. note:: The setup of the Helm repository is a one time activity. If you make changes @@ -245,9 +266,11 @@ 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 @@ -256,4 +279,5 @@ for use:: > 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