Merge "[DOCS] Clean up docs etc"

4 files changed, 384 insertions, 0 deletions

diff --git a/docs/yaml/cluster.yml b/docs/yaml/cluster.yml
new file mode 100644
index 0000000000..0757e15a28
--- /dev/null
+++ b/docs/yaml/cluster.yml
@@ -0,0 +1,156 @@
+# An example of an HA Kubernetes cluster for ONAP
+nodes:
+- address: 10.12.6.85
+  port: "22"
+  internal_address: 10.0.0.8
+  role:
+  - controlplane
+  - etcd
+  hostname_override: "onap-control-1"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.90
+  port: "22"
+  internal_address: 10.0.0.11
+  role:
+  - controlplane
+  - etcd
+  hostname_override: "onap-control-2"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.89
+  port: "22"
+  internal_address: 10.0.0.12
+  role:
+  - controlplane
+  - etcd
+  hostname_override: "onap-control-3"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.5.165
+  port: "22"
+  internal_address: 10.0.0.14
+  role:
+  - worker
+  hostname_override: "onap-k8s-1"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.238
+  port: "22"
+  internal_address: 10.0.0.26
+  role:
+  - worker
+  hostname_override: "onap-k8s-2"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.126
+  port: "22"
+  internal_address: 10.0.0.5
+  role:
+  - worker
+  hostname_override: "onap-k8s-3"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.5.11
+  port: "22"
+  internal_address: 10.0.0.6
+  role:
+  - worker
+  hostname_override: "onap-k8s-4"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.244
+  port: "22"
+  internal_address: 10.0.0.9
+  role:
+  - worker
+  hostname_override: "onap-k8s-5"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.249
+  port: "22"
+  internal_address: 10.0.0.17
+  role:
+  - worker
+  hostname_override: "onap-k8s-6"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.5.191
+  port: "22"
+  internal_address: 10.0.0.20
+  role:
+  - worker
+  hostname_override: "onap-k8s-7"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.111
+  port: "22"
+  internal_address: 10.0.0.10
+  role:
+  - worker
+  hostname_override: "onap-k8s-8"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.195
+  port: "22"
+  internal_address: 10.0.0.4
+  role:
+  - worker
+  hostname_override: "onap-k8s-9"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.5.160
+  port: "22"
+  internal_address: 10.0.0.16
+  role:
+  - worker
+  hostname_override: "onap-k8s-10"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.74
+  port: "22"
+  internal_address: 10.0.0.18
+  role:
+  - worker
+  hostname_override: "onap-k8s-11"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+- address: 10.12.6.82
+  port: "22"
+  internal_address: 10.0.0.7
+  role:
+  - worker
+  hostname_override: "onap-k8s-12"
+  user: ubuntu
+  ssh_key_path: "~/.ssh/onap-key"
+services:
+  kube-api:
+    service_cluster_ip_range: 10.43.0.0/16
+    pod_security_policy: false
+    always_pull_images: false
+  kube-controller:
+    cluster_cidr: 10.42.0.0/16
+    service_cluster_ip_range: 10.43.0.0/16
+  kubelet:
+    cluster_domain: cluster.local
+    cluster_dns_server: 10.43.0.10
+    fail_swap_on: false
+network:
+  plugin: canal
+authentication:
+  strategy: x509
+ssh_key_path: "~/.ssh/onap-key"
+ssh_agent_auth: false
+authorization:
+  mode: rbac
+ignore_docker_version: false
+kubernetes_version: "v1.15.11-rancher1-2"
+private_registries:
+- url: nexus3.onap.org:10001
+  user: docker
+  password: docker
+  is_default: true
+cluster_name: "onap"
+restore:
+  restore: false
+  snapshot_name: ""
diff --git a/docs/yaml/environments_onap_demo.yaml b/docs/yaml/environments_onap_demo.yaml
new file mode 100644
index 0000000000..8b697cbda2
--- /dev/null
+++ b/docs/yaml/environments_onap_demo.yaml
@@ -0,0 +1,103 @@
+#################################################################
+# Global configuration overrides.
+#
+# These overrides will affect all helm charts (ie. applications)
+# that are listed below and are 'enabled'.
+#################################################################
+global:
+  # Change to an unused port prefix range to prevent port conflicts
+  # with other instances running within the same k8s cluster
+  nodePortPrefix: 302
+
+  # image repositories
+  repository: nexus3.onap.org:10001
+  repositorySecret: eyJuZXh1czMub25hcC5vcmc6MTAwMDEiOnsidXNlcm5hbWUiOiJkb2NrZXIiLCJwYXNzd29yZCI6ImRvY2tlciIsImVtYWlsIjoiQCIsImF1dGgiOiJaRzlqYTJWeU9tUnZZMnRsY2c9PSJ9fQ==
+  # readiness check
+  readinessImage: onap/oom/readiness:3.0.1
+  # logging agent
+  loggingRepository: docker.elastic.co
+
+  # image pull policy
+  pullPolicy: IfNotPresent
+
+  # override default mount path root directory
+  # referenced by persistent volumes and log files
+  persistence:
+    mountPath: /dockerdata
+
+  # flag to enable debugging - application support required
+  debugEnabled: true
+
+#################################################################
+# Enable/disable and configure helm charts (ie. applications)
+# to customize the ONAP deployment.
+#################################################################
+aaf:
+  enabled: false
+aai:
+  enabled: false
+appc:
+  enabled: false
+clamp:
+  enabled: true
+cli:
+  enabled: false
+consul: # Consul Health Check Monitoring
+  enabled: false
+cps:
+  enabled: false
+dcaegen2:
+  enabled: false
+log:
+  enabled: false
+message-router:
+  enabled: false
+mock:
+  enabled: false
+msb:
+  enabled: false
+multicloud:
+  enabled: false
+policy:
+  enabled: false
+portal:
+  enabled: false
+robot: # Robot Health Check
+  enabled: true
+sdc:
+  enabled: false
+sdnc:
+  enabled: false
+so: # Service Orchestrator
+  enabled: true
+
+  replicaCount: 1
+
+  liveness:
+    # necessary to disable liveness probe when setting breakpoints
+    # in debugger so K8s doesn't restart unresponsive container
+    enabled: true
+
+  # so server configuration
+  config:
+    # message router configuration
+    dmaapTopic: "AUTO"
+    # openstack configuration
+    openStackUserName: "vnf_user"
+    openStackRegion: "RegionOne"
+    openStackKeyStoneUrl: "http://1.2.3.4:5000"
+    openStackServiceTenantName: "service"
+    openStackEncryptedPasswordHere: "c124921a3a0efbe579782cde8227681e"
+
+  # configure embedded mariadb
+  mariadb:
+    config:
+      mariadbRootPassword: password
+uui:
+  enabled: false
+vfc:
+  enabled: false
+vid:
+  enabled: false
+vnfsdk:
+  enabled: false
diff --git a/docs/yaml/example-integration-override-v3.yaml b/docs/yaml/example-integration-override-v3.yaml
new file mode 100644
index 0000000000..a55b1c08fc
--- /dev/null
+++ b/docs/yaml/example-integration-override-v3.yaml
@@ -0,0 +1,69 @@
+#################################################################
+# This override file configures openstack parameters for ONAP
+#################################################################
+robot:
+  enabled: true
+  flavor: large
+  appcUsername: "appc@appc.onap.org"
+  appcPassword: "demo123456!"
+  # KEYSTONE Version 3  Required for Rocky and beyond
+  openStackKeystoneAPIVersion: "v3"
+  # OS_AUTH_URL without the /v3 from the openstack .RC file
+  openStackKeyStoneUrl: "http://10.12.25.2:5000"
+  # 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"
+  #  OS_PROJECT_DOMAIN_ID from the openstack .RC file
+  #  in some environments it is a string but in other environmens it may be a numeric
+  openStackDomainId:  "default"
+  #  OS_USER_DOMAIN_NAME from the openstack .RC file
+  openStackUserDomain:  "Default"
+  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
+    openStackEncryptedPasswordHere: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_PYTHON_PASSWORD_HERE_XXXXXXXXXXXXXXXX"
+    openStackSoEncryptedPassword:  "YYYYYYYYYYYYYYYYYYYYYYYY_OPENSTACK_JAVA_PASSWORD_HERE_YYYYYYYYYYYYYYYY"
+so:
+  enabled: true
+  so-catalog-db-adapter:
+    config:
+      openStackUserName: "OS_USERNAME_HERE"
+      # OS_AUTH_URL (keep the /v3) from the openstack .RC file
+      openStackKeyStoneUrl: "http://10.12.25.2:5000/v3"
+      # use the SO Java utility to encrypt the OS_PASSWORD for the OS_USERNAME
+      openStackEncryptedPasswordHere: "YYYYYYYYYYYYYYYYYYYYYYYY_OPENSTACK_JAVA_PASSWORD_HERE_YYYYYYYYYYYYYYYY"
+appc:
+  enabled: true
+  replicaCount: 3
+  config:
+    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"
+    openStackUserName: "OS_USER_NAME_HERE"
+    openStackEncryptedPassword: "OPENSTACK_CLEAR_TEXT_PASSWORD_HERE"
diff --git a/docs/yaml/example-integration-override.yaml b/docs/yaml/example-integration-override.yaml
new file mode 100644
index 0000000000..5eeee5e2f5
--- /dev/null
+++ b/docs/yaml/example-integration-override.yaml
@@ -0,0 +1,56 @@
+#################################################################
+# This override file configures openstack parameters for ONAP
+#################################################################
+appc:
+  config:
+    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
+    openStackEncryptedPasswordHere: "XXXXXXXXXXXXXXXXXXXXXXXX_OPENSTACK_ENCRYPTED_PASSWORD_HERE_XXXXXXXXXXXXXXXX"
+so:
+  # so server configuration
+  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"