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