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