Merge "[COMMON] Fix condition equality bashisms"

[oom.git] / docs / oom_quickstart_guide.rst

diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index bc4329e..2fedc09 100644 (file)
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -25,13 +25,21 @@ where <BRANCH> can be an official release tag, such as
 * 4.0.0-ONAP for Dublin
 * 5.0.1-ONAP for El Alto
 * 6.0.0 for Frankfurt
+* 7.0.0 for Guilin
+* 8.0.0 for Honolulu
 
 **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
 
+**Step 3** Install Chartmuseum::
 
-**Step 3.** Customize the Helm charts like `oom/kubernetes/onap/values.yaml` or
+  > 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
 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.
 
@@ -59,6 +67,12 @@ to suit your deployment with items like the OpenStack tenant information.
 
 
 
+.. note::
+  If you want to use CMPv2 certificate onboarding, Cert-Manager must be installed.
+  :doc:`Click here <oom_setup_paas>` to see how to install Cert-Manager.
+
+
+
 a. Enabling/Disabling Components:
 Here is an example of the nominal entries that need to be provided.
 We have different values file available for different contexts.
@@ -140,28 +154,33 @@ Example Keystone v3  (required for Rocky and later releases)
    :language: yaml
 
 
-**Step 4.** To setup a local Helm server to server up the ONAP charts::
+**Step 5.** 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 6.** 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 7.** Build a local Helm repository (from the kubernetes directory)::
+
+  > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all ; make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] onap
+
+`HELM_BIN`
+  Sets the helm binary to be used. The default value use helm from PATH
 
-  > make SKIP_LINT=TRUE all; make SKIP_LINT=TRUE onap
 
-**Step 7.** Display the onap charts that available to be deployed::
+**Step 8.** Display the onap charts that available to be deployed::
 
-  > helm search onap -l
+  > helm repo update
+  > helm search repo onap
 
 .. literalinclude:: helm-search.txt
 
@@ -170,13 +189,14 @@ follows::
   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 9.** Once the repo is setup, installation of ONAP can be done with a
 single command
 
 .. note::
-  The ``--timeout 900`` is currently required in Dublin 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.
@@ -190,7 +210,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.
@@ -217,7 +237,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 10.** Verify ONAP installation
 
 Use the following to monitor your deployment and determine when ONAP is ready
 for use::
@@ -231,9 +251,9 @@ for use::
 
     > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 
-**Step 10.** Undeploy ONAP
+**Step 11.** 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