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