Update quickstart guide

[oom.git] / docs / oom_quickstart_guide.rst

diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index 20eb8fa..a641fab 100644 (file)
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -25,21 +25,25 @@ available), follow the following instructions to deploy ONAP.
   > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
 
 
-**Step 3.** Customize the helm charts like onap.values.yaml or an override.yaml
-like integration-override.yaml file to suit your deployment with items like the
+**Step 3.** 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.
+
 
  a. You may want to selectively enable or disable ONAP components by changing
     the `enabled: true/false` flags.
 
 
  b. Encyrpt the OpenStack password using the shell tool for robot and put it in
-    the robot helm charts or robot section of integration-override.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 integration-override.yaml.
+    or SO section of openstack.yaml.
 
 
  d. Update the OpenStack parameters that will be used by robot, SO and APPC helm
@@ -63,9 +67,9 @@ openssl algorithm that works with the python based Robot Framework.
 .. note::
   To generate ROBOT openStackEncryptedPasswordHere :
 
-  ``root@olc-rancher:~# cd so/resources/config/mso/``
+  ``cd so/resources/config/mso/``
 
-  ``root@olc-rancher:~/oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
+  ``/oom/kubernetes/so/resources/config/mso# echo -n "<openstack tenant password>" | openssl aes-128-ecb -e -K `cat encryption.key` -nosalt | xxd -c 256 -p``
 
 c. Generating SO Encrypted Password:
 The SO Encrypted Password uses a java based encryption utility since the
@@ -79,7 +83,8 @@ ROBOT uses in Dublin.
   OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
 
   git clone http://gerrit.onap.org/r/integration
-  cd integration/deployment/heat/onap-oom/scripts
+
+  cd integration/deployment/heat/onap-rke/scripts
   javac Crypto.java
   java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
 
@@ -120,32 +125,46 @@ follows::
 **Step 8.** Once the repo is setup, installation of ONAP can be done with a
 single command
 
- a. If you updated the values directly use this command::
+.. note::
+  The --timeout 900 is currently required in Dublin to address long running initialization tasks
+  for DMaaP and SO. Without this timeout value both applications may fail to deploy.
+
+To deploy all ONAP applications use this command::
 
-    > helm deploy dev local/onap --namespace onap
+    > cd oom/kubernetes
+    > helm deploy dev local/onap --namespace onap -f onap/resources/overrides/onap-all.yaml -f onap/resources/overrides/environment.yaml -f onap/resources/overrides/openstack.yaml --timeout 900
 
+All override files may be customized (or replaced by other overrides) as per needs.
 
- b. If you are using an integration-override.yaml file use this command::
+onap-all.yaml
 
-    > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap
+  Enables the modules in the ONAP deployment. As ONAP is very modular, it is possible to customize ONAP and disable some components through this configuration file.
 
+environment.yaml
 
- c. If you have a slower cloud environment you may want to use the public-cloud.yaml
-    which has longer delay intervals on database updates.::
+  Includes configuration values specific to the deployment environment.
 
-    > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap
+  Example: adapt readiness and liveness timers to the level of performance of your infrastructure
 
+openstack.yaml
 
-**Step 9.** Commands to interact with the OOM installation
+  Includes all the Openstack related information for the default target tenant you want to use to deploy VNFs from ONAP and/or additional parameters for the embedded tests.
 
-Use the following to monitor your deployment and determine when ONAP is
-ready for use::
+**Step 9.** Verify ONAP installation
+
+Use the following to monitor your deployment and determine when ONAP is ready 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.
 
-  > kubectl get pods --all-namespaces -o=wide
+  Launch the healthcheck tests using Robot to verify that the components are healthy.
 
-Undeploying onap can be done using the following command::
+  > ~/oom/kubernetes/robot/ete-k8s.sh onap health
 
-  > helm undeploy dev --purge
+**Step 10.** Undeploy ONAP
 
+> helm undeploy dev --purge
 
 More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins