diff options
Diffstat (limited to 'docs')
| -rw-r--r-- | docs/configuration.rst | 1178 | ||||
| -rw-r--r-- | docs/consumedapis.rst | 3 | ||||
| -rw-r--r-- | docs/logging.rst | 10 | ||||
| -rw-r--r-- | docs/offeredapis.rst | 2 |
4 files changed, 1168 insertions, 25 deletions
diff --git a/docs/configuration.rst b/docs/configuration.rst index 085f9c667d..281f07d1a0 100644 --- a/docs/configuration.rst +++ b/docs/configuration.rst @@ -1,27 +1,1179 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +============= Configuration ============= -.. note:: - * This section is used to describe the options a software component offers for configuration. +.. contents:: + :depth: 3 +.. + +Global Configuration +==================== + +environment.json +---------------- + +:: + + { + # Environment name + "name": "xxx", + + # Environment description + "description": "OpenSource-xxx", + + # Chef properties + "cookbook_versions": { + "Deploy-SDandC": "= 1.0.0" + }, + "json_class": "Chef::Environment", + "chef_type": "environment", + + "default_attributes": { + + # IPs used for docker configuration + "CS_VIP": "yyy", + "BE_VIP": "yyy", + "FE_VIP": "yyy", + "ES_VIP": "yyy", + "interfaces": { + "application": "eth0", + "private": "eth1" + }, + + # Configuration parameters used in portal properties + "ECompP": { + "ecomp_rest_url": "http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/auxapi", + "ueb_url_list": "10.0.11.1,10.0.11.1", + "app_secret": "XftIATw9Jr3VzAcPqt3NnJOu", + "app_key": "x9UfO7JsDn8BESVX", + "inbox_name": "ECOMP-PORTAL-INBOX", + "ecomp_redirect_url": "http://portal.api.simpledemo.openecomp.org:8989/ECOMPPORTAL/login.htm", + "app_topic_name": "ECOMP-PORTAL-OUTBOX-SDC1", + "decryption_key": "AGLDdG4D04BKm2IxIWEr8o==" + }, + + # Configuration parameters used by SDC to work with Dmaap + "UEB": { + "PublicKey": "iPIxkpAMI8qTcQj8", + "SecretKey": "Ehq3WyT4bkif4zwgEbvshGal", + "fqdn": ["10.0.11.1", "10.0.11.1"] + }, + + # IPs used for docker configuration + "Nodes": { + "CS": "yyy", + "BE": "yyy", + "FE": "yyy", + "ES": "yyy" + } + }, + "override_attributes": { + + # FE and BE listening ports + "FE": { + "http_port": "8181", + "https_port": "9443" + }, + "BE": { + "http_port": "8080", + "https_port": "8443" + }, + + # 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%^!", + "concurrent_writes": "32", + "cluster_name": "SDC-CS-", + "multithreaded_compaction": "false", + "cache_dir": "/var/lib/cassandra/saved_caches", + "log_file": "/var/lib/cassandra/log/system.log", + "phi_convict_threshold": "8", + "commitlog_dir": "/var/lib/cassandra/commitlog" + } + } + } + +Backend Configurations +====================== + +BE-configuration.yaml +--------------------- + +:: + + # Request headers for identification of the user that made the request + identificationHeaderFields: + - HTTP_IV_USER + - HTTP_CSP_FIRSTNAME + - HTTP_CSP_LASTNAME + - HTTP_IV_REMOTE_ADDRESS + - HTTP_CSP_WSTYPE + + # Catalog backend hostname + beFqdn: <%= @host_ip %> + + # Catalog backend http port + beHttpPort: <%= @catalog_port %> + + # Catalog backend http context + beContext: /sdc/rest/config/get + + # Catalog backend protocol + beProtocol: http + + # Catalog backend ssl port + beSslPort: <%= @ssl_port %> + + # Catalog backend configuration vesrion + version: 1.0 + + # Catalog backend configuration release date + released: 2012-11-30 + + # Catalog tosca current conformance version + toscaConformanceLevel: 4.0 + + # 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 persistency data in memory + titanInMemoryGraph: false + + # The timeout for titan to lock on an object in a transaction + titanLockTimeout: 1800 + + # The interval to try and reconnect to titan DB when it is down during SDC startup + titanReconnectIntervalInSeconds: 3 + + # The read timeout towards Titan DB when health check is invoked + titanHealthCheckReadTimeout: 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 + + # The read timeout towards UEB when helath check is invoked + uebHealthCheckReadTimeout: 4 + + # Protocols being used in SDC + protocols: + - http + - https + + # Default imports + # Under each import there is the file the data will be imported from + defaultImports: + - nodes: + file: nodes.yml + - datatypes: + file: data.yml + - capabilities: + file: capabilities.yml + - relationships: + file: relationships.yml + - groups: + file: groups.yml + - policies: + file: policies.yml + + # Users + # Deprecated. Will be removed in future releases + users: + tom: passwd + bob: passwd + + cassandraConfig: + # Cassandra hostname + cassandraHosts: <%= @cassandra_ip %> + + # Cassandra local data center name + localDataCenter: <%= @DC_NAME %> + + # The read timeout towards Cassandra when health check is invoked + reconnectTimeout : 30000 + + # Should an authentication be used when accessing Cassandra + authenticate: true + + # Username for accessing Cassandra + username: asdc_user + + # Password for accessing Cassnadra + password: {{cassandra_password}} + + # Does an ssl should be used + ssl: false + + # Location of .truststore file + truststorePath : /config/.truststore + + # The .truststore file password + truststorePassword : Aa123456 + + # Keyspaces configuration for Cassandra + keySpaces: + - { name: dox, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']} + - { name: sdcaudit, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']} + - { name: sdcartifact, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']} + - { 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: auditingevents + # 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: + - CHEF + - PUPPET + - SHELL + - YANG + - YANG_XML + - HEAT + - BPEL + - DG_XML + - MURANO_PKG + - WORKFLOW + - NETWORK_CALL_FLOW + - TOSCA_TEMPLATE + - TOSCA_CSAR + - AAI_SERVICE_MODEL + - AAI_VF_MODEL + - AAI_VF_MODULE_MODEL + - AAI_VF_INSTANCE_MODEL + - OTHER + - SNMP_POLL + - SNMP_TRAP + - GUIDE + - PLAN + + # License types placeholder + licenseTypes: + - User + - Installation + - CPU + + # Resource types placeholder + resourceTypes: &allResourceTypes + - VFC + - CP + - VL + - VF + - VFCMT + - Abstract + - CVFC + + #Deployment resource artifacts placeHolder + deploymentResourceArtifacts: + + # Deployment resource instance artifacts placeholders + # For each artifact the following properties exists: + # + # displayName - The display name of the artifact + # type - The type of the artifact + # description - The description of the artifact + # fileExtension - The file extension of the artifact file for uploading + deploymentResourceInstanceArtifacts: + heatEnv: + displayName: "HEAT ENV" + type: HEAT_ENV + description: "Auto-generated HEAT Environment deployment artifact" + fileExtension: "env" + VfHeatEnv: + displayName: "VF HEAT ENV" + type: HEAT_ENV + description: "VF Auto-generated HEAT Environment deployment artifact" + fileExtension: "env" + + # Tosca artifacts placeholders + # For each artifact there is a template and a scar. + # For each one the following properties exists: + # + # artifactName - The suffix of the artifact file + # displayName - The display name of the artifact + # type - The type of the artifact + # description - The description of the artifact + toscaArtifacts: + assetToscaTemplate: + artifactName: -template.yml + displayName: Tosca Template + type: TOSCA_TEMPLATE + description: TOSCA representation of the asset + assetToscaCsar: + artifactName: -csar.csar + displayName: Tosca Model + type: TOSCA_CSAR + description: TOSCA definition package of the asset + + # Resource category to exclude + excludeResourceCategory: + - Generic + + # Resource type to exclude + excludeResourceType: + - PNF + + # Informational resource artifacts placeHolder + # For each artifact the following properties exists: + # + # displayName - The display name of the artifact + # type - The type of the artifact + informationalResourceArtifacts: + features: + displayName: Features + type: OTHER + capacity: + displayName: Capacity + type: OTHER + vendorTestResult: + displayName: Vendor Test Result + type: OTHER + testScripts: + displayName: Test Scripts + type: OTHER + CloudQuestionnaire: + displayName: Cloud Questionnaire (completed) + type: OTHER + HEATTemplateFromVendor: + displayName: HEAT Template from Vendor + type: HEAT + resourceSecurityTemplate: + displayName: Resource Security Template + type: OTHER + + # Service category to exclude + excludeServiceCategory: + + # Informational service artifacts placeHolder + # For each artifact the following properties exists: + # + # displayName - The display name of the artifact + # type - The type of the artifact + informationalServiceArtifacts: + serviceArtifactPlan: + displayName: Service Artifact Plan + type: OTHER + summaryOfImpactsToECOMPElements: + displayName: Summary of impacts to ECOMP elements,OSSs, BSSs + type: OTHER + controlLoopFunctions: + displayName: Control Loop Functions + type: OTHER + dimensioningInfo: + displayName: Dimensioning Info + type: OTHER + affinityRules: + displayName: Affinity Rules + type: OTHER + operationalPolicies: + displayName: Operational Policies + type: OTHER + serviceSpecificPolicies: + displayName: Service-specific Policies + type: OTHER + engineeringRules: + displayName: Engineering Rules (ERD) + type: OTHER + distributionInstructions: + displayName: Distribution Instructions + type: OTHER + certificationTestResults: + displayName: TD Certification Test Results + type: OTHER + deploymentVotingRecord: + displayName: Deployment Voting Record + type: OTHER + serviceQuestionnaire: + displayName: Service Questionnaire + type: OTHER + serviceSecurityTemplate: + displayName: Service Security Template + type: OTHER + + # Service api artifacts placeHolder + # For each artifact the following properties exists: + # + # displayName - The display name of the artifact + # type - The type of the artifact + serviceApiArtifacts: + configuration: + displayName: Configuration + type: OTHER + instantiation: + displayName: Instantiation + type: OTHER + monitoring: + displayName: Monitoring + type: OTHER + reporting: + displayName: Reporting + type: OTHER + logging: + displayName: Logging + type: OTHER + testing: + displayName: Testing + type: OTHER + + # The maximum number of keys permited for additional information on service + additionalInformationMaxNumberOfKeys: 50 + + # Collect process statistics + systemMonitoring: + + # Should monitoring be enabled + enabled: false + + # In case of going through the FE server proxy the information to the BE + isProxy: false + + # What is the interval of the statistics collection + probeIntervalInSeconds: 15 + + defaultHeatArtifactTimeoutMinutes: 60 + + # Service deployment artifacts placeHolder + # For each artifact the following properties exists: + # + # acceptedTypes - File types that can be uploaded as each artifact + serviceDeploymentArtifacts: + YANG_XML: + acceptedTypes: + - xml + VNF_CATALOG: + acceptedTypes: + - xml + MODEL_INVENTORY_PROFILE: + acceptedTypes: + - xml + MODEL_QUERY_SPEC: + acceptedTypes: + - xml + UCPE_LAYER_2_CONFIGURATION: + acceptedTypes: + - xml + + #AAI Artifacts + AAI_SERVICE_MODEL: + acceptedTypes: + - xml + AAI_VF_MODULE_MODEL: + acceptedTypes: + - xml + AAI_VF_INSTANCE_MODEL: + acceptedTypes: + - xml + OTHER: + acceptedTypes: + + #PLAN + PLAN: + acceptedTypes: + - xml + + # Resource deployment artifacts placeHolder + # For each artifact the following properties exists: + # + # acceptedTypes - File types that can be uploaded as each artifact + # validForRespurceTypes - Resource types that support each artifact. + # If left empty it means all resource types are valid + resourceDeploymentArtifacts: + HEAT: + acceptedTypes: + - yaml + - yml + validForResourceTypes: *allResourceTypes + HEAT_VOL: + acceptedTypes: + - yaml + - yml + validForResourceTypes: *allResourceTypes + HEAT_NET: + acceptedTypes: + - yaml + - yml + validForResourceTypes: *allResourceTypes + HEAT_NESTED: + acceptedTypes: + - yaml + - yml + validForResourceTypes: *allResourceTypes + HEAT_ARTIFACT: + acceptedTypes: + validForResourceTypes: *allResourceTypes + YANG_XML: + acceptedTypes: + - xml + validForResourceTypes: *allResourceTypes + VNF_CATALOG: + acceptedTypes: + - xml + validForResourceTypes: *allResourceTypes + VF_LICENSE: + acceptedTypes: + - xml + validForResourceTypes: *allResourceTypes + VENDOR_LICENSE: + acceptedTypes: + - xml + validForResourceTypes: *allResourceTypes + MODEL_INVENTORY_PROFILE: + acceptedTypes: + - xml + validForResourceTypes: *allResourceTypes + MODEL_QUERY_SPEC: + acceptedTypes: + - xml + validForResourceTypes: *allResourceTypes + LIFECYCLE_OPERATIONS: + acceptedTypes: + - yaml + - yml + validForResourceTypes: + - VF + - VFC + VES_EVENTS: + acceptedTypes: + - yaml + - yml + validForResourceTypes: *allResourceTypes + PERFORMANCE_COUNTER: + acceptedTypes: + - csv + validForResourceTypes: *allResourceTypes + APPC_CONFIG: + acceptedTypes: + validForResourceTypes: + - VF + DCAE_TOSCA: + acceptedTypes: + - yml + - yaml + validForResourceTypes: + - VF + - VFCMT + DCAE_JSON: + acceptedTypes: + - json + validForResourceTypes: + - VF + - VFCMT + DCAE_POLICY: + acceptedTypes: + - emf + validForResourceTypes: + - VF + - VFCMT + DCAE_DOC: + acceptedTypes: + validForResourceTypes: + - VF + - VFCMT + DCAE_EVENT: + acceptedTypes: + validForResourceTypes: + - VF + - VFCMT + AAI_VF_MODEL: + acceptedTypes: + - xml + validForResourceTypes: + - VF + AAI_VF_MODULE_MODEL: + acceptedTypes: + - xml + validForResourceTypes: + - VF + OTHER: + acceptedTypes: + validForResourceTypes: *allResourceTypes + SNMP_POLL: + acceptedTypes: + validForResourceTypes: *allResourceTypes + SNMP_TRAP: + acceptedTypes: + validForResourceTypes: *allResourceTypes + + #PLAN + PLAN: + acceptedTypes: + - xml + validForResourceTypes: + - VF + - VFC + + # Resource instance deployment artifacts placeHolder + # For each artifact the following properties exists: + # + # acceptedTypes - File types that can be uploaded as each artifact + # validForRespurceTypes - Resource types that support each artifact. + # If left empty it means all resource types are valid + resourceInstanceDeploymentArtifacts: + HEAT_ENV: + acceptedTypes: + - env + VF_MODULES_METADATA: + acceptedTypes: + - json + VES_EVENTS: + acceptedTypes: + - yaml + - yml + PERFORMANCE_COUNTER: + acceptedTypes: + - csv + DCAE_INVENTORY_TOSCA: + acceptedTypes: + - yml + - yaml + DCAE_INVENTORY_JSON: + acceptedTypes: + - json + DCAE_INVENTORY_POLICY: + acceptedTypes: + - emf + DCAE_INVENTORY_DOC: + acceptedTypes: + DCAE_INVENTORY_BLUEPRINT: + acceptedTypes: + DCAE_INVENTORY_EVENT: + acceptedTypes: + SNMP_POLL: + acceptedTypes: + validForResourceTypes: *allResourceTypes + SNMP_TRAP: + acceptedTypes: + validForResourceTypes: *allResourceTypes + + #PLAN + PLAN: + acceptedTypes: + - xml + + # Resource informational artifacts placeHolder + # For each artifact the following properties exists: + # + # acceptedTypes - File types that can be uploaded as each artifact + # validForRespurceTypes - Resource types that support each artifact. + # If left empty it means all resource types are valid + resourceInformationalArtifacts: + CHEF: + acceptedTypes: + validForResourceTypes: *allResourceTypes + PUPPET: + acceptedTypes: + validForResourceTypes: *allResourceTypes + SHELL: + acceptedTypes: + validForResourceTypes: *allResourceTypes + YANG: + acceptedTypes: + validForResourceTypes: *allResourceTypes + YANG_XML: + acceptedTypes: + validForResourceTypes: *allResourceTypes + HEAT: + acceptedTypes: + validForResourceTypes: *allResourceTypes + BPEL: + acceptedTypes: + validForResourceTypes: *allResourceTypes + DG_XML: + acceptedTypes: + validForResourceTypes: *allResourceTypes + MURANO_PKG: + acceptedTypes: + validForResourceTypes: *allResourceTypes + OTHER: + acceptedTypes: + validForResourceTypes: + - VFC + - CVFC + - CP + - VL + - VF + - VFCMT + - Abstract + - PNF + SNMP_POLL: + acceptedTypes: + validForResourceTypes: *allResourceTypes + SNMP_TRAP: + acceptedTypes: + validForResourceTypes: *allResourceTypes + GUIDE: + acceptedTypes: + validForResourceTypes: + - VF + - VFC + - CVFC + + # Resource informational deployment artifact placeholder + resourceInformationalDeployedArtifacts: + + # Requirements needed to be fulfilled before certificattion + requirementsToFulfillBeforeCert: + + # Capabillities needed to be fulfilled before certificattion + capabilitiesToConsumeBeforeCert: + + # Urls that should not be logged + unLoggedUrls: + - /sdc2/rest/healthCheck + + # When component is being set as deleted those are the clean configurations + cleanComponentsConfiguration: + + # The interval to check for deleted components to clean + cleanIntervalInMinutes: 1440 + + # The components types to delete + componentsToClean: + - Resource + - Service + + # Deprecated. Will be removed in future releases + artifactsIndex: resources + + # Used to add header and footer to heatENV files generated by SDC + heatEnvArtifactHeader: "" + heatEnvArtifactFooter: "" + + onboarding: + + # Onboarding protocol + protocol: http + + # Onboarding backend hostname + host: <%= @host_ip %> + + # Onboarding backend http port + port: <%= @catalog_port %> + + # The url that being used when downloading CSARs + downloadCsarUri: "/onboarding-api/v1.0/vendor-software-products/packages" + + # Url for onboarding health check + healthCheckUri: "/onboarding-api/v1.0/healthcheck" + + + #GSS IDNS + # Switchover configuration is used for geo redundency to provide automatic failovers + switchoverDetector: + gBeFqdn: + gFeFqdn: + beVip: 1.2.3.4 + feVip: 1.2.3.4 + beResolveAttempts: 3 + feResolveAttempts: 3 + enabled: false + interval: 60 + changePriorityUser: ecompasdc + changePriorityPassword: ecompasdc123 + publishNetworkUrl: + publishNetworkBody: '{"note":"comment"}' + groups: + beSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["","","failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'} + feSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["",""],"failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'} + + # Cache for datatypes. Improving run times for data type search + applicationL1Cache: + datatypes: + enabled: true + firstRunDelay: 10 + pollIntervalInSec: 60 + + # Deprecated. Will be removed in future releases + applicationL2Cache: + enabled: false + catalogL1Cache: + enabled: false + resourcesSizeInCache: 300 + servicesSizeInCache: 200 + productsSizeInCache: 100 + queue: + syncIntervalInSecondes: 43200 + waitOnShutDownInMinutes: 10 + numberOfCacheWorkers: 4 + + # Validators for tosca properties + toscaValidators: + stringMaxLength: 2500 + + # Should audit be disabled + disableAudit: false + + # VF module validations properties + vfModuleProperties: + min_vf_module_instances: + forBaseModule: 1 + forNonBaseModule: 0 + max_vf_module_instances: + forBaseModule: 1 + forNonBaseModule: + initial_count: + forBaseModule: 1 + forNonBaseModule: 0 + vf_module_type: + forBaseModule: Base + forNonBaseModule: Expansion + + # For each generic node type defining it's coresponding class + genericAssetNodeTypes: + VFC: org.openecomp.resource.abstract.nodes.VFC + CVFC: org.openecomp.resource.abstract.nodes.VFC + VF : org.openecomp.resource.abstract.nodes.VF + PNF: org.openecomp.resource.abstract.nodes.PNF + Service: org.openecomp.resource.abstract.nodes.service + + +BE-distribution-engine-configuration.yaml +----------------------------------------- + +:: + + # UEB servers list + uebServers: + <% node['UEB']['fqdn'].each do |conn| -%> + - <%= conn %> + <% end -%> + + # UEB public key + uebPublicKey: <%= node['UEB']['PublicKey'] %> + + # UEB secret key + uebSecretKey: <%= node['UEB']['SecretKey'] %> + + # Topic name for receiving distribution notification + distributionNotifTopicName: SDC-DISTR-NOTIF-TOPIC + + # Topic name for distribution status + distributionStatusTopicName: SDC-DISTR-STATUS-TOPIC + + # Distibution initializtion retry interval time + initRetryIntervalSec: 5 + + # Distribution initializtion maximum interval time + initMaxIntervalSec: 60 + + # Deprecated. Will be removed in future releases + distribNotifServiceArtifactTypes: + info: + - MURANO-PKG + + # Deprecated. Will be removed in future releases + distribNotifResourceArtifactTypes: + lifecycle: + - HEAT + - DG-XML + + # Distribution environments + environments: + - <%= node.chef_environment %> + + distributionStatusTopic: + + # Distribution status polling interval + pollingIntervalSec: 60 + + # Distribution status fetch time + fetchTimeSec: 15 + + # Distribution status consumer group + consumerGroup: sdc-<%= node.chef_environment %> + + # Distribution status consumer id + consumerId: sdc-<%= node.chef_environment %>1 + + distributionNotificationTopic: + + # Minimum pool size for distribution notifications + minThreadPoolSize: 0 + + # Maximum pool size for distribution notifications + maxThreadPoolSize: 10 + + # Maximum waiting time after sending a notification + maxWaitingAfterSendingSeconds: 5 + + # Deprecated. Will be removed in future releases + createTopic: + partitionCount: 1 + replicationCount: 1 + + # STarting the distribution engine + startDistributionEngine: true + + #This is false by default, since ONAP Dmaap currently doesn't support https + # Does https should be used with Dmaap + useHttpsWithDmaap: false + + +BE-onboarding-configuration.yaml +-------------------------------- + +:: + + notifications: + + # Backend onboarding notifications polling interval in milliseconds + pollingIntervalMsec: 2000 + + # Backend onboarding notifications selection size + selectionSize: 100 + + # Backend onboarding norifications backend hostname + beHost: <%= @catalog_ip %> + + # Backend onboarding notifications backend http port + beHttpPort: <%= @catalog_port %> + + +BE-titan.properties +------------------- + +:: + + # Titan storage backend + storage.backend=cassandra + + # Titan storage hostname + storage.hostname=<%= @CASSANDRA_IP %> + + # Titan storage port] + storage.port=9160 + + # Titan storage username + storage.username=<%= @CASSANDRA_USR %> + + # Titan storage password + storage.password=<%= @CASSANDRA_PWD %> + + # Titan storage connection timeout + storage.connection-timeout=10000 + + # Titan cassandra keyspace name + storage.cassandra.keyspace=sdctitan + + # Is Titan cassandra ssl is enabled + storage.cassandra.ssl.enabled=false + + # Titan 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 + + # Does titan should use cache + cache.db-cache = false + + # How long in milliseconds should the cache keep entries before flushing them + cache.db-cache-clean-wait = 20 + + # Default experation time in milliseconds for entries in the cache + cache.db-cache-time = 180000 + + # Size of titan database cache + cache.db-cache-size = 0.5 + + # Titan cassandra read consistency level + storage.cassandra.read-consistency-level=LOCAL_QUORUM + + # Titan cassandra write consistency level + storage.cassandra.write-consistency-level=LOCAL_QUORUM + + # Titan cassandra replication strategy class name + storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy + + # Titan cassandra replication startegy options + storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %> + + # Titan 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 + storage.lock.retries=5 + + # Number of milliseconds the system waits for a lock application to be acknowledged by the storage backend + storage.lock.wait-time=500 + - * Configuration is typically: provided for platform-component and sdk projects; - and referenced in developer and user guides. - - * This note must be removed after content has been added. +Frontend Configuration +====================== +FE-configuration.yaml +--------------------- +:: -Example ... + # Catalog frontend hostname + feFqdn: <%= @fe_host_ip %> + + # Catalog backend hostname + beHost: <%= @be_host_ip %> + + # Catalog backend http port + beHttpPort: <%= @catalog_port %> + + # Catalog backend http context + beContext: /sdc2/rest/v1/catalog/upload/resources + + # Catalog backend protocol + beProtocol: http + + # Catalog backend ssl port + beSslPort: <%= @ssl_port %> + + # Threadpool size for handling requests + threadpoolSize: 50 + + # Request processing timeout (seconds) + requestTimeout: 10 + + # Health check timeout in milliseconds + healthCheckSocketTimeoutInMs: 5000 + + # Health check inteval in seconds + healthCheckIntervalInSeconds: 5 + + onboarding: + + # Onboarding protocol + protocol: http + + # Onboarding frontend hostname + host: <%= @fe_host_ip %> + + # Onboarding frontend port + port: 8181 + + # Onboarding frontend health check url + healthCheckUri: "/onboarding/v1.0/healthcheck" + + # Request headers for identification of the user that made the request + identificationHeaderFields: + - + - &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 + - + - &HTTP_CSP_WSTYPE HTTP_CSP_WSTYPE + - &csp-wstype csp-wstype + + # Optional request headers + optionalHeaderFields: + - + - &HTTP_CSP_FIRSTNAME HTTP_CSP_FIRSTNAME + - &csp-firstname csp-firstname + - + - &HTTP_CSP_LASTNAME HTTP_CSP_LASTNAME + - &csp-lastname csp-lastname + - + - &HTTP_IV_REMOTE_ADDRESS HTTP_IV_REMOTE_ADDRESS + - &iv-remote-address iv-remote-address + - + - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL + - &csp-email csp-email + + # Frontend configuration version + version: 1.0 + + # Frontend configuration release date + released: 2012-11-30 + + # Connection parameters + connection: + url: jdbc:mysql://localhost:3306/db + poolSize: 17 + + # Protocols being used in SDC + protocols: + - http + - https + + # Collect process statistics + systemMonitoring: + + # Should monitoring be enabled + enabled: false + + # In case of going through the FE server proxy the information to the BE + isProxy: true + + # What is the interval of the statistics collection + probeIntervalInSeconds: 15 + + # Kibana hostname + kibanaHost: localhost + + # Kibana http port + kibanaPort: 5601 + + # Kibana usage protocol + kibanaProtocol: http -You can provide the following in ``basic.conf`` -``host=ADDRESS`` - The address of the host +FE-onboarding-configuration.yaml +-------------------------------- -``port=PORT`` - The port used for signaling +:: - Optional. Default: ``8080`` + notifications: + + # Frontend onboarding notifications polling interval in milliseconds + pollingIntervalMsec: 2000 + + # Frontend onboarding notifications selection size + selectionSize: 100 + + # Frontend onboarding norifications backend hostname + beHost: <%= @catalog_ip %> + + # Frontend onboarding notifications backend http port + beHttpPort: <%= @catalog_port %> diff --git a/docs/consumedapis.rst b/docs/consumedapis.rst index 099442d3a4..2379d75f70 100644 --- a/docs/consumedapis.rst +++ b/docs/consumedapis.rst @@ -1,7 +1,8 @@ .. This work is licensed under a Creative Commons Attribution 4.0 International License. .. http://creativecommons.org/licenses/by/4.0 +============= Consumed APIs ============= -SDC Project does not consume any APIs form other sources therfore this section is currently empty +SDC Project does not consume any APIs from other sources therefore this section is currently empty diff --git a/docs/logging.rst b/docs/logging.rst index a6cca5b707..9e82e15f84 100644 --- a/docs/logging.rst +++ b/docs/logging.rst @@ -5,16 +5,6 @@ Logging ======= -.. note:: - * This section is used to describe the informational or diagnostic messages emitted from - a software component and the methods or collecting them. - - * This section is typically: provided for a platform-component and sdk; and - referenced in developer and user guides - - * This note must be removed after content has been added. - - Where to Access Information --------------------------- diff --git a/docs/offeredapis.rst b/docs/offeredapis.rst index 349e7bad4f..e9decd1e5c 100644 --- a/docs/offeredapis.rst +++ b/docs/offeredapis.rst @@ -17,7 +17,7 @@ Overview Version information ------------------- -*Version* : 1.0.0 +*Version* : 1.1.0 URI scheme ---------- |