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