clean up some sphinx warnings
[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     {
12       "collector.dynamic.config.update.frequency": "5",
13       "event.transform.flag": "0",
14       "collector.schema.checkflag": "1",
15       "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",
16       "collector.service.port": "8080",
17       "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\"}",
18       "collector.keystore.passwordfile": "/opt/app/VESCollector/etc/passwordfile",
19       "streams_publishes": {
20         "ves-measurement": {
21           "type": "message_router",
22           "dmaap_info": {
23             "topic_url": "http://message-router:3904/events/unauthenticated.VES_MEASUREMENT_OUTPUT/"
24           }
25         },
26         "ves-fault": {
27           "type": "message_router",
28           "dmaap_info": {
29             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_FAULT_OUTPUT/"
30           }
31         },
32         "ves-pnfRegistration": {
33           "type": "message_router",
34           "dmaap_info": {
35             "topic_url": "http://message-router:3904/events/unauthenticated.VES_PNFREG_OUTPUT/"
36           }
37         },
38         "ves-other": {
39           "type": "message_router",
40           "dmaap_info": {
41             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_OTHER_OUTPUT/"
42           }
43         },
44         "ves-heartbeat": {
45           "type": "message_router",
46           "dmaap_info": {
47             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_HEARTBEAT_OUTPUT/"
48           }
49         },
50         "ves-notification": {
51           "type": "message_router",
52           "dmaap_info": {
53             "topic_url": "http://message-router:3904/events/unauthenticated.VES_NOTIFICATION_OUTPUT/"
54           }
55         },
56         "ves-3gpp-fault-supervision": {
57           "type": "message_router",
58           "dmaap_info": {
59             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_FAULTSUPERVISION_OUTPUT/"
60           }
61         },
62         "ves-3gpp-provisioning": {
63           "type": "message_router",
64           "dmaap_info": {
65             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_PROVISIONING_OUTPUT/"
66           }
67         },
68         "ves-3gpp-heartbeat": {
69           "type": "message_router",
70           "dmaap_info": {
71             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_HEARTBEAT_OUTPUT/"
72           }
73         },
74         "ves-3gpp-performance-assurance": {
75           "type": "message_router",
76           "dmaap_info": {
77             "topic_url": "http://message-router:3904/events/unauthenticated.SEC_3GPP_PERFORMANCEASSURANCE_OUTPUT/"
78           }
79         }
80       },
81       "collector.externalSchema.checkflag": 1,
82       "collector.externalSchema.schemasLocation": "./etc/externalRepo",
83       "collector.externalSchema.mappingFileLocation": "./etc/externalRepo/schema-map.json",
84       "event.externalSchema.schemaRefPath": "/event/stndDefinedFields/schemaReference",
85       "event.externalSchema.stndDefinedDataPath": "/event/stndDefinedFields/data",
86       "collector.service.secure.port": "8443",
87       "auth.method": "noAuth",
88       "collector.keystore.file.location": "/opt/app/VESCollector/etc/keystore",
89       "services_calls": [],
90       "header.authlist": "sample1,$2a$10$0buh.2WeYwN868YMwnNNEuNEAMNYVU9.FSMJGyIKV3dGET/7oGOi6"
91     }
92
93 During ONAP OOM/Kubernetes deployment this configuration is created from VES Cloudify blueprint.