Fix two scroll bars overlapping
[sdc.git] / docs / configuration.rst
index 55c4751..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-",
@@ -125,7 +136,7 @@ environment.json
                 "commitlog_dir": "/var/lib/cassandra/commitlog",
                 "socket_read_timeout": "20000",
                 "socket_connect_timeout": "20000",
-                "titan_connection_timeout": "10000"
+                "janusgraph_connection_timeout": "10000"
             }
         }
     }
@@ -180,23 +191,20 @@ BE-configuration.yaml
     # Catalog minimum tosca conformance version
     minToscaConformanceLevel: 3.0
 
-    # Titan configuration file location
-    titanCfgFile: /var/lib/jetty/config/catalog-be/titan.properties
-
-    # Does titan holds the persistence data in memory
-    titanInMemoryGraph: false
+    # JanusGraph configuration file location
+    janusGraphCfgFile: /var/lib/jetty/config/catalog-be/janusgraph.properties
 
-    # The timeout for titan to lock on an object in a transaction
-    titanLockTimeout: 1800
+    # Does JanusGraph hold the persistence data in memory
+    janusGraphInMemoryGraph: false
 
-    # The interval to try and reconnect to titan DB when it is down during SDC startup
-    titanReconnectIntervalInSeconds: 3
+    # The timeout for JanusGraph to lock on an object in a transaction
+    janusGraphLockTimeout: 1800
 
-    # The read timeout towards Titan DB when health check is invoked
-    titanHealthCheckReadTimeout: 1
+    # The interval to try and reconnect to JanusGraph DB when it is down during SDC startup
+    janusGraphReconnectIntervalInSeconds: 3
 
-    # The interval to try and reconnect to Elasticsearch when it is down during SDC startup
-    esReconnectIntervalInSeconds: 3
+    # The read timeout towards JanusGraph DB when health check is invoked
+    janusGraphHealthCheckReadTimeout: 1
 
     # The interval to try and reconnect to UEB health check when it is down during SDC startup
     uebHealthCheckReconnectIntervalInSeconds: 15
@@ -247,7 +255,7 @@ BE-configuration.yaml
         # The amount of time the Cassandra client will wait for a response
         socketConnectTimeout: <%= @socket_connect_timeout %>
 
-        # Should an authentication be used when accessing Cassandra
+        # Should authentication be used when accessing Cassandra
         authenticate: true
 
         # Username for accessing Cassandra
@@ -256,14 +264,14 @@ BE-configuration.yaml
         # Password for accessing Cassandra
         password: {{cassandra_password}}
 
-        # Does an ssl should be used
+        # Should ssl be used
         ssl: false
 
         # Location of .truststore file
         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:
@@ -361,7 +347,7 @@ BE-configuration.yaml
             fileExtension: "env"
 
     # Tosca artifacts placeholders
-    # For each artifact there is a template and a scar.
+    # For each artifact there is a template and a csar.
     # For each one the following properties exists:
     #
     # artifactName - The suffix of the artifact file
@@ -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:
@@ -910,7 +882,7 @@ BE-configuration.yaml
             forBaseModule: Base
             forNonBaseModule: Expansion
 
-    # For each generic node type defining it's corresponding class
+    # For each generic node type defining its corresponding class
     genericAssetNodeTypes:
         VFC: org.openecomp.resource.abstract.nodes.VFC
         CVFC: org.openecomp.resource.abstract.nodes.VFC
@@ -976,7 +948,7 @@ BE-configuration.yaml
         #  - c.d.e
         #CR:
         #  - x.y.z
-    # defanition for group types that cannot by created by api
+    # definition for group types that cannot by created by api
     excludedGroupTypesMapping:
         CR:
            - org.openecomp.groups.VfModule
@@ -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
 *****************************************
@@ -1079,14 +1057,14 @@ BE-distribution-engine-configuration.yaml
     startDistributionEngine: true
 
     #This is false by default, since ONAP Dmaap currently doesn't support https
-    # Does https should be used with Dmaap
+    # Should https be used with Dmaap
     useHttpsWithDmaap: false
     opEnvRecoveryIntervalSec: 180
     allowedTimeBeforeStaleSec: 300
     # 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,48 +1090,48 @@ BE-distribution-engine-configuration.yaml
               readTimeoutMs: 2000
               connectTimeoutMs: 500
            basicAuthorization:
-              userName: asdc
-              password: OTLEp5lfVhYdyw5EAtTUBQ==
+              userName: sdc
+              password: changeme
            numOfRetries: 3
 
     currentArtifactInstallationTimeout: 120
 
-BE-titan.properties
-*******************
+BE-janusgraph.properties
+************************
 
 ::
 
-    # Titan storage backend
+    # JanusGraph storage backend
     storage.backend=cassandra
 
-    # Titan storage hostname
+    # JanusGraph storage hostname
     storage.hostname=<%= @CASSANDRA_IP %>
 
-    # Titan storage port]
-    storage.port=9160
+    # JanusGraph storage port
+    storage.port=9042
 
-    # Titan storage username
+    # JanusGraph storage username
     storage.username=<%= @CASSANDRA_USR %>
 
-    # Titan storage password
+    # JanusGraph storage password
     storage.password=<%= @CASSANDRA_PWD %>
 
-    # Titan storage connection timeout
+    # JanusGraph storage connection timeout
     storage.connection-timeout=10000
 
-    # Titan cassandra keyspace name
+    # JanusGraph cassandra keyspace name
     storage.cassandra.keyspace=sdctitan
 
-    # Is Titan cassandra ssl is enabled
+    # Is JanusGraph cassandra ssl is enabled
     storage.cassandra.ssl.enabled=false
 
-    # Titan cassandra ssl truststore file location
+    # JanusGraph cassandra ssl truststore file location
     storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
 
-    # Titan cassandra ssl truststore file password
-    storage.cassandra.ssl.truststore.password=Aa123456
+    # JanusGraph cassandra ssl truststore file password
+    storage.cassandra.ssl.truststore.password=changeme
 
-    # Does titan should use cache
+    # Should JanusGraph use cache
     cache.db-cache = false
 
     # How long in milliseconds should the cache keep entries before flushing them
@@ -1162,22 +1140,22 @@ BE-titan.properties
     # Default expiration time in milliseconds for entries in the cache
     cache.db-cache-time = 180000
 
-    # Size of titan database cache
+    # Size of JanusGraph database cache
     cache.db-cache-size = 0.5
 
-    # Titan cassandra read consistency level
+    # JanusGraph cassandra read consistency level
     storage.cassandra.read-consistency-level=LOCAL_QUORUM
 
-    # Titan cassandra write consistency level
+    # JanusGraph cassandra write consistency level
     storage.cassandra.write-consistency-level=LOCAL_QUORUM
 
-    # Titan cassandra replication strategy class name
+    # JanusGraph cassandra replication strategy class name
     storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy
 
-    # Titan cassandra replication startegy options
+    # JanusGraph cassandra replication startegy options
     storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %>
 
-    # Titan cassandra local data center name
+    # JanusGraph cassandra local data center name
     storage.cassandra.astyanax.local-datacenter=<%= @DC_NAME %>
 
     # Number of times the system attempts to acquire a lock before giving up and throwing an exception
@@ -1222,28 +1200,20 @@ BE-onboarding-configuration.yaml
         truststorePath: /config/truststore
         truststorePassword: <%= @cassandra_truststore_password %>
 
-    # External Testing Configuration
-    externalTestingConfig:
-      #configuration to make available to the front end of this feature
-      client:
-        enabled: true
-      #array of endpoints that SDC-BE should connect with for external testing
-      endpoints:
-        // ID for endpoint
-      - id: vtp
-        // what format of post request does the endpoint accept for runs - json or multi-part form
-        postStyle: application/json
-        // is this endpoint enabled or disabled.
-        enabled: false
-        // base URL for the endpoint
-        url: http://ec2-34-237-35-152.compute-1.amazonaws.com:9090
-        // optional api key to pass in header to endpoint
-        apiKey: blahblahblah
-      - id: certifications repository
-        postStyle: application/json
-        url: http://ec2-34-237-35-152.compute-1.amazonaws.com:9090
-        enabled: true
-        apiKey: blahblahblah2
+externaltesting-configuration.yaml
+**********************************
+
+::
+
+    # configuration to make available to the front end of this feature
+    client:
+      enabled: true
+    # array of endpoints that SDC-BE should connect with for external testing
+    # id,label,enabled,url[,scenariofilter][,apikey]
+    endpoints:
+      - vtp:VTP,true,http://<hostname>[:<port>]/onapapi/vnfsdk-marketplace,c.*
+      - repository:Repository,false,http://<ovphostname>[:<ovpport>]
+
 
 
 vnfrepo-configuration.yaml
@@ -1251,11 +1221,11 @@ vnfrepo-configuration.yaml
 
 ::
 
-    # The port on which the vnfsdk is licensing on
+    # The port on which the vnfsdk is licensing
     vnfRepoPort: <port>
     # The ip where vnfdk is deployed
     vnfRepoHost: <ip>
-    # The url used for querying the vnf sdk for available CSARS
+    # The url used for querying the vnf sdk for available CSARs
     getVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars
     # The url used for downloading the the CSAR from vnf sdk
     downloadVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars/%s/files
@@ -1321,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
@@ -1345,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
@@ -1374,22 +1344,17 @@ 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
 *****************************
 ::
 
-   # defnition of the plugins that exist in sdc
-   # we have a pre defined list of plugins that are conected to the system.
-   # the plugins define where they are shown to who and on what elements
+   # 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
    pluginsList:
         # the DCAE-DS is the SDC monitoring design studio this entry defines there use as part of the service level context
       - pluginId: DCAED
@@ -1428,9 +1393,94 @@ FE-plugins-configuration.yaml
                displayName: "WORKFLOW"
                displayRoles: ["DESIGNER", "TESTER"]
 
-   # how long we will wai for the plugin to respond before cuting it.
+   # how long we will wait for the plugin to respond before cutting it.
    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
+    workspaceMenuConfiguration:
+      VFC:
+      - text: General
+        action: onMenuItemPressed
+        state: workspace.general
+      - text: Deployment Artifact
+        action: onMenuItemPressed
+        state: workspace.deployment_artifacts
+      - text: Information Artifact
+        action: onMenuItemPressed
+        state: workspace.information_artifacts
+      - text: TOSCA Artifacts
+        action: onMenuItemPressed
+        state: workspace.tosca_artifacts
+      - text: Properties
+        action: onMenuItemPressed
+        state: workspace.properties
+      - text: Attributes
+        action: onMenuItemPressed
+        state: workspace.attributes
+      - text: Req. & Capabilities
+        action: onMenuItemPressed
+        state: workspace.reqAndCap
+      - text: Activity Log
+        action: onMenuItemPressed
+        state: workspace.activity_log
+      SERVICE:
+      - text: General
+        action: onMenuItemPressed
+        state: workspace.general
+      - text: TOSCA Artifacts
+        action: onMenuItemPressed
+        state: workspace.tosca_artifacts
+      - text: Composition
+        action: onMenuItemPressed
+        state: workspace.composition.details
+      - text: Operation
+        action: onMenuItemPressed
+        state: workspace.interface_operation
+      - text: Activity Log
+        action: onMenuItemPressed
+        state: workspace.activity_log
+      - text: Management Workflow
+        action: onMenuItemPressed
+        state: workspace.management_workflow
+      - text: 'Network Call Flow '
+        action: onMenuItemPressed
+        state: workspace.network_call_flow
+      - text: Distribution
+        action: onMenuItemPressed
+        state: workspace.distribution
+        disabledRoles:
+        - ADMIN
+        - TESTER
+        - GOVERNOR
+        - DESIGNER
+      - text: Deployment
+        action: onMenuItemPressed
+        state: workspace.deployment
+      - text: Properties Assignment
+        action: onMenuItemPressed
+        state: workspace.properties_assignment
+      - text: Outputs
+        action: onMenuItemPressed
+        state: workspace.outputs_assignment
+      - text: Req. & Capabilities
+        action: onMenuItemPressed
+        state: workspace.reqAndCapEditable
+
+
 Onboarding configuration
 ------------------------