3ce4a5fdf2de99bc95bb8813c6121f1d77e8c0bf
[sdc.git] / docs / configuration.rst
1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
3
4 =============
5 Configuration
6 =============
7
8 .. contents::
9    :depth: 3
10 ..
11
12 Global Configuration
13 ====================
14
15 environment.json
16 ----------------
17
18 ::
19
20     {
21         # Environment name
22         "name": "xxx",
23         
24         # Environment description
25         "description": "OpenSource-xxx",
26         "json_class": "Chef::Environment",
27         "chef_type": "environment",
28
29         "default_attributes": {
30             "disableHttp": false,
31             # IPs used for docker configuration
32             "CS_VIP": "yyy",
33             "BE_VIP": "yyy",
34             "ONBOARDING_BE_VIP": "yyy",
35             "FE_VIP": "yyy",
36             "ES_VIP": "yyy",
37             "KB_VIP": "yyy",
38             "DCAE_BE_VIP": "yyy",
39             "DCAE_FE_VIP": "yyy",
40             "interfaces": {
41                 "application": "eth0",
42                 "private": "eth1"
43             },
44
45             # Configuration parameters used in portal properties
46             "ECompP": {
47                 "ecomp_rest_url": "http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/auxapi",
48                 "ecomp_redirect_url": "http://portal.api.simpledemo.openecomp.org:8989/ECOMPPORTAL/login.htm",
49                 "cipher_key": "AGLDdG4D04BKm2IxIWEr8o==",
50                 "portal_user": "Ipwxi2oLvDxctMA1royaRw1W0jhucLx+grHzci3ePIA=",
51                 "portal_pass": "j85yNhyIs7zKYbR1VlwEfNhS6b7Om4l0Gx5O8931sCI="
52             },
53
54             # Configuration parameters used by SDC to work with Dmaap
55             "UEB": {
56                 "PublicKey": "iPIxkpAMI8qTcQj8",
57                 "SecretKey": "Ehq3WyT4bkif4zwgEbvshGal",
58                 "fqdn": ["10.0.11.1", "10.0.11.1"]
59             },
60
61             # IPs used for docker configuration
62             "Nodes": {
63                 "CS": ["yyy"],
64                 "BE": "yyy",
65                 "ONBOARDING_BE": "yyy",
66                 "FE": "yyy",
67                 "ES": ["yyy"],
68                 "KB":  "yyy"
69             },
70             "Plugins": {
71                "DCAE": {
72                   "dcae_discovery_url": "yyy",
73                   "dcae_source_url": "yyy"
74                },
75                "WORKFLOW": {
76                   "workflow_discovery_url": "yyy",
77                   "workflow_source_url": "yyy"
78                }
79             },
80             "VnfRepo": {
81                 "vnfRepoPort": "8702",
82                 "vnfRepoHost": "10.0.14.1"
83             }
84         },
85         "override_attributes": {
86
87             # FE and BE listening ports
88             "FE": {
89                 "http_port": "8181",
90                 "https_port": "9443"
91             },
92             "BE": {
93                 "http_port": "8080",
94                 "https_port": "8443"
95             },
96             "ONBOARDING_BE": {
97                "http_port": "8081",
98                "https_port": "8445"
99             },
100
101             # Elasticsearch configuration
102             "elasticsearch": {
103                 "cluster_name": "SDC-ES-",
104                 "ES_path_home": "/usr/share/elasticsearch",
105                 "ES_path_data": "/usr/share/elasticsearch/data",
106                 "num_of_replicas": "0",
107                 "num_of_shards": "1"
108             },
109
110             # Cassandra configuration
111             "cassandra": {
112                 "concurrent_reads": "32",
113                 "num_tokens": "256",
114                 "data_dir": "/var/lib/cassandra/data",
115                 "hinted_handoff_enabled": "true",
116                 "cassandra_user": "asdc_user",
117                 "cassandra_password": "Aa1234%^!",
118                 "concurrent_writes": "32",
119                 "cluster_name": "SDC-CS-",
120                 "datacenter_name": "SDC-CS-",
121                 "multithreaded_compaction": "false",
122                 "cache_dir": "/var/lib/cassandra/saved_caches",
123                 "log_file": "/var/lib/cassandra/log/system.log",
124                 "phi_convict_threshold": "8",
125                 "commitlog_dir": "/var/lib/cassandra/commitlog",
126                 "socket_read_timeout": "20000",
127                 "socket_connect_timeout": "20000",
128                 "janusgraph_connection_timeout": "10000"
129             }
130         }
131     }
132
133
134
135 Backend Configurations
136 ======================
137
138 Catalog Configurations
139 ----------------------
140
141 BE-configuration.yaml
142 **********************
143
144
145
146 ::
147
148     # Request headers for identification of the user that made the request
149     identificationHeaderFields:
150     - HTTP_IV_USER
151     - HTTP_CSP_FIRSTNAME
152     - HTTP_CSP_LASTNAME
153     - HTTP_IV_REMOTE_ADDRESS
154     - HTTP_CSP_WSTYPE
155
156     # Catalog backend hostname
157     beFqdn: <%= @catalog_ip %>
158
159     # Catalog backend http port
160     beHttpPort: <%= @catalog_port %>
161
162     # Catalog backend http context
163     beContext: /sdc/rest/config/get
164
165     # Catalog backend protocol
166     beProtocol: http
167
168     # Catalog backend ssl port
169     beSslPort: <%= @ssl_port %>
170
171     # Catalog backend configuration version
172     version: 1.1.0
173
174     # Catalog backend configuration release date
175     released: 2012-11-30
176
177     # Catalog tosca current conformance version
178     toscaConformanceLevel: 5.0
179
180     # Catalog minimum tosca conformance version
181     minToscaConformanceLevel: 3.0
182
183     # JanusGraph configuration file location
184     janusGraphCfgFile: /var/lib/jetty/config/catalog-be/janusgraph.properties
185
186     # Does JanusGraph hold the persistence data in memory
187     janusGraphInMemoryGraph: false
188
189     # The timeout for JanusGraph to lock on an object in a transaction
190     janusGraphLockTimeout: 1800
191
192     # The interval to try and reconnect to JanusGraph DB when it is down during SDC startup
193     janusGraphReconnectIntervalInSeconds: 3
194
195     # The read timeout towards JanusGraph DB when health check is invoked
196     janusGraphHealthCheckReadTimeout: 1
197
198     # The interval to try and reconnect to Elasticsearch when it is down during SDC startup
199     esReconnectIntervalInSeconds: 3
200
201     # The interval to try and reconnect to UEB health check when it is down during SDC startup
202     uebHealthCheckReconnectIntervalInSeconds: 15
203
204     # The read timeout towards UEB when health check is invoked
205     uebHealthCheckReadTimeout: 4
206
207     # Protocols being used in SDC
208     protocols:
209         - http
210         - https
211
212     # Default imports
213     # Under each import there is the file the data will be imported from
214     defaultImports:
215         - nodes:
216             file: nodes.yml
217         - datatypes:
218             file: data.yml
219         - capabilities:
220             file: capabilities.yml
221         - relationships:
222             file: relationships.yml
223         - groups:
224             file: groups.yml
225         - policies:
226             file: policies.yml
227         - annotations:
228             file: annotations.yml
229
230     # Users
231     # Deprecated. Will be removed in future releases
232     users:
233         tom: passwd
234         bob: passwd
235
236     cassandraConfig:
237         # Cassandra hostname
238         cassandraHosts: <%= @cassandra_ip %>
239
240         # Cassandra local data center name
241         localDataCenter: <%= @DC_NAME %>
242
243         # The read timeout towards Cassandra when health check is invoked
244         reconnectTimeout : 30000
245         # The amount of time the Cassandra client will wait for a socket
246         socketReadTimeout: <%= @socket_read_timeout %>
247         # The amount of time the Cassandra client will wait for a response
248         socketConnectTimeout: <%= @socket_connect_timeout %>
249
250         # Should authentication be used when accessing Cassandra
251         authenticate: true
252
253         # Username for accessing Cassandra
254         username: asdc_user
255
256         # Password for accessing Cassandra
257         password: {{cassandra_password}}
258
259         # Should ssl be used
260         ssl: false
261
262         # Location of .truststore file
263         truststorePath : /config/.truststore
264
265         # The .truststore file password
266         truststorePassword : Aa123456
267
268         # Keyspaces configuration for Cassandra
269         keySpaces:
270             - { name: dox, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
271             - { name: sdcaudit, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
272             - { name: sdcartifact, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
273             - { name: sdccomponent, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
274             - { name: sdcrepository, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
275
276     # Application-specific settings of ES
277     elasticSearch:
278
279         # Mapping of index prefix to time-based frame. For example, if below is configured:
280         #
281         # - indexPrefix: auditing events
282         #    creationPeriod: minute
283         #
284         # 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.
285         # Another object created on 2015-12-23 13:25:54, will enter "auditingevents-2015-12-23-13-25" index.
286         # If creationPeriod: month, both of the above will enter "auditingevents-2015-12" index.
287         #
288         # PLEASE NOTE: the timestamps are created in UTC/GMT timezone! This is needed so that timestamps will be correctly presented in Kibana.
289         #
290         # Legal values for creationPeriod - year, month, day, hour, minute, none (meaning no time-based behaviour).
291         #
292         # If no creationPeriod is configured for indexPrefix, default behavour is creationPeriod: month.
293         indicesTimeFrequency:
294             - indexPrefix: auditingevents
295               creationPeriod: month
296             - indexPrefix: monitoring_events
297               creationPeriod: month
298
299     # Artifact types placeholder
300     artifactTypes:
301         - CHEF
302         - PUPPET
303         - SHELL
304         - YANG
305         - YANG_XML
306         - HEAT
307         - BPEL
308         - DG_XML
309         - MURANO_PKG
310         - WORKFLOW
311         - NETWORK_CALL_FLOW
312         - TOSCA_TEMPLATE
313         - TOSCA_CSAR
314         - AAI_SERVICE_MODEL
315         - AAI_VF_MODEL
316         - AAI_VF_MODULE_MODEL
317         - AAI_VF_INSTANCE_MODEL
318         - OTHER
319         - SNMP_POLL
320         - SNMP_TRAP
321         - GUIDE
322         - PLAN
323
324     # License types placeholder
325     licenseTypes:
326         - User
327         - Installation
328         - CPU
329
330     # Resource types placeholder
331     resourceTypes: &allResourceTypes
332         - VFC
333         - CP
334         - VL
335         - VF
336         - CR
337         - VFCMT
338         - Abstract
339         - CVFC
340
341     #Deployment resource artifacts placeHolder
342     deploymentResourceArtifacts:
343
344     # Deployment resource instance artifact placeholders
345     # For each artifact the following properties exist:
346     #
347     # displayName - The display name of the artifact
348     # type - The type of the artifact
349     # description - The description of the artifact
350     # fileExtension - The file extension of the artifact file for uploading
351     deploymentResourceInstanceArtifacts:
352         heatEnv:
353             displayName: "HEAT ENV"
354             type: HEAT_ENV
355             description: "Auto-generated HEAT Environment deployment artifact"
356             fileExtension: "env"
357         VfHeatEnv:
358             displayName: "VF HEAT ENV"
359             type: HEAT_ENV
360             description: "VF Auto-generated HEAT Environment deployment artifact"
361             fileExtension: "env"
362
363     # Tosca artifacts placeholders
364     # For each artifact there is a template and a csar.
365     # For each one the following properties exists:
366     #
367     # artifactName - The suffix of the artifact file
368     # displayName - The display name of the artifact
369     # type - The type of the artifact
370     # description - The description of the artifact
371     toscaArtifacts:
372         assetToscaTemplate:
373             artifactName: -template.yml
374             displayName: Tosca Template
375             type: TOSCA_TEMPLATE
376             description: TOSCA representation of the asset
377         assetToscaCsar:
378             artifactName: -csar.csar
379             displayName: Tosca Model
380             type: TOSCA_CSAR
381             description: TOSCA definition package of the asset
382
383     # Resource category to exclude
384     excludeResourceCategory:
385         - Generic
386
387     # Resource type to exclude
388     excludeResourceType:
389         - PNF
390         - CR
391     # Informational resource artifacts placeHolder
392     # For each artifact the following properties exists:
393     #
394     # displayName - The display name of the artifact
395     # type - The type of the artifact
396     informationalResourceArtifacts:
397         features:
398             displayName: Features
399             type: OTHER
400     capacity:
401         displayName: Capacity
402         type: OTHER
403     vendorTestResult:
404         displayName: Vendor Test Result
405         type: OTHER
406     testScripts:
407         displayName: Test Scripts
408         type: OTHER
409     CloudQuestionnaire:
410         displayName: Cloud Questionnaire (completed)
411         type: OTHER
412     HEATTemplateFromVendor:
413         displayName: HEAT Template from Vendor
414         type: HEAT
415     resourceSecurityTemplate:
416         displayName: Resource Security Template
417         type: OTHER
418
419     # Service category to exclude
420     excludeServiceCategory:
421
422     # Informational service artifacts placeHolder
423     # For each artifact the following properties exists:
424     #
425     # displayName - The display name of the artifact
426     # type - The type of the artifact
427     informationalServiceArtifacts:
428         serviceArtifactPlan:
429             displayName: Service Artifact Plan
430             type: OTHER
431         summaryOfImpactsToECOMPElements:
432             displayName: Summary of impacts to ECOMP elements,OSSs, BSSs
433             type: OTHER
434         controlLoopFunctions:
435             displayName: Control Loop Functions
436             type: OTHER
437         dimensioningInfo:
438             displayName: Dimensioning Info
439             type: OTHER
440         affinityRules:
441             displayName: Affinity Rules
442             type: OTHER
443         operationalPolicies:
444             displayName: Operational Policies
445             type: OTHER
446         serviceSpecificPolicies:
447             displayName: Service-specific Policies
448             type: OTHER
449         engineeringRules:
450             displayName: Engineering Rules (ERD)
451             type: OTHER
452         distributionInstructions:
453             displayName: Distribution Instructions
454             type: OTHER
455         certificationTestResults:
456             displayName: TD Certification Test Results
457             type: OTHER
458         deploymentVotingRecord:
459             displayName: Deployment Voting Record
460             type: OTHER
461         serviceQuestionnaire:
462             displayName: Service Questionnaire
463             type: OTHER
464         serviceSecurityTemplate:
465             displayName: Service Security Template
466             type: OTHER
467
468     # Service api artifacts placeHolder
469     # For each artifact the following properties exists:
470     #
471     # displayName - The display name of the artifact
472     # type - The type of the artifact
473     serviceApiArtifacts:
474         configuration:
475             displayName: Configuration
476             type: OTHER
477         instantiation:
478             displayName: Instantiation
479             type: OTHER
480         monitoring:
481             displayName: Monitoring
482             type: OTHER
483         reporting:
484             displayName: Reporting
485             type: OTHER
486         logging:
487             displayName: Logging
488             type: OTHER
489         testing:
490             displayName: Testing
491             type: OTHER
492
493     # The maximum number of keys permitted for additional information on service
494     additionalInformationMaxNumberOfKeys: 50
495
496     # Collect process statistics
497     systemMonitoring:
498
499         # Should monitoring be enabled
500         enabled: false
501
502         # In case of going through the FE server proxy the information to the BE
503         isProxy: false
504
505         # What is the interval of the statistics collection
506         probeIntervalInSeconds: 15
507
508     defaultHeatArtifactTimeoutMinutes: 60
509
510     # Service deployment artifacts placeHolder
511     # For each artifact the following properties exists:
512     #
513     # acceptedTypes - File types that can be uploaded as each artifact
514     serviceDeploymentArtifacts:
515         YANG_XML:
516             acceptedTypes:
517                 - xml
518         VNF_CATALOG:
519             acceptedTypes:
520                 - xml
521         MODEL_INVENTORY_PROFILE:
522             acceptedTypes:
523                 - xml
524         MODEL_QUERY_SPEC:
525             acceptedTypes:
526                 - xml
527         UCPE_LAYER_2_CONFIGURATION:
528             acceptedTypes:
529                 - xml
530
531     #AAI Artifacts
532         AAI_SERVICE_MODEL:
533             acceptedTypes:
534                 - xml
535         AAI_VF_MODULE_MODEL:
536             acceptedTypes:
537                 - xml
538         AAI_VF_INSTANCE_MODEL:
539             acceptedTypes:
540                 - xml
541         UCPE_LAYER_2_CONFIGURATION:
542             acceptedTypes:
543                 - xml
544         OTHER:
545             acceptedTypes:
546
547     #PLAN
548         PLAN:
549             acceptedTypes:
550                 - xml
551     WORKFLOW:
552             acceptedTypes:
553     # Resource deployment artifacts placeHolder
554     # For each artifact the following properties exists:
555     #
556     # acceptedTypes - File types that can be uploaded as each artifact
557     # validForRespurceTypes - Resource types that support each artifact.
558     # If left empty it means all resource types are valid
559     resourceDeploymentArtifacts:
560         HEAT:
561             acceptedTypes:
562                 - yaml
563                 - yml
564             validForResourceTypes: *allResourceTypes
565         HEAT_VOL:
566             acceptedTypes:
567                 - yaml
568                 - yml
569             validForResourceTypes: *allResourceTypes
570         HEAT_NET:
571             acceptedTypes:
572                 - yaml
573                 - yml
574             validForResourceTypes: *allResourceTypes
575         HEAT_NESTED:
576             acceptedTypes:
577                 - yaml
578                 - yml
579             validForResourceTypes: *allResourceTypes
580         HEAT_ARTIFACT:
581             acceptedTypes:
582             validForResourceTypes: *allResourceTypes
583         YANG_XML:
584             acceptedTypes:
585                 - xml
586             validForResourceTypes: *allResourceTypes
587         VNF_CATALOG:
588             acceptedTypes:
589                 - xml
590             validForResourceTypes: *allResourceTypes
591         VF_LICENSE:
592             acceptedTypes:
593                 - xml
594             validForResourceTypes: *allResourceTypes
595         VENDOR_LICENSE:
596             acceptedTypes:
597                 - xml
598             validForResourceTypes: *allResourceTypes
599         MODEL_INVENTORY_PROFILE:
600             acceptedTypes:
601                 - xml
602             validForResourceTypes: *allResourceTypes
603         MODEL_QUERY_SPEC:
604             acceptedTypes:
605                 - xml
606             validForResourceTypes: *allResourceTypes
607         LIFECYCLE_OPERATIONS:
608             acceptedTypes:
609                 - yaml
610                 - yml
611             validForResourceTypes:
612                 - VF
613                 - VFC
614         VES_EVENTS:
615             acceptedTypes:
616                 - yaml
617                 - yml
618             validForResourceTypes: *allResourceTypes
619         PERFORMANCE_COUNTER:
620             acceptedTypes:
621                 - csv
622             validForResourceTypes: *allResourceTypes
623         APPC_CONFIG:
624             acceptedTypes:
625             validForResourceTypes:
626                 - VF
627         DCAE_TOSCA:
628             acceptedTypes:
629                 - yml
630                 - yaml
631             validForResourceTypes:
632                 - VF
633                 - VFCMT
634         DCAE_JSON:
635             acceptedTypes:
636                 - json
637             validForResourceTypes:
638                 - VF
639                 - VFCMT
640         DCAE_POLICY:
641             acceptedTypes:
642                 - emf
643             validForResourceTypes:
644                 - VF
645                 - VFCMT
646         DCAE_DOC:
647             acceptedTypes:
648             validForResourceTypes:
649                 - VF
650                 - VFCMT
651         DCAE_EVENT:
652             acceptedTypes:
653             validForResourceTypes:
654                 - VF
655                 - VFCMT
656         AAI_VF_MODEL:
657             acceptedTypes:
658                 - xml
659             validForResourceTypes:
660                 - VF
661         AAI_VF_MODULE_MODEL:
662             acceptedTypes:
663                 - xml
664             validForResourceTypes:
665                 - VF
666         OTHER:
667             acceptedTypes:
668             validForResourceTypes: *allResourceTypes
669         SNMP_POLL:
670             acceptedTypes:
671             validForResourceTypes: *allResourceTypes
672         SNMP_TRAP:
673             acceptedTypes:
674             validForResourceTypes: *allResourceTypes
675
676     #PLAN
677         PLAN:
678             acceptedTypes:
679                 - xml
680             validForResourceTypes:
681                 - VF
682                 - VFC
683     WORKFLOW:
684         acceptedTypes:
685
686     # Resource instance deployment artifacts placeHolder
687     # For each artifact the following properties exists:
688     #
689     # acceptedTypes - File types that can be uploaded as each artifact
690     # validForRespurceTypes - Resource types that support each artifact.
691     # If left empty it means all resource types are valid
692     resourceInstanceDeploymentArtifacts:
693         HEAT_ENV:
694             acceptedTypes:
695                 - env
696         VF_MODULES_METADATA:
697             acceptedTypes:
698                 - json
699         VES_EVENTS:
700             acceptedTypes:
701                 - yaml
702                 - yml
703         PERFORMANCE_COUNTER:
704             acceptedTypes:
705                 - csv
706         DCAE_INVENTORY_TOSCA:
707             acceptedTypes:
708                 - yml
709                 - yaml
710         DCAE_INVENTORY_JSON:
711             acceptedTypes:
712                 - json
713         DCAE_INVENTORY_POLICY:
714           acceptedTypes:
715                 - emf
716         DCAE_INVENTORY_DOC:
717           acceptedTypes:
718         DCAE_INVENTORY_BLUEPRINT:
719           acceptedTypes:
720         DCAE_INVENTORY_EVENT:
721           acceptedTypes:
722         SNMP_POLL:
723             acceptedTypes:
724             validForResourceTypes: *allResourceTypes
725         SNMP_TRAP:
726             acceptedTypes:
727             validForResourceTypes: *allResourceTypes
728
729     #PLAN
730         PLAN:
731             acceptedTypes:
732                 - xml
733
734     # Resource informational artifacts placeHolder
735     # For each artifact the following properties exists:
736     #
737     # acceptedTypes - File types that can be uploaded as each artifact
738     # validForRespurceTypes - Resource types that support each artifact.
739     # If left empty it means all resource types are valid
740     resourceInformationalArtifacts:
741         CHEF:
742             acceptedTypes:
743             validForResourceTypes: *allResourceTypes
744         PUPPET:
745             acceptedTypes:
746             validForResourceTypes: *allResourceTypes
747         SHELL:
748             acceptedTypes:
749             validForResourceTypes: *allResourceTypes
750         YANG:
751             acceptedTypes:
752             validForResourceTypes: *allResourceTypes
753         YANG_XML:
754             acceptedTypes:
755             validForResourceTypes: *allResourceTypes
756         HEAT:
757             acceptedTypes:
758             validForResourceTypes: *allResourceTypes
759         BPEL:
760             acceptedTypes:
761             validForResourceTypes: *allResourceTypes
762         DG_XML:
763             acceptedTypes:
764             validForResourceTypes: *allResourceTypes
765         MURANO_PKG:
766             acceptedTypes:
767             validForResourceTypes: *allResourceTypes
768         OTHER:
769             acceptedTypes:
770             validForResourceTypes:
771                 - VFC
772                 - CVFC
773                 - CP
774                 - VL
775                 - VF
776                 - CR
777                 - VFCMT
778                 - Abstract
779                 - PNF
780         SNMP_POLL:
781             acceptedTypes:
782             validForResourceTypes: *allResourceTypes
783         SNMP_TRAP:
784             acceptedTypes:
785             validForResourceTypes: *allResourceTypes
786         GUIDE:
787             acceptedTypes:
788             validForResourceTypes:
789                 - VF
790                 - VFC
791                 - CVFC
792
793     # Resource informational deployment artifact placeholder
794     resourceInformationalDeployedArtifacts:
795
796     # Requirements needed to be fulfilled before certification
797     requirementsToFulfillBeforeCert:
798
799     # Capabilities needed to be fulfilled before certification
800     capabilitiesToConsumeBeforeCert:
801
802     # Urls that should not be logged
803     unLoggedUrls:
804        - /sdc2/rest/healthCheck
805
806     # When component is being set as deleted those are the clean configurations
807     cleanComponentsConfiguration:
808
809         # The interval to check for deleted components to clean
810         cleanIntervalInMinutes: 1440
811
812         # The components types to delete
813         componentsToClean:
814            - Resource
815            - Service
816
817     # Deprecated. Will be removed in future releases
818     artifactsIndex: resources
819
820     # Used to add header and footer to heatENV files generated by SDC
821     heatEnvArtifactHeader: ""
822     heatEnvArtifactFooter: ""
823
824     onboarding:
825
826         # Onboarding protocol
827         protocol: http
828
829         # Onboarding backend hostname
830         host: <%= @host_ip %>
831
832         # Onboarding backend http port
833         port: <%= @catalog_port %>
834
835         # The url that being used when downloading CSARs
836         downloadCsarUri: "/onboarding-api/v1.0/vendor-software-products/packages"
837
838         # Url for onboarding health check
839         healthCheckUri: "/onboarding-api/v1.0/healthcheck"
840
841     dcae:
842         # The ip of the onboarding docker
843         host: <%= @dcae_be_vip %>
844         # The protocol to use
845         protocol: <https/http>
846         # The port the docker is listening on
847         port: <port>
848         # The url of the health check to use
849         healthCheckUri: "/dcae/healthCheck"
850
851
852     #GSS IDNS
853     # Switchover configuration is used for Geo redundancy to provide automatic failovers
854     switchoverDetector:
855         gBeFqdn:
856         gFeFqdn:
857         beVip: 1.2.3.4
858         feVip: 1.2.3.4
859         beResolveAttempts: 3
860         feResolveAttempts: 3
861         enabled: false
862         interval: 60
863         changePriorityUser: ecompasdc
864         changePriorityPassword: ecompasdc123
865         publishNetworkUrl:
866         publishNetworkBody: '{"note":"comment"}'
867         groups:
868           beSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["","","failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
869           feSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["",""],"failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
870
871     # Cache for datatypes. Improving run times for data type search
872     applicationL1Cache:
873         datatypes:
874             enabled: true
875             firstRunDelay: 10
876             pollIntervalInSec: 60
877
878     # Deprecated. Will be removed in future releases
879     applicationL2Cache:
880         enabled: false
881         catalogL1Cache:
882             enabled: false
883             resourcesSizeInCache: 300
884             servicesSizeInCache: 200
885             productsSizeInCache: 100
886         queue:
887             syncIntervalInSecondes: 43200
888             waitOnShutDownInMinutes: 10
889             numberOfCacheWorkers: 4
890
891     # Validators for Tosca properties
892     toscaValidators:
893         stringMaxLength: 2500
894
895     # Should audit be disabled
896     disableAudit: false
897
898     # VF module validations properties
899     vfModuleProperties:
900         min_vf_module_instances:
901             forBaseModule: 1
902             forNonBaseModule: 0
903         max_vf_module_instances:
904             forBaseModule: 1
905             forNonBaseModule:
906         initial_count:
907             forBaseModule: 1
908             forNonBaseModule: 0
909         vf_module_type:
910             forBaseModule: Base
911             forNonBaseModule: Expansion
912
913     # For each generic node type defining its corresponding class
914     genericAssetNodeTypes:
915         VFC: org.openecomp.resource.abstract.nodes.VFC
916         CVFC: org.openecomp.resource.abstract.nodes.VFC
917         VF : org.openecomp.resource.abstract.nodes.VF
918         PNF: org.openecomp.resource.abstract.nodes.PNF
919         Service: org.openecomp.resource.abstract.nodes.service
920     # tenant isolation configuration
921     workloadContext: Production
922     # tenant isolation configuration
923     environmentContext:
924         defaultValue: General_Revenue-Bearing
925         validValues:
926            - Critical_Revenue-Bearing
927            - Vital_Revenue-Bearing
928            - Essential_Revenue-Bearing
929            - Important_Revenue-Bearing
930            - Needed_Revenue-Bearing
931            - Useful_Revenue-Bearing
932            - General_Revenue-Bearing
933            - Critical_Non-Revenue
934            - Vital_Non-Revenue
935            - Essential_Non-Revenue
936            - Important_Non-Revenue
937            - Needed_Non-Revenue
938            - Useful_Non-Revenue
939            - General_Non-Revenue
940     # tenant isolation configuration
941     dmaapConsumerConfiguration:
942         hosts: localhost:3905
943         consumerGroup: sdc
944         consumerId: mama
945         timeoutMs: 15000
946         limit: 1
947         pollingInterval: 2
948         topic: topic
949         latitude: 32.109333
950         longitude: 34.855499
951         version: 1.0
952         serviceName: localhost/events
953         environment: TEST
954         partner: BOT_R
955         routeOffer: MR1
956         protocol: https
957         contenttype: application/json
958         dme2TraceOn: true
959         aftEnvironment: AFTUAT
960         aftDme2ConnectionTimeoutMs: 15000
961         aftDme2RoundtripTimeoutMs: 240000
962         aftDme2ReadTimeoutMs: 50000
963         dme2preferredRouterFilePath: DME2preferredRouter.txt
964         timeLimitForNotificationHandleMs: 120000
965         credential:
966             username: user
967             password:
968     # tenant isolation configuration
969     dmeConfiguration:
970         dme2Search: DME2SEARCH
971         dme2Resolve: DME2RESOLVE
972     # definition for policies types that cannot by created by api
973     excludedPolicyTypesMapping:
974        # VF:
975         #  - a.b.c
976         #  - c.d.e
977         #CR:
978         #  - x.y.z
979     # definition for group types that cannot by created by api
980     excludedGroupTypesMapping:
981         CR:
982            - org.openecomp.groups.VfModule
983            - org.openecomp.groups.heat.HeatStack
984            - tosca.groups.Root
985         PNF:
986            - org.openecomp.groups.VfModule
987            - org.openecomp.groups.heat.HeatStack
988            - tosca.groups.Root
989         VF:
990            - org.openecomp.groups.VfModule
991            - org.openecomp.groups.heat.HeatStack
992            - tosca.groups.Root
993         Service:
994            - org.openecomp.groups.VfModule
995            - org.openecomp.groups.heat.HeatStack
996            - tosca.groups.Root
997
998     healthStatusExclude:
999        - DE
1000        - DMAAP
1001        - DCAE
1002
1003
1004 BE-distribution-engine-configuration.yaml
1005 *****************************************
1006
1007 ::
1008
1009     # UEB servers list
1010     uebServers:
1011         <% node['UEB']['fqdn'].each do |conn| -%>
1012             - <%= conn %>
1013         <% end -%>
1014
1015     # UEB public key
1016     uebPublicKey: <%= node['UEB']['PublicKey'] %>
1017
1018     # UEB secret key
1019     uebSecretKey: <%= node['UEB']['SecretKey'] %>
1020
1021     # Topic name for receiving distribution notification
1022     distributionNotifTopicName:  SDC-DISTR-NOTIF-TOPIC
1023
1024     # Topic name for distribution status
1025     distributionStatusTopicName: SDC-DISTR-STATUS-TOPIC
1026
1027     # Distribution initialization retry interval time
1028     initRetryIntervalSec: 5
1029
1030     # Distribution initialization maximum interval time
1031     initMaxIntervalSec: 60
1032
1033     # Deprecated. Will be removed in future releases
1034     distribNotifServiceArtifactTypes:
1035         info:
1036             - MURANO-PKG
1037
1038     # Deprecated. Will be removed in future releases
1039     distribNotifResourceArtifactTypes:
1040         lifecycle:
1041             - HEAT
1042             - DG-XML
1043
1044     # Distribution environments
1045     environments:
1046         - <%= node.chef_environment %>
1047
1048     distributionStatusTopic:
1049
1050         # Distribution status polling interval
1051         pollingIntervalSec: 60
1052
1053         # Distribution status fetch time
1054         fetchTimeSec: 15
1055
1056         # Distribution status consumer group
1057         consumerGroup: sdc-<%= node.chef_environment %>
1058
1059         # Distribution status consumer id
1060         consumerId: sdc-<%= node.chef_environment %>1
1061
1062     distributionNotificationTopic:
1063
1064         # Minimum pool size for distribution notifications
1065         minThreadPoolSize: 0
1066
1067         # Maximum pool size for distribution notifications
1068         maxThreadPoolSize: 10
1069
1070         # Maximum waiting time after sending a notification
1071         maxWaitingAfterSendingSeconds: 5
1072
1073     # Deprecated. Will be removed in future releases
1074     createTopic:
1075         partitionCount: 1
1076         replicationCount: 1
1077
1078     # STarting the distribution engine
1079     startDistributionEngine: true
1080
1081     #This is false by default, since ONAP Dmaap currently doesn't support https
1082     # Should https be used with Dmaap
1083     useHttpsWithDmaap: false
1084     opEnvRecoveryIntervalSec: 180
1085     allowedTimeBeforeStaleSec: 300
1086     # aai configuration for tenant isolation
1087     aaiConfig:
1088        httpRequestConfig:
1089           serverRootUrl: https://aai-uint3.test.att.com:8443
1090           resourceNamespaces:
1091              operationalEnvironments: /aai/v12/cloud-infrastructure/operational-environments
1092
1093        httpClientConfig:
1094           timeouts:
1095              readTimeoutMs: 5000
1096              connectTimeoutMs: 1000
1097           clientCertificate:
1098              keyStore: /opt/app/jetty/base/be/etc/non-prod.jks
1099              keyStorePassword: hmXYcznAljMSisdy8zgcag==
1100           headers:
1101              X-FromAppId: asdc
1102           numOfRetries: 3
1103     # mso configuration for tenant isolation
1104     msoConfig:
1105        httpRequestConfig:
1106           serverRootUrl: http://127.0.0.1:8080/onap/mso/infra/modelDistributions/v1
1107           resourceNamespaces:
1108              distributions: /distributions
1109
1110        httpClientConfig:
1111            timeouts:
1112               readTimeoutMs: 2000
1113               connectTimeoutMs: 500
1114            basicAuthorization:
1115               userName: asdc
1116               password: OTLEp5lfVhYdyw5EAtTUBQ==
1117            numOfRetries: 3
1118
1119     currentArtifactInstallationTimeout: 120
1120
1121 BE-janusgraph.properties
1122 *******************
1123
1124 ::
1125
1126     # JanusGraph storage backend
1127     storage.backend=cassandra
1128
1129     # JanusGraph storage hostname
1130     storage.hostname=<%= @CASSANDRA_IP %>
1131
1132     # JanusGraph storage port
1133     storage.port=9042
1134
1135     # JanusGraph storage username
1136     storage.username=<%= @CASSANDRA_USR %>
1137
1138     # JanusGraph storage password
1139     storage.password=<%= @CASSANDRA_PWD %>
1140
1141     # JanusGraph storage connection timeout
1142     storage.connection-timeout=10000
1143
1144     # JanusGraph cassandra keyspace name
1145     storage.cassandra.keyspace=sdctitan
1146
1147     # Is JanusGraph cassandra ssl is enabled
1148     storage.cassandra.ssl.enabled=false
1149
1150     # JanusGraph cassandra ssl truststore file location
1151     storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
1152
1153     # JanusGraph cassandra ssl truststore file password
1154     storage.cassandra.ssl.truststore.password=Aa123456
1155
1156     # Should JanusGraph use cache
1157     cache.db-cache = false
1158
1159     # How long in milliseconds should the cache keep entries before flushing them
1160     cache.db-cache-clean-wait = 20
1161
1162     # Default expiration time in milliseconds for entries in the cache
1163     cache.db-cache-time = 180000
1164
1165     # Size of JanusGraph database cache
1166     cache.db-cache-size = 0.5
1167
1168     # JanusGraph cassandra read consistency level
1169     storage.cassandra.read-consistency-level=LOCAL_QUORUM
1170
1171     # JanusGraph cassandra write consistency level
1172     storage.cassandra.write-consistency-level=LOCAL_QUORUM
1173
1174     # JanusGraph cassandra replication strategy class name
1175     storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy
1176
1177     # JanusGraph cassandra replication startegy options
1178     storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %>
1179
1180     # JanusGraph cassandra local data center name
1181     storage.cassandra.astyanax.local-datacenter=<%= @DC_NAME %>
1182
1183     # Number of times the system attempts to acquire a lock before giving up and throwing an exception
1184     storage.lock.retries=5
1185
1186     # Number of milliseconds the system waits for a lock application to be acknowledged by the storage backend
1187     storage.lock.wait-time=500
1188
1189
1190 Onboarding configuration
1191 ------------------------
1192
1193 BE-onboarding-configuration.yaml
1194 ********************************
1195
1196 ::
1197
1198     notifications:
1199
1200         # Backend onboarding notifications polling interval in milliseconds
1201         pollingIntervalMsec: 2000
1202
1203         # Backend onboarding notifications selection size
1204         selectionSize: 100
1205
1206         # Backend onboarding notifications backend hostname
1207         beHost: <%= @catalog_ip %>
1208
1209         # Backend onboarding notifications backend http port
1210         beHttpPort: <%= @catalog_port %>
1211     # Casandra configuration
1212     cassandraConfig:
1213         cassandraHosts: [<%= @cassandra_ip %>]
1214         localDataCenter: <%= @DC_NAME %>
1215         reconnectTimeout : 30000
1216         socketReadTimeout: <%= @socket_read_timeout %>
1217         socketConnectTimeout: <%= @socket_connect_timeout %>
1218         authenticate: true
1219         username: <%= @cassandra_usr %>
1220         password: <%= @cassandra_pwd %>
1221         ssl: <%= @cassandra_ssl_enabled %>
1222         truststorePath: /config/truststore
1223         truststorePassword: <%= @cassandra_truststore_password %>
1224
1225 externaltesting-configuration.yaml
1226 **********************************
1227
1228 ::
1229
1230     # configuration to make available to the front end of this feature
1231     client:
1232       enabled: true
1233     # array of endpoints that SDC-BE should connect with for external testing
1234     # id,label,enabled,url[,scenariofilter][,apikey]
1235     endpoints:
1236       - vtp:VTP,true,http://<hostname>[:<port>]/onapapi/vnfsdk-marketplace,c.*
1237       - repository:Repository,false,http://<ovphostname>[:<ovpport>]
1238
1239
1240
1241 vnfrepo-configuration.yaml
1242 **************************
1243
1244 ::
1245
1246     # The port on which the vnfsdk is licensing
1247     vnfRepoPort: <port>
1248     # The ip where vnfdk is deployed
1249     vnfRepoHost: <ip>
1250     # The url used for querying the vnf sdk for available CSARs
1251     getVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars
1252     # The url used for downloading the the CSAR from vnf sdk
1253     downloadVnfUri: /onapapi/vnfsdk-marketplace/v1/PackageResource/csars/%s/files
1254
1255
1256
1257 Frontend Configuration
1258 ======================
1259 Catalog configuration
1260 ---------------------
1261
1262 FE-configuration.yaml
1263 *********************
1264
1265 ::
1266
1267     # Catalog frontend hostname
1268     feFqdn: <%= @fe_host_ip %>
1269
1270     # Catalog backend hostname
1271     beHost: <%= @be_host_ip %>
1272
1273     # Catalog backend http port
1274     beHttpPort: <%= @catalog_port %>
1275
1276     # Catalog backend http context
1277     beContext: /sdc2/rest/v1/catalog/upload/resources
1278
1279     # Catalog backend protocol
1280     beProtocol: http
1281
1282     # Catalog backend ssl port
1283     beSslPort: <%= @ssl_port %>
1284
1285     # Threadpool size for handling requests
1286     threadpoolSize: 50
1287
1288     # Request processing timeout (seconds)
1289     requestTimeout: 10
1290
1291     # Health check timeout in milliseconds
1292     healthCheckSocketTimeoutInMs: 5000
1293
1294     # Health check inteval in seconds
1295     healthCheckIntervalInSeconds: 5
1296
1297     onboarding:
1298
1299         # Onboarding protocol
1300         protocol: http
1301
1302         # Onboarding frontend hostname
1303         host: <%= @fe_host_ip %>
1304
1305         # Onboarding frontend port
1306         port: 8181
1307
1308         # Onboarding frontend health check url
1309         healthCheckUri: "/onboarding/v1.0/healthcheck"
1310
1311     # Request headers for identification of the user that made the request
1312     identificationHeaderFields:
1313         -
1314             - &HTTP_IV_USER HTTP_IV_USER
1315             - &iv-user iv-user
1316         -
1317             - &USER_ID USER_ID
1318             - &user-id user-id
1319         -
1320             - &HTTP_CSP_ATTUID HTTP_CSP_ATTUID
1321             - &csp-attuid csp-attuid
1322         -
1323             - &HTTP_CSP_WSTYPE HTTP_CSP_WSTYPE
1324             - &csp-wstype csp-wstype
1325
1326     # Optional request headers
1327     optionalHeaderFields:
1328         -
1329             - &HTTP_CSP_FIRSTNAME HTTP_CSP_FIRSTNAME
1330             - &csp-firstname csp-firstname
1331         -
1332             - &HTTP_CSP_LASTNAME HTTP_CSP_LASTNAME
1333             - &csp-lastname csp-lastname
1334         -
1335             - &HTTP_IV_REMOTE_ADDRESS HTTP_IV_REMOTE_ADDRESS
1336             - &iv-remote-address iv-remote-address
1337         -
1338             - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL
1339             - &csp-email csp-email
1340
1341     # Frontend configuration version
1342     version: 1.0
1343
1344     # Frontend configuration release date
1345     released: 2012-11-30
1346
1347     # Connection parameters
1348     connection:
1349         url: jdbc:mysql://localhost:3306/db
1350         poolSize: 17
1351
1352     # Protocols being used in SDC
1353     protocols:
1354         - http
1355         - https
1356
1357     # Collect process statistics
1358     systemMonitoring:
1359
1360         # Should monitoring be enabled
1361         enabled: false
1362
1363         # In case of going through the FE server proxy the information to the BE
1364         isProxy: true
1365
1366         # What is the interval of the statistics collection
1367         probeIntervalInSeconds: 15
1368
1369     # Kibana hostname
1370     kibanaHost: localhost
1371
1372     # Kibana http port
1373     kibanaPort: 5601
1374
1375     # Kibana usage protocol
1376     kibanaProtocol: http
1377
1378 FE-plugins-configuration.yaml
1379 *****************************
1380 ::
1381
1382    # definition of the plugins that exist in sdc
1383    # we have a pre-defined list of plugins that are connected to the system.
1384    # the plugins define where they are shown, to whom and on what elements
1385    pluginsList:
1386         # the DCAE-DS is the SDC monitoring design studio this entry defines there use as part of the service level context
1387       - pluginId: DCAED
1388         # this defines from which url to chek that they are available
1389         pluginDiscoveryUrl: <%= @dcae_discovery_url %>
1390         # this defines from wht URL will ther you be served.
1391         pluginSourceUrl: <%= @dcae_source_url %>
1392         #thsi defines the plugin state name used by the UI for sending messages.
1393         pluginStateUrl: "dcaed"
1394         # the display options for the plugin
1395         pluginDisplayOptions:
1396            # the plugin will be displayed in the context of a catalog item
1397            context:
1398                # what will the option tag in the ui will be called
1399                displayName: "Monitoring"
1400                # under what catalog item to display it
1401                displayContext: ["SERVICE"]
1402                # what user roles will have the option to access the plugin
1403                displayRoles: ["DESIGNER"]
1404         # DCAE-DS as a tab
1405       - pluginId: DCAE-DS
1406         pluginDiscoveryUrl: <%= @dcae_dt_discovery_url %>
1407         pluginSourceUrl: <%= @dcae_dt_source_url %>
1408         pluginStateUrl: "dcae-ds"
1409         pluginDisplayOptions:
1410           tab:
1411               displayName: "DCAE-DS"
1412               displayRoles: ["DESIGNER"]
1413         #work flow plugin
1414       - pluginId: WORKFLOW
1415         pluginDiscoveryUrl: <%= @workflow_discovery_url %>
1416         pluginSourceUrl: <%= @workflow_source_url %>
1417         pluginStateUrl: "workflowDesigner"
1418         pluginDisplayOptions:
1419            tab:
1420                displayName: "WORKFLOW"
1421                displayRoles: ["DESIGNER", "TESTER"]
1422
1423    # how long we will wait for the plugin to respond before cutting it.
1424    connectionTimeout: 1000
1425
1426 FE-workspace-configuration.yaml
1427 *****************************
1428 ::
1429
1430 # this file contains the different configurable UI workspace items that can be set according to resource and service type.
1431 # the workspaceMenuConfiguration entry defines the workspace menus that are displayed according to type/subtype of the component in the workspace
1432 # 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
1433 # items that will be displayed.
1434 #
1435 # each key had a list of menu items with the following data:
1436 #   - text: display text,
1437 #   - state: the state for the screen
1438 #   - action: action associated
1439 #   - index: optional - an integer that will be used to decide on the order of appearance
1440 # following are 2 example
1441     workspaceMenuConfiguration:
1442       VFC:
1443       - text: General
1444         action: onMenuItemPressed
1445         state: workspace.general
1446       - text: Deployment Artifact
1447         action: onMenuItemPressed
1448         state: workspace.deployment_artifacts
1449       - text: Information Artifact
1450         action: onMenuItemPressed
1451         state: workspace.information_artifacts
1452       - text: TOSCA Artifacts
1453         action: onMenuItemPressed
1454         state: workspace.tosca_artifacts
1455       - text: Properties
1456         action: onMenuItemPressed
1457         state: workspace.properties
1458       - text: Attributes
1459         action: onMenuItemPressed
1460         state: workspace.attributes
1461       - text: Req. & Capabilities
1462         action: onMenuItemPressed
1463         state: workspace.reqAndCap
1464       - text: Activity Log
1465         action: onMenuItemPressed
1466         state: workspace.activity_log
1467       SERVICE:
1468       - text: General
1469         action: onMenuItemPressed
1470         state: workspace.general
1471       - text: TOSCA Artifacts
1472         action: onMenuItemPressed
1473         state: workspace.tosca_artifacts
1474       - text: Composition
1475         action: onMenuItemPressed
1476         state: workspace.composition.details
1477       - text: Operation
1478         action: onMenuItemPressed
1479         state: workspace.interface_operation
1480       - text: Activity Log
1481         action: onMenuItemPressed
1482         state: workspace.activity_log
1483       - text: Management Workflow
1484         action: onMenuItemPressed
1485         state: workspace.management_workflow
1486       - text: 'Network Call Flow '
1487         action: onMenuItemPressed
1488         state: workspace.network_call_flow
1489       - text: Distribution
1490         action: onMenuItemPressed
1491         state: workspace.distribution
1492         disabledRoles:
1493         - ADMIN
1494         - TESTER
1495         - GOVERNOR
1496         - DESIGNER
1497       - text: Deployment
1498         action: onMenuItemPressed
1499         state: workspace.deployment
1500       - text: Properties Assignment
1501         action: onMenuItemPressed
1502         state: workspace.properties_assignment
1503       - text: Outputs
1504         action: onMenuItemPressed
1505         state: workspace.outputs_assignment
1506       - text: Req. & Capabilities
1507         action: onMenuItemPressed
1508         state: workspace.reqAndCapEditable
1509
1510
1511 Onboarding configuration
1512 ------------------------
1513
1514 FE-onboarding-configuration.yaml
1515 ********************************
1516
1517 ::
1518
1519     notifications:
1520
1521         # Frontend onboarding notifications polling interval in milliseconds
1522         pollingIntervalMsec: 2000
1523
1524         # Frontend onboarding notifications selection size
1525         selectionSize: 100
1526
1527         # Frontend onboarding notifications backend hostname
1528         beHost: <%= @catalog_ip %>
1529
1530         # Frontend onboarding notifications backend http port
1531         beHttpPort: <%= @catalog_port %>
1532
1533