[DOC] Use the right version for ONAP Frankfurt

[oom.git] / docs / oom_quickstart_guide.rst

diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index 928b74d..78af191 100644 (file)
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -21,8 +21,10 @@ available), follow the following instructions to deploy ONAP.
   > cd oom/kubernetes
 
 where <BRANCH> can be an offical release tag, such as
-4.0.0-ONAP for Dublin
-5.0.1-ONAP for El Alto
+
+* 4.0.0-ONAP for Dublin
+* 5.0.1-ONAP for El Alto
+* 6.0.0 for Frankfurt
 
 **Step 2.** Install Helm Plugins required to deploy ONAP::
 
@@ -53,6 +55,7 @@ with items like the OpenStack tenant information.
  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).
 
 
 
@@ -77,7 +80,7 @@ openssl algorithm that works with the python based Robot Framework.
 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
-ROBOT uses in Dublin.
+ROBOT uses in Dublin and upper versions.
 
 .. note::
   To generate SO ``openStackEncryptedPasswordHere`` and ``openStackSoEncryptedPassword``
@@ -98,11 +101,12 @@ ROBOT uses in Dublin.
 
 d. Update the OpenStack parameters:
 
-There are assumptions in the demonstration VNF heat templates about the networking 
-available in the environment. To get the most value out of these templates and the 
-automation that can help confirm the setup is correct, please observe the following 
+There are assumptions in the demonstration VNF heat templates about the networking
+available in the environment. To get the most value out of these templates and the
+automation that can help confirm the setup is correct, please observe the following
 constraints.
 
+
 ``openStackPublicNetId:``
   This network should allow heat templates to add interfaces.
   This need not be an external network, floating IPs can be assigned to the ports on
@@ -124,7 +128,7 @@ constraints.
   setting but for the demonstration VNFs the ip asssignment strategy assumes 10.0 ip prefix.
 
 
-Example Keystone v2.0 
+Example Keystone v2.0
 
 .. literalinclude:: example-integration-override.yaml
    :language: yaml
@@ -135,7 +139,6 @@ 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::
 
   > helm serve &
@@ -153,7 +156,7 @@ follows::
 
 **Step 6.** Build a local Helm repository (from the kubernetes directory)::
 
-  > make all; make onap
+  > make SKIP_LINT=TRUE all; make SKIP_LINT=TRUE onap
 
 **Step 7.** Display the onap charts that available to be deployed::
 
@@ -168,19 +171,33 @@ follows::
 single 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.
+  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.
+
+.. danger::
+  We've added the master password on the command line.
+  You shouldn't put it in a file for safety reason
+  please don't forget to change the value to something random
+
+  A space is also added in front of the command so "history" doesn't catch it.
+  This masterPassword is very sensitive, please be careful!
+
 
 To deploy all ONAP applications use this command::
 
     > 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
+    >  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
 
 All override files may be customized (or replaced by other overrides) as per needs.
 
 `onap-all.yaml`
   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.
 
+`onap-all-ingress-nginx-vhost.yaml`
+  Alternative version of the `onap-all.yaml` but with global ingress controller enabled. It requires the cluster configured with the nginx ingress controller and load balancer.
+  Please use this file instad `onap-all.yaml` if you want to use experimental ingress controller feature.
+
 `environment.yaml`
   Includes configuration values specific to the deployment environment.