Merge "[DOC] Update example override files in quick start guide documentation"

diff --git a/docs/example-integration-override-v3.yaml b/docs/example-integration-override-v3.yaml
index 659389a..a55b1c0 100644 (file)
--- a/docs/example-integration-override-v3.yaml
+++ b/docs/example-integration-override-v3.yaml
@@ -1,6 +1,3 @@
-global:
-  repository: 10.12.5.2:5000
-  pullPolicy: IfNotPresent
 #################################################################
 # This override file configures openstack parameters for ONAP
 #################################################################
@@ -13,7 +10,8 @@ robot:
   openStackKeystoneAPIVersion: "v3"
   # OS_AUTH_URL without the /v3 from the openstack .RC file
   openStackKeyStoneUrl: "http://10.12.25.2:5000"
-  # OS_PROJECT_ID from the openstack .RC file
+  # tenantID=`openstack project show $tenantName | grep -w id | awk '{print $4}'`
+  # where "tenantName" is OS_PROJECT_NAME from openstack .RC file
   openStackTenantId: "09d8566ea45e43aa974cf447ed591d77"
   # OS_USERNAME from the openstack .RC file
   openStackUserName: "OS_USERNAME_HERE"
@@ -25,17 +23,23 @@ robot:
   openStackProjectName: "OPENSTACK_PROJECT_NAME_HERE"
   ubuntu14Image: "ubuntu-14-04-cloud-amd64"
   ubuntu16Image: "ubuntu-16-04-cloud-amd64"
+  # From openstack network list output
   openStackPublicNetId: "971040b2-7059-49dc-b220-4fab50cb2ad4"
+  # From openstack network list output
   openStackPrivateNetId: "83c84b68-80be-4990-8d7f-0220e3c6e5c8"
+  # From openstack network list output
   openStackPrivateSubnetId: "e571c1d1-8ac0-4744-9b40-c3218d0a53a0"
   openStackPrivateNetCidr: "10.0.0.0/16"
   openStackOamNetworkCidrPrefix: "10.0"
+  # From openstack security group list output
   openStackSecurityGroup: "bbe028dc-b64f-4f11-a10f-5c6d8d26dc89"
   dcaeCollectorIp: "10.12.6.109"
+  # SSH public key
   vnfPubKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKXDgoo3+WOqcUG8/5uUbk81+yczgwC4Y8ywTmuQqbNxlY1oQ0YxdMUqUnhitSXs5S/yRuAVOYHwGg2mCs20oAINrP+mxBI544AMIb9itPjCtgqtE2EWo6MmnFGbHB4Sx3XioE7F4VPsh7japsIwzOjbrQe+Mua1TGQ5d4nfEOQaaglXLLPFfuc7WbhbJbK6Q7rHqZfRcOwAMXgDoBqlyqKeiKwnumddo2RyNT8ljYmvB6buz7KnMinzo7qB0uktVT05FH9Rg0CTWH5norlG5qXgP2aukL0gk1ph8iAt7uYLf1ktp+LJI2gaF6L0/qli9EmVCSLr1uJ38Q8CBflhkh"
   demoArtifactsVersion: "1.4.0"
   demoArtifactsRepoUrl: "https://nexus.onap.org/content/repositories/releases"
   scriptVersion: "1.4.0"
+  # rancher node IP where RKE configired
   rancherIpAddress: "10.12.6.160"
   config:
     # use the python utility to encrypt the OS_PASSWORD for the OS_USERNAME
@@ -57,6 +61,7 @@ appc:
     enableClustering: true
     openStackType: "OpenStackProvider"
     openStackName: "OpenStack"
+    # OS_AUTH_URL from the openstack .RC file
     openStackKeyStoneUrl: "http://10.12.25.2:5000/v3"
     openStackServiceTenantName: "OPENSTACK_PROJECT_NAME_HERE"
     openStackDomain: "OPEN_STACK_DOMAIN_NAME_HERE"

diff --git a/docs/example-integration-override.yaml b/docs/example-integration-override.yaml
index 56699d9..5eeee5e 100644 (file)
--- a/docs/example-integration-override.yaml
+++ b/docs/example-integration-override.yaml
@@ -1,6 +1,3 @@
-global:
-  repository: 10.12.5.2:5000
-  pullPolicy: IfNotPresent
 #################################################################
 # This override file configures openstack parameters for ONAP
 #################################################################
@@ -9,30 +6,42 @@ appc:
     enableClustering: false
     openStackType: "OpenStackProvider"
     openStackName: "OpenStack"
+    # OS_AUTH_URL from the openstack .RC file
     openStackKeyStoneUrl: "http://10.12.25.2:5000/v2.0"
     openStackServiceTenantName: "OPENSTACK_TENANTNAME_HERE"
+    # OS_USER_DOMAIN_NAME from the openstack .RC file
     openStackDomain: "Default"
     openStackUserName: "OPENSTACK_USERNAME_HERE"
     openStackEncryptedPassword: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_PASSWORD_HERE_XXXXXXXXXXXXXXXX"
 robot:
   appcUsername: "appc@appc.onap.org"
   appcPassword: "demo123456!"
+  # OS_AUTH_URL without the /v2.0 from the openstack .RC file
   openStackKeyStoneUrl: "http://10.12.25.2:5000"
+  # From openstack network list output
   openStackPublicNetId: "971040b2-7059-49dc-b220-4fab50cb2ad4"
+  # tenantID=`openstack project show $tenantName | grep -w id | awk '{print $4}'`
+  # where "tenantName" is OS_PROJECT_NAME from openstack .RC file
   openStackTenantId: "09d8566ea45e43aa974cf447ed591d77"
   openStackUserName: "OPENSTACK_USERNAME_HERE"
   ubuntu14Image: "ubuntu-14-04-cloud-amd64"
   ubuntu16Image: "ubuntu-16-04-cloud-amd64"
+  # From openstack network list output
   openStackPrivateNetId: "c7824f00-bef7-4864-81b9-f6c3afabd313"
+  # From openstack network list output
   openStackPrivateSubnetId: "2a0e8888-f93e-4615-8d28-fc3d4d087fc3"
   openStackPrivateNetCidr: "10.0.0.0/16"
+  # From openstack security group list output
   openStackSecurityGroup: "3a7a1e7e-6d15-4264-835d-fab1ae81e8b0"
   openStackOamNetworkCidrPrefix: "10.0"
+  # Control node IP
   dcaeCollectorIp: "10.12.6.88"
+  # SSH public key
   vnfPubKey: "ssh-rsa AAAAB3NzaC1yc2EAAAADAQABAAABAQDKXDgoo3+WOqcUG8/5uUbk81+yczgwC4Y8ywTmuQqbNxlY1oQ0YxdMUqUnhitSXs5S/yRuAVOYHwGg2mCs20oAINrP+mxBI544AMIb9itPjCtgqtE2EWo6MmnFGbHB4Sx3XioE7F4VPsh7japsIwzOjbrQe+Mua1TGQ5d4nfEOQaaglXLLPFfuc7WbhbJbK6Q7rHqZfRcOwAMXgDoBqlyqKeiKwnumddo2RyNT8ljYmvB6buz7KnMinzo7qB0uktVT05FH9Rg0CTWH5norlG5qXgP2aukL0gk1ph8iAt7uYLf1ktp+LJI2gaF6L0/qli9EmVCSLr1uJ38Q8CBflhkh"
   demoArtifactsVersion: "1.4.0-SNAPSHOT"
   demoArtifactsRepoUrl: "https://nexus.onap.org/content/repositories/releases"
   scriptVersion: "1.4.0-SNAPSHOT"
+  # rancher node IP where RKE configired
   rancherIpAddress: "10.12.5.127"
   config:
     # openStackEncryptedPasswordHere should match the encrypted string used in SO and APPC and overridden per environment
@@ -42,5 +51,6 @@ so:
   so-catalog-db-adapter:
     config:
       openStackUserName: "OPENSTACK_USERNAME_HERE"
+      # OS_AUTH_URL from the openstack .RC file
       openStackKeyStoneUrl: "http://10.12.25.2:5000/v2.0"
-      openStackEncryptedPasswordHere: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_ENCRYPTED_PASSWORD_HERE_XXXXXXXXXXXXXXXX"
\ No newline at end of file
+      openStackEncryptedPasswordHere: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_ENCRYPTED_PASSWORD_HERE_XXXXXXXXXXXXXXXX"