[COMMON] Add a spellchecker tox profile
[oom.git] / docs / oom_quickstart_guide.rst
index 6b1c69c..2c1e48e 100644 (file)
@@ -78,6 +78,8 @@ openssl algorithm that works with the python based Robot Framework.
     cd so/resources/config/mso/
     /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``
 
     cd so/resources/config/mso/
     /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``
 
+  Use OS_PASSWORD value from openstack .RC file for "openstack tenant password"
+
 c. Generating SO Encrypted Password:
 The SO Encrypted Password uses a java based encryption utility since the
 Java encryption library is not easy to integrate with openssl/python that
 c. Generating SO Encrypted Password:
 The SO Encrypted Password uses a java based encryption utility since the
 Java encryption library is not easy to integrate with openssl/python that
@@ -87,7 +89,7 @@ Robot uses in Dublin and upper versions.
   To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
   ensure `default-jdk` is installed::
 
   To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
   ensure `default-jdk` is installed::
 
-    apt-get update; apt-get install default-jdk
+    sudo apt-get update; sudo apt-get install default-jdk
 
   Then execute::
 
 
   Then execute::
 
@@ -130,6 +132,10 @@ observe the following constraints.
   deployment need not worry about this setting but for the demonstration VNFs
   the ip asssignment strategy assumes 10.0 ip prefix.
 
   deployment need not worry about this setting but for the demonstration VNFs
   the ip asssignment strategy assumes 10.0 ip prefix.
 
+.. note::
+  Copy below required openstack.yaml file and update the parameters for the variables
+  accordingly from openstack environment (openrc file) and replace
+
 Example Keystone v2.0
 
 .. literalinclude:: example-integration-override.yaml
 Example Keystone v2.0
 
 .. literalinclude:: example-integration-override.yaml
@@ -161,8 +167,9 @@ follows::
   > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
 
 `HELM_BIN`
   > make SKIP_LINT=TRUE [HELM_BIN=<HELM_PATH>] all
 
 `HELM_BIN`
-  Sets the helm binary to be used. The default value use helm from PATH. Allow the user to have
-  multiple version of helm in operating system and choose which one to use.
+  Sets the helm binary to be used. The default value use helm from PATH. Allow
+  the user to have multiple version of helm in operating system and choose
+  which one to use.
 
 **Step 7.** Display the onap charts that available to be deployed::
 
 
 **Step 7.** Display the onap charts that available to be deployed::
 
@@ -245,4 +252,17 @@ for use::
 
   > helm undeploy dev --purge
 
 
   > helm undeploy dev --purge
 
+.. note::
+  After undeploy follow the below steps to cleanup everything before redeplying ONAP
+
+::
+
+  > kubectl delete namespace onap
+
+  > kubectl delete pv -n onap --all
+
+  > kubectl delete pvc -n onap --all
+
+  > sudo rm -rf /dockerdata-nfs/*
+
 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