Merge "Update Quick Install DOC"

3 files changed, 152 insertions, 16 deletions

diff --git a/docs/example-integration-override.yaml b/docs/example-integration-override.yaml
new file mode 100644
index 0000000000..9c336d69ce
--- /dev/null
+++ b/docs/example-integration-override.yaml
@@ -0,0 +1,36 @@
+global:
+  repository: 10.12.5.2:5000
+  pullPolicy: IfNotPresent
+robot:
+  enabled: true
+  flavor: large
+  appcUsername: "appc@appc.onap.org"
+  appcPassword: "APPC_PASSWORD_HERE"
+  openStackKeyStoneUrl: "http://10.12.25.2:5000"
+  openStackPublicNetId: "971040b2-7059-49dc-b220-4fab50cb2ad4"
+  openStackTenantId: "09d8566ea45e43aa974cf447ed591d77"
+  openStackUserName: "OPENSTACK_USERNAME_HERE"
+  ubuntu14Image: "ubuntu-14-04-cloud-amd64"
+  ubuntu16Image: "ubuntu-16-04-cloud-amd64"
+  openStackPrivateNetId: "d4ab89ff-c735-4ce4-93f6-cff445157b98"
+  openStackPrivateSubnetId: "46c2391c-ed98-4fb0-8ab7-88678bc55b9f"
+  openStackPrivateNetCidr: "10.0.0.0/16"
+  openStackSecurityGroup: "3914301b-2996-414f-ba0a-da4b2275a753"
+  openStackOamNetworkCidrPrefix: "10.0"
+  dcaeCollectorIp: "10.12.5.46"
+  vnfPubKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKXDgoo3+WOqcUG8/5uUbk81+yczgwC4Y8ywTmuQqbNxlY1oQ0YxdMUqUnhitSXs5S/yRuAVOYHwGg2mCs20oAINrP+mxBI544AMIb9itPjCtgqtE2EWo6MmnFGbHB4Sx3XioE7F4VPsh7japsIwzOjbrQe+Mua1TGQ5d4nfEOQaaglXLLPFfuc7WbhbJbK6Q7rHqZfRcOwAMXgDoBqlyqKeiKwnumddo2RyNT8ljYmvB6buz7KnMinzo7qB0uktVT05FH9Rg0CTWH5norlG5qXgP2aukL0gk1ph8iAt7uYLf1ktp+LJI2gaF6L0/qli9EmVCSLr1uJ38Q8CBflhkh"
+  demoArtifactsVersion: "1.3.0"
+  demoArtifactsRepoUrl: "https://nexus.onap.org/content/repositories/releases"
+  scriptVersion: "1.3.0"
+  rancherIpAddress: "10.12.6.38"
+  config:
+    openStackEncryptedPasswordHere: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_ENCRYPTED_PASSWORD_HEREXXXXXXXXXXXXXXXX"
+so:
+  enabled: true
+  so-catalog-db-adapter:
+    config:
+      openStackUserName: "OPENSTACK_USERNAME_HERE"
+      openStackKeyStoneUrl: "http://10.12.25.2:5000/v2.0"
+      openStackEncryptedPasswordHere: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_ENCRYPTED_PASSWORD_HEREXXXXXXXXXXXXXXXX"
+
+
diff --git a/docs/helm-search.txt b/docs/helm-search.txt
new file mode 100644
index 0000000000..db95e4f7d7
--- /dev/null
+++ b/docs/helm-search.txt
@@ -0,0 +1,31 @@
+NAME                	CHART VERSION	APP VERSION	DESCRIPTION                                 
+local/onap          	4.0.0        	Dublin     	Open Network Automation Platform (ONAP)     
+local/aaf           	4.0.0        	           	ONAP Application Authorization Framework    
+local/aai           	4.0.0        	           	ONAP Active and Available Inventory         
+local/cassandra     	4.0.0        	           	ONAP cassandra                              
+local/cds           	4.0.0        	           	ONAP Common Design Studio                   
+local/clamp         	4.0.0        	           	ONAP Clamp                                  
+local/cli           	4.0.0        	           	ONAP Command Line Interface                 
+local/consul        	4.0.0        	           	ONAP Consul Agent                           
+local/contrib       	4.0.0        	           	ONAP optional tools                         
+local/dcaegen2      	4.0.0        	           	ONAP DCAE Gen2                              
+local/dmaap         	4.0.1        	           	ONAP DMaaP components                       
+local/esr           	4.0.0        	           	ONAP External System Register               
+local/log           	4.0.0        	           	ONAP Logging ElasticStack                   
+local/msb           	4.0.0        	           	ONAP MicroServices Bus                      
+local/multicloud    	4.0.0        	           	ONAP multicloud broker                      
+local/nbi           	4.0.0        	           	ONAP Northbound Interface                   
+local/oof           	4.0.0        	           	ONAP Optimization Framework                 
+local/pnda          	4.0.0        	           	ONAP DCAE PNDA                              
+local/policy        	4.0.0        	           	ONAP Policy Administration Point            
+local/pomba         	4.0.0        	           	ONAP Post Orchestration Model Based Audit   
+local/portal        	4.0.0        	           	ONAP Web Portal                             
+local/postgres      	4.0.0        	           	ONAP Postgres Server                        
+local/robot         	4.0.0        	           	A helm Chart for kubernetes-ONAP Robot      
+local/sdnc-prom     	4.0.0        	           	ONAP SDNC Policy Driven Ownership Management
+local/sniro-emulator	4.0.0        	           	ONAP Mock Sniro Emulator                    
+local/so            	4.0.0        	           	ONAP Service Orchestrator                   
+local/uui           	4.0.0        	           	ONAP uui                                    
+local/vfc           	4.0.0        	           	ONAP Virtual Function Controller (VF-C)     
+local/vid           	4.0.0        	           	ONAP Virtual Infrastructure Deployment      
+local/vnfsdk        	4.0.0        	           	ONAP VNF SDK 
diff --git a/docs/oom_quickstart_guide.rst b/docs/oom_quickstart_guide.rst
index a965603efd..0e1d3591f7 100644
--- a/docs/oom_quickstart_guide.rst
+++ b/docs/oom_quickstart_guide.rst
@@ -1,4 +1,5 @@
-.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. This work is licensed under a
+.. Creative Commons Attribution 4.0 International License.
 .. http://creativecommons.org/licenses/by/4.0
 .. Copyright 2018 Amdocs, Bell Canada
 
@@ -16,28 +17,79 @@ available), follow the following instructions to deploy ONAP.
 
 **Step 1.** Clone the OOM repository from ONAP gerrit::
 
-  > git clone -b casablanca http://gerrit.onap.org/r/oom
+  > git clone -b 4.0.0-ONAP http://gerrit.onap.org/r/oom
   > cd oom/kubernetes
 
 **Step 2.** Install Helm Plugins required to deploy the ONAP Casablanca release::
 
   > sudo cp -R ~/oom/kubernetes/helm/plugins/ ~/.helm
 
-**Step 3.** Customize the onap/values.yaml file to suit your deployment. You
-may want to selectively enable or disable ONAP components by changing the
-`enabled: true/false` flags as shown below:
+
+**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
+OpenStack tenant information.
+
+
+ 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
+
+
+ c. Encrypt the OpenStack password using the java based script for SO helm charts
+    or SO section of integration-override.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.
+
+
+
+
+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.
 
 .. literalinclude:: onap-values.yaml
    :language: yaml
 
+
+b. Generating ROBOT Encrypted Password:
+The ROBOT encrypted Password uses the same encryption.key as SO but an
+openssl algorithm that works with the python based Robot Framework.
+
 .. note::
-  To generate openStackEncryptedPasswordHere :
+  To generate ROBOT openStackEncryptedPasswordHere :
 
   ``root@olc-rancher:~# 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``
 
-**Step 3.** To setup a local Helm server to server up the ONAP charts::
+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.
+
+.. note::
+  To generate SO openStackEncryptedPasswordHere :
+
+  SO_ENCRYPTION_KEY=`cat ~/oom/kubenertes/so/resources/config/mso/encrypt.key`
+  OS_PASSWORD=XXXX_OS_CLEARTESTPASSWORD_XXXX
+
+  git clone http://gerrit.onap.org/r/integration
+  cd integration/deployment/heat/onap-oom/scripts
+  javac Crypto.java
+  java Crypto "$OS_PASSWORD" "$SO_ENCRYPTION_KEY"
+
+
+d. Update the OpenStack parameters:
+
+.. literalinclude:: example-integration-override.yaml
+   :language: yaml
+
+**Step 4.** To setup a local Helm server to server up the ONAP charts::
 
   > helm serve &
 
@@ -46,31 +98,48 @@ follows::
 
   > helm repo add local http://127.0.0.1:8879
 
-**Step 4.** Verify your Helm repository setup with::
+**Step 5.** Verify your Helm repository setup with::
 
   > helm repo list
   NAME   URL
   local  http://127.0.0.1:8879
 
-**Step 5.** Build a local Helm repository (from the kubernetes directory)::
+**Step 6.** Build a local Helm repository (from the kubernetes directory)::
 
   > make all; make onap
 
-**Step 6.** Display the charts that available to be deployed::
+**Step 7.** Display the onap charts that available to be deployed::
+
+  > helm search onap -l
 
-  > helm search -l
 .. literalinclude:: helm-search.txt
 
 .. note::
   The setup of the Helm repository is a one time activity. If you make changes to your deployment charts or values be sure to use `make` to update your local Helm repository.
 
-**Step 7.** Once the repo is setup, installation of ONAP can be done with a
-single command::
+**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::
+
+    > helm deploy dev local/onap --namespace onap
+
+
+ b. If you are using an integration-override.yaml file use this command::
+
+    > helm deploy dev local/onap -f /root/integration-override.yaml --namespace onap
+
+
+ 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.::
+
+    > helm deploy dev local/onap -f /root/oom/kubernetes/onap/resources/environments/public-cloud.yaml -f /root/integration-override.yaml --namespace onap
 
-  > helm deploy dev local/onap --namespace onap
 
+**Step 9.** Commands to interact with the OOM installation
 
-Use the following to monitor your deployment and determine when ONAP is ready for use::
+Use the following to monitor your deployment and determine when ONAP is
+ready for use::
 
   > kubectl get pods --all-namespaces -o=wide
 
@@ -79,4 +148,4 @@ Undeploying onap can be done using the following command::
   > 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
\ No newline at end of file
+More examples of using the deploy and undeploy plugins can be found here: https://wiki.onap.org/display/DW/OOM+Helm+%28un%29Deploy+plugins