Backend support for operation milestones with activity inputs
[sdc.git] / docs / configuration.rst
index 5156f6e..480aead 100644 (file)
@@ -12,6 +12,9 @@ Configuration
 Global Configuration
 ====================
 
+SDC configuration is applied by several init containers running Chef recipes
+The files below describe the environment files that are applied on startup
+
 environment.json
 ----------------
 
@@ -35,8 +38,6 @@ environment.json
             "FE_VIP": "yyy",
             "ES_VIP": "yyy",
             "KB_VIP": "yyy",
-            "DCAE_BE_VIP": "yyy",
-            "DCAE_FE_VIP": "yyy",
             "interfaces": {
                 "application": "eth0",
                 "private": "eth1"
@@ -58,6 +59,17 @@ environment.json
                 "fqdn": ["10.0.11.1", "10.0.11.1"]
             },
 
+            # Kafka config
+            "Kafka": {
+             "bootstrap": "kafka-bootstrap:9092"
+            },
+
+            # Messaging topics to be used by clients
+            "DistributionTopics": {
+             "notificationTopicName": "SDC-DISTR-NOTIF-TOPIC",
+             "statusTopicName": "SDC-DISTR-STATUS-TOPIC"
+            },
+
             # IPs used for docker configuration
             "Nodes": {
                 "CS": ["yyy"],
@@ -80,6 +92,14 @@ environment.json
             "VnfRepo": {
                 "vnfRepoPort": "8702",
                 "vnfRepoHost": "10.0.14.1"
+            }, 
+            "HelmValidator": {
+                "validator_enabled": true,
+                "helm_version": "3.5.2",
+                "deployable": true,
+                "lintable": false,
+                "strict_lintable": false,
+                "validator_url": "http://sdc-helm-validator:8080/validate"
             }
         },
         "override_attributes": {
@@ -98,23 +118,14 @@ environment.json
                "https_port": "8445"
             },
 
-            # Elasticsearch configuration
-            "elasticsearch": {
-                "cluster_name": "SDC-ES-",
-                "ES_path_home": "/usr/share/elasticsearch",
-                "ES_path_data": "/usr/share/elasticsearch/data",
-                "num_of_replicas": "0",
-                "num_of_shards": "1"
-            },
-
             # Cassandra configuration
             "cassandra": {
                 "concurrent_reads": "32",
                 "num_tokens": "256",
                 "data_dir": "/var/lib/cassandra/data",
                 "hinted_handoff_enabled": "true",
-                "cassandra_user": "asdc_user",
-                "cassandra_password": "Aa1234%^!",
+                "cassandra_user": "sdc_user",
+                "cassandra_password": "changeme",
                 "concurrent_writes": "32",
                 "cluster_name": "SDC-CS-",
                 "datacenter_name": "SDC-CS-",
@@ -195,9 +206,6 @@ BE-configuration.yaml
     # The read timeout towards JanusGraph DB when health check is invoked
     janusGraphHealthCheckReadTimeout: 1
 
-    # The interval to try and reconnect to Elasticsearch when it is down during SDC startup
-    esReconnectIntervalInSeconds: 3
-
     # The interval to try and reconnect to UEB health check when it is down during SDC startup
     uebHealthCheckReconnectIntervalInSeconds: 15
 
@@ -263,7 +271,7 @@ BE-configuration.yaml
         truststorePath : /config/.truststore
 
         # The .truststore file password
-        truststorePassword : Aa123456
+        truststorePassword : changeme
 
         # Keyspaces configuration for Cassandra
         keySpaces:
@@ -273,28 +281,6 @@ BE-configuration.yaml
             - { name: sdccomponent, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
             - { name: sdcrepository, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
 
-    # Application-specific settings of ES
-    elasticSearch:
-
-        # Mapping of index prefix to time-based frame. For example, if below is configured:
-        #
-        # - indexPrefix: auditing events
-        #    creationPeriod: minute
-        #
-        # then ES object of type which is mapped to "auditingevents-*" template, and created on 2015-12-23 13:24:54, will enter "auditingevents-2015-12-23-13-24" index.
-        # Another object created on 2015-12-23 13:25:54, will enter "auditingevents-2015-12-23-13-25" index.
-        # If creationPeriod: month, both of the above will enter "auditingevents-2015-12" index.
-        #
-        # PLEASE NOTE: the timestamps are created in UTC/GMT timezone! This is needed so that timestamps will be correctly presented in Kibana.
-        #
-        # Legal values for creationPeriod - year, month, day, hour, minute, none (meaning no time-based behaviour).
-        #
-        # If no creationPeriod is configured for indexPrefix, default behavour is creationPeriod: month.
-        indicesTimeFrequency:
-            - indexPrefix: auditingevents
-              creationPeriod: month
-            - indexPrefix: monitoring_events
-              creationPeriod: month
 
     # Artifact types placeholder
     artifactTypes:
@@ -431,8 +417,8 @@ BE-configuration.yaml
         summaryOfImpactsToECOMPElements:
             displayName: Summary of impacts to ECOMP elements,OSSs, BSSs
             type: OTHER
-        controlLoopFunctions:
-            displayName: Control Loop Functions
+        automationCompositionFunctions:
+            displayName: Automation Composition Functions
             type: OTHER
         dimensioningInfo:
             displayName: Dimensioning Info
@@ -790,9 +776,6 @@ BE-configuration.yaml
                 - VFC
                 - CVFC
 
-    # Resource informational deployment artifact placeholder
-    resourceInformationalDeployedArtifacts:
-
     # Requirements needed to be fulfilled before certification
     requirementsToFulfillBeforeCert:
 
@@ -838,17 +821,6 @@ BE-configuration.yaml
         # Url for onboarding health check
         healthCheckUri: "/onboarding-api/v1.0/healthcheck"
 
-    dcae:
-        # The ip of the onboarding docker
-        host: <%= @dcae_be_vip %>
-        # The protocol to use
-        protocol: <https/http>
-        # The port the docker is listening on
-        port: <port>
-        # The url of the health check to use
-        healthCheckUri: "/dcae/healthCheck"
-
-
     #GSS IDNS
     # Switchover configuration is used for Geo redundancy to provide automatic failovers
     switchoverDetector:
@@ -860,8 +832,8 @@ BE-configuration.yaml
         feResolveAttempts: 3
         enabled: false
         interval: 60
-        changePriorityUser: ecompasdc
-        changePriorityPassword: ecompasdc123
+        changePriorityUser: onapsdc
+        changePriorityPassword: changeme
         publishNetworkUrl:
         publishNetworkBody: '{"note":"comment"}'
         groups:
@@ -1000,6 +972,12 @@ BE-configuration.yaml
        - DMAAP
        - DCAE
 
+    # This configuration entry lists all node type names prefix that shall be allowed on SDC.
+    definedResourceNamespace:
+       - org.openecomp.resource.
+
+    # Comma separated list of excluded URLs by the DataValidatorFilter
+    dataValidatorFilterExcludedUrls: "/healthCheck,/followed,/authorize"
 
 BE-distribution-engine-configuration.yaml
 *****************************************
@@ -1086,7 +1064,7 @@ BE-distribution-engine-configuration.yaml
     # aai configuration for tenant isolation
     aaiConfig:
        httpRequestConfig:
-          serverRootUrl: https://aai-uint3.test.att.com:8443
+          serverRootUrl: https://aai.onap.org:8443
           resourceNamespaces:
              operationalEnvironments: /aai/v12/cloud-infrastructure/operational-environments
 
@@ -1096,7 +1074,7 @@ BE-distribution-engine-configuration.yaml
              connectTimeoutMs: 1000
           clientCertificate:
              keyStore: /opt/app/jetty/base/be/etc/non-prod.jks
-             keyStorePassword: hmXYcznAljMSisdy8zgcag==
+             keyStorePassword: changeme
           headers:
              X-FromAppId: asdc
           numOfRetries: 3
@@ -1112,14 +1090,14 @@ BE-distribution-engine-configuration.yaml
               readTimeoutMs: 2000
               connectTimeoutMs: 500
            basicAuthorization:
-              userName: asdc
-              password: OTLEp5lfVhYdyw5EAtTUBQ==
+              userName: sdc
+              password: changeme
            numOfRetries: 3
 
     currentArtifactInstallationTimeout: 120
 
 BE-janusgraph.properties
-*******************
+************************
 
 ::
 
@@ -1130,7 +1108,7 @@ BE-janusgraph.properties
     storage.hostname=<%= @CASSANDRA_IP %>
 
     # JanusGraph storage port
-    storage.port=9160
+    storage.port=9042
 
     # JanusGraph storage username
     storage.username=<%= @CASSANDRA_USR %>
@@ -1151,7 +1129,7 @@ BE-janusgraph.properties
     storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
 
     # JanusGraph cassandra ssl truststore file password
-    storage.cassandra.ssl.truststore.password=Aa123456
+    storage.cassandra.ssl.truststore.password=changeme
 
     # Should JanusGraph use cache
     cache.db-cache = false
@@ -1313,9 +1291,6 @@ FE-configuration.yaml
         -
             - &HTTP_IV_USER HTTP_IV_USER
             - &iv-user iv-user
-        -
-            - &USER_ID USER_ID
-            - &user-id user-id
         -
             - &HTTP_CSP_ATTUID HTTP_CSP_ATTUID
             - &csp-attuid csp-attuid
@@ -1337,6 +1312,9 @@ FE-configuration.yaml
         -
             - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL
             - &csp-email csp-email
+        -
+            - &USER_ID USER_ID
+            - &user-id user-id
 
     # Frontend configuration version
     version: 1.0
@@ -1366,14 +1344,9 @@ FE-configuration.yaml
         # What is the interval of the statistics collection
         probeIntervalInSeconds: 15
 
-    # Kibana hostname
-    kibanaHost: localhost
-
-    # Kibana http port
-    kibanaPort: 5601
+    # Comma separated list of excluded URLs by the DataValidatorFilter
+    dataValidatorFilterExcludedUrls: "/healthCheck,/followed,/authorize"
 
-    # Kibana usage protocol
-    kibanaProtocol: http
 
 FE-plugins-configuration.yaml
 *****************************
@@ -1382,10 +1355,6 @@ FE-plugins-configuration.yaml
    # definition of the plugins that exist in sdc
    # we have a pre-defined list of plugins that are connected to the system.
    # the plugins define where they are shown, to whom and on what elements
-   # in addition, the catalog can proxy to the plugin as well if the following 2 keys are set:
-   #     pluginFeProxyUrl - the pattern of the url that should be proxied after the sdc1/feProxy/plugin prefix
-   #     pluginProxyRedirectPath - the redirect path to the plugin (full url including protool/host and port)
-
    pluginsList:
         # the DCAE-DS is the SDC monitoring design studio this entry defines there use as part of the service level context
       - pluginId: DCAED
@@ -1418,8 +1387,6 @@ FE-plugins-configuration.yaml
       - pluginId: WORKFLOW
         pluginDiscoveryUrl: <%= @workflow_discovery_url %>
         pluginSourceUrl: <%= @workflow_source_url %>
-        pluginFeProxyUrl: <%= @workflow_fe_proxy_url %>
-        pluginProxyRedirectPath: <%= @workflow_redirect_path %>
         pluginStateUrl: "workflowDesigner"
         pluginDisplayOptions:
            tab:
@@ -1430,20 +1397,20 @@ FE-plugins-configuration.yaml
    connectionTimeout: 1000
 
 FE-workspace-configuration.yaml
-*****************************
+*******************************
 ::
 
-# this file contains the different configurable UI workspace items that can be set according to resource and service type.
-# the workspaceMenuConfiguration entry defines the workspace menus that are displayed according to type/subtype of the component in the workspace
-# in addition, they can also be disabled for specific roles. the key is the resource type or service type and it will return the list of the menu
-# items that will be displayed.
-#
-# each key had a list of menu items with the following data:
-#   - text: display text,
-#   - state: the state for the screen
-#   - action: action associated
-#   - index: optional - an integer that will be used to decide on the order of appearance
-# following are 2 example
+    # this file contains the different configurable UI workspace items that can be set according to resource and service type.
+    # the workspaceMenuConfiguration entry defines the workspace menus that are displayed according to type/subtype of the component in the workspace
+    # in addition, they can also be disabled for specific roles. the key is the resource type or service type and it will return the list of the menu
+    # items that will be displayed.
+    #
+    # each key had a list of menu items with the following data:
+    #   - text: display text,
+    #   - state: the state for the screen
+    #   - action: action associated
+    #   - index: optional - an integer that will be used to decide on the order of appearance
+    # following are 2 example
     workspaceMenuConfiguration:
       VFC:
       - text: General