1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
9 * This section is used to describe the options a software component offers for configuration.
11 * Configuration is typically: provided for platform-component and sdk projects;
12 and referenced in developer and user guides.
14 * This note must be removed after content has been added.
20 You can provide the following in ``basic.conf``
23 The address of the host
26 The port used for signaling
28 Optional. Default: ``8080``
41 "description": "OpenSource-xxx",
42 "cookbook_versions": {
43 "Deploy-SDandC": "= 1.0.0"
45 "json_class": "Chef::Environment",
46 "chef_type": "environment",
47 "default_attributes": {
53 "application": "eth0",
57 "ecomp_rest_url": "http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/auxapi",
58 "ueb_url_list": "10.0.11.1,10.0.11.1",
59 "app_secret": "XftIATw9Jr3VzAcPqt3NnJOu",
60 "app_key": "x9UfO7JsDn8BESVX",
61 "inbox_name": "ECOMP-PORTAL-INBOX",
62 "ecomp_redirect_url": "http://portal.api.simpledemo.openecomp.org:8989/ECOMPPORTAL/login.htm",
63 "app_topic_name": "ECOMP-PORTAL-OUTBOX-SDC1",
64 "decryption_key": "AGLDdG4D04BKm2IxIWEr8o=="
67 "PublicKey": "iPIxkpAMI8qTcQj8",
68 "SecretKey": "Ehq3WyT4bkif4zwgEbvshGal",
69 "fqdn": ["10.0.11.1", "10.0.11.1"]
78 "override_attributes": {
88 "cluster_name": "SDC-ES-",
89 "ES_path_home": "/usr/share/elasticsearch",
90 "ES_path_data": "/usr/share/elasticsearch/data",
91 "num_of_replicas": "0",
95 "concurrent_reads": "32",
97 "data_dir": "/var/lib/cassandra/data",
98 "hinted_handoff_enabled": "true",
99 "cassandra_user": "asdc_user",
100 "cassandra_password": "Aa1234%^!",
101 "concurrent_writes": "32",
102 "cluster_name": "SDC-CS-",
103 "multithreaded_compaction": "false",
104 "cache_dir": "/var/lib/cassandra/saved_caches",
105 "log_file": "/var/lib/cassandra/log/system.log",
106 "phi_convict_threshold": "8",
107 "commitlog_dir": "/var/lib/cassandra/commitlog"
112 Backend Configurations
113 ======================
115 BE-configoration.yaml
116 ---------------------
120 identificationHeaderFields:
124 - HTTP_IV_REMOTE_ADDRESS
127 # catalog backend hostname
128 beFqdn: <%= @host_ip %>
130 # catalog backend http port
131 beHttpPort: <%= @catalog_port %>
133 # catalog backend http context
134 beContext: /sdc/rest/config/get
136 # catalog backend protocol
139 # catalog backend ssl port
140 beSslPort: <%= @ssl_port %>
143 toscaConformanceLevel: 4.0
144 minToscaConformanceLevel: 3.0
146 titanCfgFile: /var/lib/jetty/config/catalog-be/titan.properties
147 titanInMemoryGraph: false
148 titanLockTimeout: 1800
149 # The interval to try and reconnect to titan DB when it is down during ASDC startup:
150 titanReconnectIntervalInSeconds: 3
152 # The read timeout towards Titan DB when health check is invoked:
153 titanHealthCheckReadTimeout: 1
155 # The interval to try and reconnect to Elasticsearch when it is down during ASDC startup:
156 esReconnectIntervalInSeconds: 3
157 uebHealthCheckReconnectIntervalInSeconds: 15
158 uebHealthCheckReadTimeout: 4
172 file: capabilities.yml
174 file: relationships.yml
186 cassandraHosts: <%= @cassandra_ip %>
187 localDataCenter: <%= @DC_NAME %>
188 reconnectTimeout : 30000
191 password: {{cassandra_password}}
193 truststorePath : /config/.truststore
194 truststorePassword : Aa123456
196 - { name: dox, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
197 - { name: sdcaudit, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
198 - { name: sdcartifact, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
199 - { name: sdccomponent, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
200 - { name: sdcrepository, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
202 #Application-specific settings of ES
204 # Mapping of index prefix to time-based frame. For example, if below is configured:
206 # - indexPrefix: auditingevents
207 # creationPeriod: minute
209 # 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.
210 # Another object created on 2015-12-23 13:25:54, will enter "auditingevents-2015-12-23-13-25" index.
211 # If creationPeriod: month, both of the above will enter "auditingevents-2015-12" index.
213 # PLEASE NOTE: the timestamps are created in UTC/GMT timezone! This is needed so that timestamps will be correctly presented in Kibana.
215 # Legal values for creationPeriod - year, month, day, hour, minute, none (meaning no time-based behaviour).
217 # If no creationPeriod is configured for indexPrefix, default behavour is creationPeriod: month.
219 indicesTimeFrequency:
220 - indexPrefix: auditingevents
221 creationPeriod: month
222 - indexPrefix: monitoring_events
223 creationPeriod: month
241 - AAI_VF_MODULE_MODEL
242 - AAI_VF_INSTANCE_MODEL
254 #Deployment artifacts placeHolder
255 resourceTypes: &allResourceTypes
264 # validForResourceTypes usage
265 # validForResourceTypes:
269 deploymentResourceArtifacts:
271 deploymentResourceInstanceArtifacts:
273 displayName: "HEAT ENV"
275 description: "Auto-generated HEAT Environment deployment artifact"
278 displayName: "VF HEAT ENV"
280 description: "VF Auto-generated HEAT Environment deployment artifact"
283 #tosca artifacts placeholders
286 artifactName: -template.yml
287 displayName: Tosca Template
289 description: TOSCA representation of the asset
291 artifactName: -csar.csar
292 displayName: Tosca Model
294 description: TOSCA definition package of the asset
296 #Informational artifacts placeHolder
297 excludeResourceCategory:
301 informationalResourceArtifacts:
303 displayName: Features
306 displayName: Capacity
309 displayName: Vendor Test Result
312 displayName: Test Scripts
315 displayName: Cloud Questionnaire (completed)
317 HEATTemplateFromVendor:
318 displayName: HEAT Template from Vendor
320 resourceSecurityTemplate:
321 displayName: Resource Security Template
324 excludeServiceCategory:
326 informationalServiceArtifacts:
328 displayName: Service Artifact Plan
330 summaryOfImpactsToECOMPElements:
331 displayName: Summary of impacts to ECOMP elements,OSSs, BSSs
333 controlLoopFunctions:
334 displayName: Control Loop Functions
337 displayName: Dimensioning Info
340 displayName: Affinity Rules
343 displayName: Operational Policies
345 serviceSpecificPolicies:
346 displayName: Service-specific Policies
349 displayName: Engineering Rules (ERD)
351 distributionInstructions:
352 displayName: Distribution Instructions
354 certificationTestResults:
355 displayName: TD Certification Test Results
357 deploymentVotingRecord:
358 displayName: Deployment Voting Record
360 serviceQuestionnaire:
361 displayName: Service Questionnaire
363 serviceSecurityTemplate:
364 displayName: Service Security Template
369 displayName: Configuration
372 displayName: Instantiation
375 displayName: Monitoring
378 displayName: Reporting
387 additionalInformationMaxNumberOfKeys: 50
392 probeIntervalInSeconds: 15
393 defaultHeatArtifactTimeoutMinutes: 60
395 serviceDeploymentArtifacts:
402 MODEL_INVENTORY_PROFILE:
408 UCPE_LAYER_2_CONFIGURATION:
419 AAI_VF_INSTANCE_MODEL:
430 resourceDeploymentArtifacts:
435 validForResourceTypes: *allResourceTypes
440 validForResourceTypes: *allResourceTypes
445 validForResourceTypes: *allResourceTypes
450 validForResourceTypes: *allResourceTypes
453 validForResourceTypes: *allResourceTypes
457 validForResourceTypes: *allResourceTypes
461 validForResourceTypes: *allResourceTypes
465 validForResourceTypes: *allResourceTypes
469 validForResourceTypes: *allResourceTypes
470 MODEL_INVENTORY_PROFILE:
473 validForResourceTypes: *allResourceTypes
477 validForResourceTypes: *allResourceTypes
478 LIFECYCLE_OPERATIONS:
482 validForResourceTypes:
489 validForResourceTypes: *allResourceTypes
493 validForResourceTypes: *allResourceTypes
496 validForResourceTypes:
502 validForResourceTypes:
508 validForResourceTypes:
514 validForResourceTypes:
519 validForResourceTypes:
524 validForResourceTypes:
530 validForResourceTypes:
535 validForResourceTypes:
539 validForResourceTypes: *allResourceTypes
542 validForResourceTypes: *allResourceTypes
545 validForResourceTypes: *allResourceTypes
551 validForResourceTypes:
555 resourceInstanceDeploymentArtifacts:
569 DCAE_INVENTORY_TOSCA:
576 DCAE_INVENTORY_POLICY:
581 DCAE_INVENTORY_BLUEPRINT:
583 DCAE_INVENTORY_EVENT:
587 validForResourceTypes: *allResourceTypes
590 validForResourceTypes: *allResourceTypes
597 resourceInformationalArtifacts:
600 validForResourceTypes: *allResourceTypes
603 validForResourceTypes: *allResourceTypes
606 validForResourceTypes: *allResourceTypes
609 validForResourceTypes: *allResourceTypes
612 validForResourceTypes: *allResourceTypes
615 validForResourceTypes: *allResourceTypes
618 validForResourceTypes: *allResourceTypes
621 validForResourceTypes: *allResourceTypes
624 validForResourceTypes: *allResourceTypes
627 validForResourceTypes:
638 validForResourceTypes: *allResourceTypes
641 validForResourceTypes: *allResourceTypes
644 validForResourceTypes:
649 resourceInformationalDeployedArtifacts:
651 requirementsToFulfillBeforeCert:
653 capabilitiesToConsumeBeforeCert:
656 - /sdc2/rest/healthCheck
658 cleanComponentsConfiguration:
659 cleanIntervalInMinutes: 1440
664 artifactsIndex: resources
666 heatEnvArtifactHeader: ""
667 heatEnvArtifactFooter: ""
671 host: <%= @host_ip %>
672 port: <%= @catalog_port %>
673 downloadCsarUri: "/onboarding-api/v1.0/vendor-software-products/packages"
674 healthCheckUri: "/onboarding-api/v1.0/healthcheck"
687 changePriorityUser: ecompasdc
688 changePriorityPassword: ecompasdc123
690 publishNetworkBody: '{"note":"comment"}'
692 beSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["","","failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
693 feSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["",""],"failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
699 pollIntervalInSec: 60
705 resourcesSizeInCache: 300
706 servicesSizeInCache: 200
707 productsSizeInCache: 100
709 syncIntervalInSecondes: 43200
710 waitOnShutDownInMinutes: 10
711 numberOfCacheWorkers: 4
714 stringMaxLength: 2500
719 min_vf_module_instances:
722 max_vf_module_instances:
730 forNonBaseModule: Expansion
732 genericAssetNodeTypes:
733 VFC: org.openecomp.resource.abstract.nodes.VFC
734 CVFC: org.openecomp.resource.abstract.nodes.VFC
735 VF : org.openecomp.resource.abstract.nodes.VF
736 PNF: org.openecomp.resource.abstract.nodes.PNF
737 Service: org.openecomp.resource.abstract.nodes.service
740 BE-distribution-engine-configuration.yaml
741 -----------------------------------------
746 <% node['UEB']['fqdn'].each do |conn| -%>
750 uebPublicKey: <%= node['UEB']['PublicKey'] %>
751 uebSecretKey: <%= node['UEB']['SecretKey'] %>
753 distributionNotifTopicName: SDC-DISTR-NOTIF-TOPIC
754 distributionStatusTopicName: SDC-DISTR-STATUS-TOPIC
756 initRetryIntervalSec: 5
757 initMaxIntervalSec: 60
759 distribNotifServiceArtifactTypes:
763 distribNotifResourceArtifactTypes:
769 - <%= node.chef_environment %>
771 distributionStatusTopic:
772 pollingIntervalSec: 60
774 consumerGroup: sdc-<%= node.chef_environment %>
775 consumerId: sdc-<%= node.chef_environment %>1
778 distributionNotificationTopic:
780 maxThreadPoolSize: 10
781 maxWaitingAfterSendingSeconds: 5
787 startDistributionEngine: true
789 #This is false by default, since ONAP Dmaap currently doesn't support https
790 useHttpsWithDmaap: false
793 BE-onboarding-configuration.yaml
794 --------------------------------
799 pollingIntervalMsec: 2000
801 beHost: <%= @catalog_ip %>
802 beHttpPort: <%= @catalog_port %>
810 storage.backend=cassandra
811 storage.hostname=<%= @CASSANDRA_IP %>
813 storage.username=<%= @CASSANDRA_USR %>
814 storage.password=<%= @CASSANDRA_PWD %>
815 storage.connection-timeout=10000
816 storage.cassandra.keyspace=sdctitan
818 storage.cassandra.ssl.enabled=false
819 storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
820 storage.cassandra.ssl.truststore.password=Aa123456
822 cache.db-cache = false
823 cache.db-cache-clean-wait = 20
824 cache.db-cache-time = 180000
825 cache.db-cache-size = 0.5
827 storage.cassandra.read-consistency-level=LOCAL_QUORUM
828 storage.cassandra.write-consistency-level=LOCAL_QUORUM
829 storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy
830 storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %>
831 storage.cassandra.astyanax.local-datacenter=<%= @DC_NAME %>
833 storage.lock.retries=5
834 storage.lock.wait-time=500
837 Frontend Configuration
838 ======================
840 FE-configuration.yaml
841 ---------------------
845 # Needed for logging purposes. To be populated by DevOps - currently dummy
846 feFqdn: <%= @fe_host_ip %>
848 # catalog backend hostname
849 beHost: <%= @be_host_ip %>
851 # catalog backend http port
852 beHttpPort: <%= @catalog_port %>
854 # catalog backend http context
855 beContext: /sdc2/rest/v1/catalog/upload/resources
857 # catalog backend protocol
860 # catalog backend ssl port
861 beSslPort: <%= @ssl_port %>
863 # threadpool size for handling requests
866 # request processing timeout (seconds)
869 healthCheckSocketTimeoutInMs: 5000
871 healthCheckIntervalInSeconds: 5
875 host: <%= @fe_host_ip %>
877 healthCheckUri: "/onboarding/v1.0/healthcheck"
879 identificationHeaderFields:
881 - &HTTP_IV_USER HTTP_IV_USER
887 - &HTTP_CSP_ATTUID HTTP_CSP_ATTUID
888 - &csp-attuid csp-attuid
890 - &HTTP_CSP_WSTYPE HTTP_CSP_WSTYPE
891 - &csp-wstype csp-wstype
893 optionalHeaderFields:
895 - &HTTP_CSP_FIRSTNAME HTTP_CSP_FIRSTNAME
896 - &csp-firstname csp-firstname
898 - &HTTP_CSP_LASTNAME HTTP_CSP_LASTNAME
899 - &csp-lastname csp-lastname
901 - &HTTP_IV_REMOTE_ADDRESS HTTP_IV_REMOTE_ADDRESS
902 - &iv-remote-address iv-remote-address
904 - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL
905 - &csp-email csp-email
910 # Connection parameters
912 url: jdbc:mysql://localhost:3306/db
924 probeIntervalInSeconds: 15
926 kibanaHost: localhost
931 FE-onboarding-configuration.yaml
932 --------------------------------
937 pollingIntervalMsec: 2000
939 beHost: <%= @catalog_ip %>
940 beHttpPort: <%= @catalog_port %>