Merge "Configuration section to Read the Docs"
[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 .. note::
9    * This section is used to describe the options a software component offers for configuration.
10
11    * Configuration is typically: provided for platform-component and sdk projects;
12      and referenced in developer and user guides.
13    
14    * This note must be removed after content has been added.
15
16
17
18 Example ...
19
20 You can provide the following in ``basic.conf``
21
22 ``host=ADDRESS``
23   The address of the host
24
25 ``port=PORT``
26   The port used for signaling
27
28   Optional. Default: ``8080``
29
30
31 Global Configuration
32 ====================
33
34 environment.json
35 ----------------
36
37 ::
38
39     {
40         "name": "xxx",
41         "description": "OpenSource-xxx",
42         "cookbook_versions": {
43             "Deploy-SDandC": "= 1.0.0"
44         },
45         "json_class": "Chef::Environment",
46         "chef_type": "environment",
47         "default_attributes": {
48             "CS_VIP": "yyy",
49             "BE_VIP": "yyy",
50             "FE_VIP": "yyy",
51             "ES_VIP": "yyy",
52             "interfaces": {
53                 "application": "eth0",
54                 "private": "eth1"
55             },
56             "ECompP": {
57                 "ecomp_rest_url": "http://portal.api.simpledemo.onap.org:8989/ONAPPORTAL/auxapi",
58                 "ueb_url_list": "10.0.11.1,10.0.11.1",
59                 "app_secret": "XftIATw9Jr3VzAcPqt3NnJOu",
60                 "app_key": "x9UfO7JsDn8BESVX",
61                 "inbox_name": "ECOMP-PORTAL-INBOX",
62                 "ecomp_redirect_url": "http://portal.api.simpledemo.openecomp.org:8989/ECOMPPORTAL/login.htm",
63                 "app_topic_name": "ECOMP-PORTAL-OUTBOX-SDC1",
64                 "decryption_key": "AGLDdG4D04BKm2IxIWEr8o=="
65             },
66             "UEB": {
67                 "PublicKey": "iPIxkpAMI8qTcQj8",
68                 "SecretKey": "Ehq3WyT4bkif4zwgEbvshGal",
69                 "fqdn": ["10.0.11.1", "10.0.11.1"]
70             },
71             "Nodes": {
72                 "CS": "yyy",
73                 "BE": "yyy",
74                 "FE": "yyy",
75                 "ES": "yyy"
76             }
77         },
78         "override_attributes": {
79             "FE": {
80                 "http_port": "8181",
81                 "https_port": "9443"
82             },
83             "BE": {
84                 "http_port": "8080",
85                 "https_port": "8443"
86             },
87             "elasticsearch": {
88                 "cluster_name": "SDC-ES-",
89                 "ES_path_home": "/usr/share/elasticsearch",
90                 "ES_path_data": "/usr/share/elasticsearch/data",
91                 "num_of_replicas": "0",
92                 "num_of_shards": "1"
93             },
94             "cassandra": {
95                 "concurrent_reads": "32",
96                 "num_tokens": "256",
97                 "data_dir": "/var/lib/cassandra/data",
98                 "hinted_handoff_enabled": "true",
99                 "cassandra_user": "asdc_user",
100                 "cassandra_password": "Aa1234%^!",
101                 "concurrent_writes": "32",
102                 "cluster_name": "SDC-CS-",
103                 "multithreaded_compaction": "false",
104                 "cache_dir": "/var/lib/cassandra/saved_caches",
105                 "log_file": "/var/lib/cassandra/log/system.log",
106                 "phi_convict_threshold": "8",
107                 "commitlog_dir": "/var/lib/cassandra/commitlog"
108             }
109         }
110     }
111
112 Backend Configurations
113 ======================
114
115 BE-configoration.yaml
116 ---------------------
117
118 ::
119
120     identificationHeaderFields:
121     - HTTP_IV_USER
122     - HTTP_CSP_FIRSTNAME
123     - HTTP_CSP_LASTNAME
124     - HTTP_IV_REMOTE_ADDRESS
125     - HTTP_CSP_WSTYPE
126
127     # catalog backend hostname
128     beFqdn: <%= @host_ip %>
129     
130     # catalog backend http port
131     beHttpPort: <%= @catalog_port %>
132     
133     # catalog backend http context
134     beContext: /sdc/rest/config/get
135     
136     # catalog backend protocol
137     beProtocol: http
138     
139     # catalog backend ssl port
140     beSslPort: <%= @ssl_port %>
141     version: 1.0
142     released: 2012-11-30
143     toscaConformanceLevel: 4.0
144     minToscaConformanceLevel: 3.0
145     
146     titanCfgFile: /var/lib/jetty/config/catalog-be/titan.properties
147     titanInMemoryGraph: false
148     titanLockTimeout: 1800
149     # The interval to try and reconnect to titan DB when it is down during ASDC startup:
150     titanReconnectIntervalInSeconds: 3
151     
152     # The read timeout towards Titan DB when health check is invoked:
153     titanHealthCheckReadTimeout: 1
154     
155     # The interval to try and reconnect to Elasticsearch when it is down during ASDC startup:
156     esReconnectIntervalInSeconds: 3
157     uebHealthCheckReconnectIntervalInSeconds: 15
158     uebHealthCheckReadTimeout: 4
159     
160     # Protocols
161     protocols:
162         - http
163         - https
164     
165     # Default imports
166     defaultImports:
167         - nodes:
168             file: nodes.yml
169         - datatypes:
170             file: data.yml
171         - capabilities:
172             file: capabilities.yml
173         - relationships:
174             file: relationships.yml
175         - groups:
176             file: groups.yml
177         - policies:
178             file: policies.yml
179     
180     # Users
181     users:
182         tom: passwd
183         bob: passwd
184     
185     cassandraConfig:
186         cassandraHosts: <%= @cassandra_ip %>
187         localDataCenter: <%= @DC_NAME %>
188         reconnectTimeout : 30000
189         authenticate: true
190         username: asdc_user
191         password: {{cassandra_password}}
192         ssl: false
193         truststorePath : /config/.truststore
194         truststorePassword : Aa123456
195         keySpaces:
196             - { name: dox, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
197             - { name: sdcaudit, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
198             - { name: sdcartifact, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
199             - { name: sdccomponent, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
200             - { name: sdcrepository, replicationStrategy: NetworkTopologyStrategy, replicationInfo: ['<%= @DC_NAME %>','<%= @rep_factor %>']}
201     
202     #Application-specific settings of ES
203     elasticSearch:
204         # Mapping of index prefix to time-based frame. For example, if below is configured:
205         #
206         # - indexPrefix: auditingevents
207         #    creationPeriod: minute
208         #
209         # then ES object of type which is mapped to "auditingevents-*" template, and created on 2015-12-23 13:24:54, will enter "auditingevents-2015-12-23-13-24" index.
210         # Another object created on 2015-12-23 13:25:54, will enter "auditingevents-2015-12-23-13-25" index.
211         # If creationPeriod: month, both of the above will enter "auditingevents-2015-12" index.
212         #
213         # PLEASE NOTE: the timestamps are created in UTC/GMT timezone! This is needed so that timestamps will be correctly presented in Kibana.
214         #
215         # Legal values for creationPeriod - year, month, day, hour, minute, none (meaning no time-based behaviour).
216         #
217         # If no creationPeriod is configured for indexPrefix, default behavour is creationPeriod: month.
218     
219     indicesTimeFrequency:
220         - indexPrefix: auditingevents
221           creationPeriod: month
222         - indexPrefix: monitoring_events
223           creationPeriod: month
224     
225     artifactTypes:
226         - CHEF
227         - PUPPET
228         - SHELL
229         - YANG
230         - YANG_XML
231         - HEAT
232         - BPEL
233         - DG_XML
234         - MURANO_PKG
235         - WORKFLOW
236         - NETWORK_CALL_FLOW
237         - TOSCA_TEMPLATE
238         - TOSCA_CSAR
239         - AAI_SERVICE_MODEL
240         - AAI_VF_MODEL
241         - AAI_VF_MODULE_MODEL
242         - AAI_VF_INSTANCE_MODEL
243         - OTHER
244         - SNMP_POLL
245         - SNMP_TRAP
246         - GUIDE
247         - PLAN
248     
249     licenseTypes:
250         - User
251         - Installation
252         - CPU
253     
254     #Deployment artifacts placeHolder
255     resourceTypes: &allResourceTypes
256         - VFC
257         - CP
258         - VL
259         - VF
260         - VFCMT
261         - Abstract
262         - CVFC
263     
264     # validForResourceTypes usage
265     #     validForResourceTypes:
266     #        - VF
267     #        - VL
268     
269     deploymentResourceArtifacts:
270     
271     deploymentResourceInstanceArtifacts:
272         heatEnv:
273             displayName: "HEAT ENV"
274             type: HEAT_ENV
275             description: "Auto-generated HEAT Environment deployment artifact"
276             fileExtension: "env"
277         VfHeatEnv:
278             displayName: "VF HEAT ENV"
279             type: HEAT_ENV
280             description: "VF Auto-generated HEAT Environment deployment artifact"
281             fileExtension: "env"
282     
283     #tosca artifacts placeholders
284     toscaArtifacts:
285         assetToscaTemplate:
286             artifactName: -template.yml
287             displayName: Tosca Template
288             type: TOSCA_TEMPLATE
289             description: TOSCA representation of the asset
290         assetToscaCsar:
291             artifactName: -csar.csar
292             displayName: Tosca Model
293             type: TOSCA_CSAR
294             description: TOSCA definition package of the asset
295     
296     #Informational artifacts placeHolder
297     excludeResourceCategory:
298         - Generic
299     excludeResourceType:
300         - PNF
301     informationalResourceArtifacts:
302         features:
303             displayName: Features
304             type: OTHER
305     capacity:
306         displayName: Capacity
307         type: OTHER
308     vendorTestResult:
309         displayName: Vendor Test Result
310         type: OTHER
311     testScripts:
312         displayName: Test Scripts
313         type: OTHER
314     CloudQuestionnaire:
315         displayName: Cloud Questionnaire (completed)
316         type: OTHER
317     HEATTemplateFromVendor:
318         displayName: HEAT Template from Vendor
319         type: HEAT
320     resourceSecurityTemplate:
321         displayName: Resource Security Template
322         type: OTHER
323     
324     excludeServiceCategory:
325     
326     informationalServiceArtifacts:
327         serviceArtifactPlan:
328             displayName: Service Artifact Plan
329             type: OTHER
330         summaryOfImpactsToECOMPElements:
331             displayName: Summary of impacts to ECOMP elements,OSSs, BSSs
332             type: OTHER
333         controlLoopFunctions:
334             displayName: Control Loop Functions
335             type: OTHER
336         dimensioningInfo:
337             displayName: Dimensioning Info
338             type: OTHER
339         affinityRules:
340             displayName: Affinity Rules
341             type: OTHER
342         operationalPolicies:
343             displayName: Operational Policies
344             type: OTHER
345         serviceSpecificPolicies:
346             displayName: Service-specific Policies
347             type: OTHER
348         engineeringRules:
349             displayName: Engineering Rules (ERD)
350             type: OTHER
351         distributionInstructions:
352             displayName: Distribution Instructions
353             type: OTHER
354         certificationTestResults:
355             displayName: TD Certification Test Results
356             type: OTHER
357         deploymentVotingRecord:
358             displayName: Deployment Voting Record
359             type: OTHER
360         serviceQuestionnaire:
361             displayName: Service Questionnaire
362             type: OTHER
363         serviceSecurityTemplate:
364             displayName: Service Security Template
365             type: OTHER
366     
367     serviceApiArtifacts:
368         configuration:
369             displayName: Configuration
370             type: OTHER
371         instantiation:
372             displayName: Instantiation
373             type: OTHER
374         monitoring:
375             displayName: Monitoring
376             type: OTHER
377         reporting:
378             displayName: Reporting
379             type: OTHER
380         logging:
381             displayName: Logging
382             type: OTHER
383         testing:
384             displayName: Testing
385             type: OTHER
386     
387     additionalInformationMaxNumberOfKeys: 50
388     
389     systemMonitoring:
390         enabled: false
391         isProxy: false
392         probeIntervalInSeconds: 15
393     defaultHeatArtifactTimeoutMinutes: 60
394     
395     serviceDeploymentArtifacts:
396         YANG_XML:
397             acceptedTypes:
398                 - xml
399         VNF_CATALOG:
400             acceptedTypes:
401                 - xml
402         MODEL_INVENTORY_PROFILE:
403             acceptedTypes:
404                 - xml
405         MODEL_QUERY_SPEC:
406             acceptedTypes:
407                 - xml
408         UCPE_LAYER_2_CONFIGURATION:
409             acceptedTypes:
410                 - xml
411     
412     #AAI Artifacts
413         AAI_SERVICE_MODEL:
414             acceptedTypes:
415                 - xml
416         AAI_VF_MODULE_MODEL:
417             acceptedTypes:
418                 - xml
419         AAI_VF_INSTANCE_MODEL:
420             acceptedTypes:
421                 - xml
422         OTHER:
423             acceptedTypes:
424     
425     #PLAN
426         PLAN:
427             acceptedTypes:
428                 - xml
429     
430     resourceDeploymentArtifacts:
431         HEAT:
432             acceptedTypes:
433                 - yaml
434                 - yml
435             validForResourceTypes: *allResourceTypes
436         HEAT_VOL:
437             acceptedTypes:
438                 - yaml
439                 - yml
440             validForResourceTypes: *allResourceTypes
441         HEAT_NET:
442             acceptedTypes:
443                 - yaml
444                 - yml
445             validForResourceTypes: *allResourceTypes
446         HEAT_NESTED:
447             acceptedTypes:
448                 - yaml
449                 - yml
450             validForResourceTypes: *allResourceTypes
451         HEAT_ARTIFACT:
452             acceptedTypes:
453             validForResourceTypes: *allResourceTypes
454         YANG_XML:
455             acceptedTypes:
456                 - xml
457             validForResourceTypes: *allResourceTypes
458         VNF_CATALOG:
459             acceptedTypes:
460                 - xml
461             validForResourceTypes: *allResourceTypes
462         VF_LICENSE:
463             acceptedTypes:
464                 - xml
465             validForResourceTypes: *allResourceTypes
466         VENDOR_LICENSE:
467             acceptedTypes:
468                 - xml
469             validForResourceTypes: *allResourceTypes
470         MODEL_INVENTORY_PROFILE:
471             acceptedTypes:
472                 - xml
473             validForResourceTypes: *allResourceTypes
474         MODEL_QUERY_SPEC:
475             acceptedTypes:
476                 - xml
477             validForResourceTypes: *allResourceTypes
478         LIFECYCLE_OPERATIONS:
479             acceptedTypes:
480                 - yaml
481                 - yml
482             validForResourceTypes:
483                 - VF
484                 - VFC
485         VES_EVENTS:
486             acceptedTypes:
487                 - yaml
488                 - yml
489             validForResourceTypes: *allResourceTypes
490         PERFORMANCE_COUNTER:
491             acceptedTypes:
492                 - csv
493             validForResourceTypes: *allResourceTypes
494         APPC_CONFIG:
495             acceptedTypes:
496             validForResourceTypes:
497                 - VF
498         DCAE_TOSCA:
499             acceptedTypes:
500                 - yml
501                 - yaml
502             validForResourceTypes:
503                 - VF
504                 - VFCMT
505         DCAE_JSON:
506             acceptedTypes:
507                 - json
508             validForResourceTypes:
509                 - VF
510                 - VFCMT
511         DCAE_POLICY:
512             acceptedTypes:
513                 - emf
514             validForResourceTypes:
515                 - VF
516                 - VFCMT
517         DCAE_DOC:
518             acceptedTypes:
519             validForResourceTypes:
520                 - VF
521                 - VFCMT
522         DCAE_EVENT:
523             acceptedTypes:
524             validForResourceTypes:
525                 - VF
526                 - VFCMT
527         AAI_VF_MODEL:
528             acceptedTypes:
529                 - xml
530             validForResourceTypes:
531                 - VF
532         AAI_VF_MODULE_MODEL:
533             acceptedTypes:
534                 - xml
535             validForResourceTypes:
536                 - VF
537         OTHER:
538             acceptedTypes:
539             validForResourceTypes: *allResourceTypes
540         SNMP_POLL:
541             acceptedTypes:
542             validForResourceTypes: *allResourceTypes
543         SNMP_TRAP:
544             acceptedTypes:
545             validForResourceTypes: *allResourceTypes
546     
547     #PLAN
548         PLAN:
549             acceptedTypes:
550                 - xml
551             validForResourceTypes:
552                 - VF
553                 - VFC
554     
555     resourceInstanceDeploymentArtifacts:
556         HEAT_ENV:
557             acceptedTypes:
558                 - env
559         VF_MODULES_METADATA:
560             acceptedTypes:
561                 - json
562         VES_EVENTS:
563             acceptedTypes:
564                 - yaml
565                 - yml
566         PERFORMANCE_COUNTER:
567             acceptedTypes:
568                 - csv
569         DCAE_INVENTORY_TOSCA:
570             acceptedTypes:
571                 - yml
572                 - yaml
573         DCAE_INVENTORY_JSON:
574             acceptedTypes:
575                 - json
576         DCAE_INVENTORY_POLICY:
577           acceptedTypes:
578                 - emf
579         DCAE_INVENTORY_DOC:
580           acceptedTypes:
581         DCAE_INVENTORY_BLUEPRINT:
582           acceptedTypes:
583         DCAE_INVENTORY_EVENT:
584           acceptedTypes:
585         SNMP_POLL:
586             acceptedTypes:
587             validForResourceTypes: *allResourceTypes
588         SNMP_TRAP:
589             acceptedTypes:
590             validForResourceTypes: *allResourceTypes
591     
592     #PLAN
593         PLAN:
594             acceptedTypes:
595                 - xml
596     
597     resourceInformationalArtifacts:
598         CHEF:
599             acceptedTypes:
600             validForResourceTypes: *allResourceTypes
601         PUPPET:
602             acceptedTypes:
603             validForResourceTypes: *allResourceTypes
604         SHELL:
605             acceptedTypes:
606             validForResourceTypes: *allResourceTypes
607         YANG:
608             acceptedTypes:
609             validForResourceTypes: *allResourceTypes
610         YANG_XML:
611             acceptedTypes:
612             validForResourceTypes: *allResourceTypes
613         HEAT:
614             acceptedTypes:
615             validForResourceTypes: *allResourceTypes
616         BPEL:
617             acceptedTypes:
618             validForResourceTypes: *allResourceTypes
619         DG_XML:
620             acceptedTypes:
621             validForResourceTypes: *allResourceTypes
622         MURANO_PKG:
623             acceptedTypes:
624             validForResourceTypes: *allResourceTypes
625         OTHER:
626             acceptedTypes:
627             validForResourceTypes:
628                 - VFC
629                 - CVFC
630                 - CP
631                 - VL
632                 - VF
633                 - VFCMT
634                 - Abstract
635                 - PNF
636         SNMP_POLL:
637             acceptedTypes:
638             validForResourceTypes: *allResourceTypes
639         SNMP_TRAP:
640             acceptedTypes:
641             validForResourceTypes: *allResourceTypes
642         GUIDE:
643             acceptedTypes:
644             validForResourceTypes:
645                 - VF
646                 - VFC
647                 - CVFC
648     
649     resourceInformationalDeployedArtifacts:
650     
651     requirementsToFulfillBeforeCert:
652     
653     capabilitiesToConsumeBeforeCert:
654     
655     unLoggedUrls:
656        - /sdc2/rest/healthCheck
657     
658     cleanComponentsConfiguration:
659         cleanIntervalInMinutes: 1440
660         componentsToClean:
661            - Resource
662            - Service
663     
664     artifactsIndex: resources
665     
666     heatEnvArtifactHeader: ""
667     heatEnvArtifactFooter: ""
668     
669     onboarding:
670         protocol: http
671         host: <%= @host_ip %>
672         port: <%= @catalog_port %>
673         downloadCsarUri: "/onboarding-api/v1.0/vendor-software-products/packages"
674         healthCheckUri: "/onboarding-api/v1.0/healthcheck"
675     
676     
677     #GSS IDNS
678     switchoverDetector:
679         gBeFqdn:
680         gFeFqdn:
681         beVip: 1.2.3.4
682         feVip: 1.2.3.4
683         beResolveAttempts: 3
684         feResolveAttempts: 3
685         enabled: false
686         interval: 60
687         changePriorityUser: ecompasdc
688         changePriorityPassword: ecompasdc123
689         publishNetworkUrl:
690         publishNetworkBody: '{"note":"comment"}'
691         groups:
692           beSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["","","failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
693           feSet: { changePriorityUrl: "", changePriorityBody: '{"name":"","uri":"","no_ad_redirection":false,"v4groups":{"failover_groups":["",""],"failover_policy":["FAILALL"]},"comment":"","intended_app_proto":"DNS"}'}
694     
695     applicationL1Cache:
696         datatypes:
697             enabled: true
698             firstRunDelay: 10
699             pollIntervalInSec: 60
700     
701     applicationL2Cache:
702         enabled: false
703         catalogL1Cache:
704             enabled: false
705             resourcesSizeInCache: 300
706             servicesSizeInCache: 200
707             productsSizeInCache: 100
708         queue:
709             syncIntervalInSecondes: 43200
710             waitOnShutDownInMinutes: 10
711             numberOfCacheWorkers: 4
712     
713     toscaValidators:
714         stringMaxLength: 2500
715     
716     disableAudit: false
717     
718     vfModuleProperties:
719         min_vf_module_instances:
720             forBaseModule: 1
721             forNonBaseModule: 0
722         max_vf_module_instances:
723             forBaseModule: 1
724             forNonBaseModule:
725         initial_count:
726             forBaseModule: 1
727             forNonBaseModule: 0
728         vf_module_type:
729             forBaseModule: Base
730             forNonBaseModule: Expansion
731     
732     genericAssetNodeTypes:
733         VFC: org.openecomp.resource.abstract.nodes.VFC
734         CVFC: org.openecomp.resource.abstract.nodes.VFC
735         VF : org.openecomp.resource.abstract.nodes.VF
736         PNF: org.openecomp.resource.abstract.nodes.PNF
737         Service: org.openecomp.resource.abstract.nodes.service
738
739
740 BE-distribution-engine-configuration.yaml
741 -----------------------------------------
742
743 ::
744
745     uebServers:
746         <% node['UEB']['fqdn'].each do |conn| -%>
747             - <%= conn %>
748         <% end -%>
749     
750     uebPublicKey: <%= node['UEB']['PublicKey'] %>
751     uebSecretKey: <%= node['UEB']['SecretKey'] %>
752     
753     distributionNotifTopicName:  SDC-DISTR-NOTIF-TOPIC
754     distributionStatusTopicName: SDC-DISTR-STATUS-TOPIC
755     
756     initRetryIntervalSec: 5
757     initMaxIntervalSec: 60
758     
759     distribNotifServiceArtifactTypes:
760         info:
761             - MURANO-PKG
762     
763     distribNotifResourceArtifactTypes:
764         lifecycle:
765             - HEAT
766             - DG-XML
767     
768     environments:
769         - <%= node.chef_environment %>
770     
771     distributionStatusTopic:
772         pollingIntervalSec: 60
773         fetchTimeSec: 15
774         consumerGroup: sdc-<%= node.chef_environment %>
775         consumerId: sdc-<%= node.chef_environment %>1
776     
777     
778     distributionNotificationTopic:
779         minThreadPoolSize: 0
780         maxThreadPoolSize: 10
781         maxWaitingAfterSendingSeconds: 5
782     
783     createTopic:
784         partitionCount: 1
785         replicationCount: 1
786     
787     startDistributionEngine: true
788     
789     #This is false by default, since ONAP Dmaap currently doesn't support https
790     useHttpsWithDmaap: false
791
792
793 BE-onboarding-configuration.yaml
794 --------------------------------
795
796 ::
797
798     notifications:
799         pollingIntervalMsec: 2000
800         selectionSize: 100
801         beHost: <%= @catalog_ip %>
802         beHttpPort: <%= @catalog_port %>
803
804
805 BE-titan.properties
806 -------------------
807
808 ::
809
810     storage.backend=cassandra
811     storage.hostname=<%= @CASSANDRA_IP %>
812     storage.port=9160
813     storage.username=<%= @CASSANDRA_USR %>
814     storage.password=<%= @CASSANDRA_PWD %>
815     storage.connection-timeout=10000
816     storage.cassandra.keyspace=sdctitan
817     
818     storage.cassandra.ssl.enabled=false
819     storage.cassandra.ssl.truststore.location=/var/lib/jetty/config/.truststore
820     storage.cassandra.ssl.truststore.password=Aa123456
821     
822     cache.db-cache = false
823     cache.db-cache-clean-wait = 20
824     cache.db-cache-time = 180000
825     cache.db-cache-size = 0.5
826     
827     storage.cassandra.read-consistency-level=LOCAL_QUORUM
828     storage.cassandra.write-consistency-level=LOCAL_QUORUM
829     storage.cassandra.replication-strategy-class=org.apache.cassandra.locator.NetworkTopologyStrategy
830     storage.cassandra.replication-strategy-options=<%= @DC_NAME %>,<%= @rep_factor %>
831     storage.cassandra.astyanax.local-datacenter=<%= @DC_NAME %>
832     
833     storage.lock.retries=5
834     storage.lock.wait-time=500
835
836
837 Frontend Configuration
838 ======================
839
840 FE-configuration.yaml
841 ---------------------
842
843 ::
844
845     # Needed for logging purposes. To be populated by DevOps - currently dummy
846     feFqdn: <%= @fe_host_ip %>
847     
848     # catalog backend hostname
849     beHost: <%= @be_host_ip %>
850     
851     # catalog backend http port
852     beHttpPort: <%= @catalog_port %>
853     
854     # catalog backend http context
855     beContext: /sdc2/rest/v1/catalog/upload/resources
856     
857     # catalog backend protocol
858     beProtocol: http
859     
860     # catalog backend ssl port
861     beSslPort: <%= @ssl_port %>
862     
863     # threadpool size for handling requests
864     threadpoolSize: 50
865     
866     # request processing timeout (seconds)
867     requestTimeout: 10
868     
869     healthCheckSocketTimeoutInMs: 5000
870     
871     healthCheckIntervalInSeconds: 5
872     
873     onboarding:
874         protocol: http
875         host: <%= @fe_host_ip %>
876         port: 8181
877         healthCheckUri: "/onboarding/v1.0/healthcheck"
878     
879     identificationHeaderFields: 
880         -
881             - &HTTP_IV_USER HTTP_IV_USER
882             - &iv-user iv-user
883         -
884             - &USER_ID USER_ID
885             - &user-id user-id
886         -
887             - &HTTP_CSP_ATTUID HTTP_CSP_ATTUID
888             - &csp-attuid csp-attuid
889         -
890             - &HTTP_CSP_WSTYPE HTTP_CSP_WSTYPE
891             - &csp-wstype csp-wstype
892     
893     optionalHeaderFields:
894         -
895             - &HTTP_CSP_FIRSTNAME HTTP_CSP_FIRSTNAME
896             - &csp-firstname csp-firstname
897         -
898             - &HTTP_CSP_LASTNAME HTTP_CSP_LASTNAME
899             - &csp-lastname csp-lastname
900         -
901             - &HTTP_IV_REMOTE_ADDRESS HTTP_IV_REMOTE_ADDRESS
902             - &iv-remote-address iv-remote-address
903         -
904             - &HTTP_CSP_EMAIL HTTP_CSP_EMAIL
905             - &csp-email csp-email
906     
907     version: 1.0
908     released: 2012-11-30
909     
910     # Connection parameters
911     connection:
912         url: jdbc:mysql://localhost:3306/db
913         poolSize: 17
914     
915     # Protocols
916     protocols:
917         - http
918         - https
919     
920     
921     systemMonitoring:
922         enabled: false
923         isProxy: true
924         probeIntervalInSeconds: 15
925     
926     kibanaHost: localhost
927     kibanaPort: 5601
928     kibanaProtocol: http
929
930
931 FE-onboarding-configuration.yaml
932 --------------------------------
933
934 ::
935
936     notifications:
937         pollingIntervalMsec: 2000
938         selectionSize: 100
939         beHost: <%= @catalog_ip %>
940         beHttpPort: <%= @catalog_port %>