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