[GLOBAL] Migrate to helm v3

[oom.git] / docs / oom_quickstart_guide.rst

diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index d573c94..79a3056 100644 (file)
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -27,11 +27,19 @@ where <BRANCH> can be an official release tag, such as
 * 6.0.0 for Frankfurt
 * 7.0.0 for Guilin
 * 8.0.0 for Honolulu
 * 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
 
 **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::
 
 
 **Step 3.** Install Chartmuseum::
 


@@ -50,8 +58,8 @@ 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::
 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
 
 
  a. You may want to selectively enable or disable ONAP components by changing


@@ -62,14 +70,15 @@ to suit your deployment with items like the OpenStack tenant information.
     the Robot Helm charts or Robot section of `openstack.yaml`
 
 
     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.
 
 
 
  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).

 
 
 
 
 
 


@@ -245,9 +254,11 @@ for use::
   > kubectl get pods -n onap -o=wide
 
 .. note::
   > 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
 
 
     > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 


@@ -256,4 +267,5 @@ for use::
 
   > helm undeploy dev
 
 
   > 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