update link to upper-constraints.txt
[dcaegen2.git] / docs / sections / services / ves-http / 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 Configuration
5 =============
6
7 VES expects to be able to fetch configuration directly from consul service in following JSON format:
8
9 .. code-block:: json
10     {
11       "collector.dynamic.config.update.frequency": "5",
12       "event.transform.flag": "0",
13       "collector.schema.checkflag": "1",
14       "collector.dmaap.streamid": "fault=ves-fault|syslog=ves-syslog|heartbeat=ves-heartbeat|measurementsForVfScaling=ves-measurement|mobileFlow=ves-mobileflow|other=ves-other|stateChange=ves-statechange|thresholdCrossingAlert=ves-thresholdCrossingAlert|voiceQuality=ves-voicequality|sipSignaling=ves-sipsignaling|notification=ves-notification|pnfRegistration=ves-pnfRegistration|3GPP-FaultSupervision=ves-3gpp-fault-supervision|3GPP-Heartbeat=ves-3gpp-heartbeat|3GPP-Provisioning=ves-3gpp-provisioning|3GPP-PerformanceAssurance=ves-3gpp-performance-assurance",
15       "collector.service.port": "8080",
16       "collector.schema.file": "{\"v1\":\"./etc/CommonEventFormat_27.2.json\",\"v2\":\"./etc/CommonEventFormat_27.2.json\",\"v3\":\"./etc/CommonEventFormat_27.2.json\",\"v4\":\"./etc/CommonEventFormat_27.2.json\",\"v5\":\"./etc/CommonEventFormat_28.4.1.json\",\"v7\":\"./etc/CommonEventFormat_30.2_ONAP.json\"}",
17       "collector.keystore.passwordfile": "/opt/app/VESCollector/etc/passwordfile",
18       "streams_publishes": {
19         "ves-measurement": {
20           "type": "message_router",
21           "dmaap_info": {
22             "topic_url": "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/"
23           }
24         },
25         "ves-fault": {
26           "type": "message_router",
27           "dmaap_info": {
28             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT/"
29           }
30         },
31         "ves-pnfRegistration": {
32           "type": "message_router",
33           "dmaap_info": {
34             "topic_url": "http://message-router:3904/events/unauthenticated.VES_PNFREG_OUTPUT/"
35           }
36         },
37         "ves-other": {
38           "type": "message_router",
39           "dmaap_info": {
40             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/"
41           }
42         },
43         "ves-heartbeat": {
44           "type": "message_router",
45           "dmaap_info": {
46             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_HEARTBEAT_OUTPUT/"
47           }
48         },
49         "ves-notification": {
50           "type": "message_router",
51           "dmaap_info": {
52             "topic_url": "http://message-router:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT/"
53           }
54         },
55         "ves-3gpp-fault-supervision": {
56           "type": "message_router",
57           "dmaap_info": {
58             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_FAULTSUPERVISION_OUTPUT/"
59           }
60         },
61         "ves-3gpp-provisioning": {
62           "type": "message_router",
63           "dmaap_info": {
64             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_PROVISIONING_OUTPUT/"
65           }
66         },
67         "ves-3gpp-heartbeat": {
68           "type": "message_router",
69           "dmaap_info": {
70             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_HEARTBEAT_OUTPUT/"
71           }
72         },
73         "ves-3gpp-performance-assurance": {
74           "type": "message_router",
75           "dmaap_info": {
76             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_PERFORMANCEASSURANCE_OUTPUT/"
77           }
78         }
79       },
80       "collector.externalSchema.checkflag": 1,
81       "collector.externalSchema.schemasLocation": "./etc/externalRepo",
82       "collector.externalSchema.mappingFileLocation": "./etc/externalRepo/schema-map.json",
83       "event.externalSchema.schemaRefPath": "/event/stndDefinedFields/schemaReference",
84       "event.externalSchema.stndDefinedDataPath": "/event/stndDefinedFields/data",
85       "collector.service.secure.port": "8443",
86       "auth.method": "noAuth",
87       "collector.keystore.file.location": "/opt/app/VESCollector/etc/keystore",
88       "services_calls": [],
89       "header.authlist": "sample1,$2a$10$0buh.2WeYwN868YMwnNNEuNEAMNYVU9.FSMJGyIKV3dGET/7oGOi6"
90     }
91
92 During ONAP OOM/Kubernetes deployment this configuration is created from VES Cloudify blueprint.