blob: d57a85f10b2702f430b290870675495c28dc1b15 [file] [log] [blame]
Chengkai Yan7f278e32018-11-06 16:32:03 +01001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Configuration
5=============
6
7**datafile** configuration is controlled via a single JSON file called datafile_endpoints.json.
8This is located under datafile-app-server/config.
9
10JSON CONFIGURATION EXPLAINED
11^^^^^^^^^^^^^^^^^^^^^^^^^^^^
12
13Variables of interest (e.g. variables that should be inspected/modifed for a specific runtime environment) are listed below for convenience. The entire file is provided later in this page for reference.
14
15dmaapConsumerConfiguration
16""""""""""""""""""""""""""
17
18.. code-block:: json
19
20 "dmaapHostName": <name of DMaaP/MR host>
21 "dmaapPortNumber": <DMaaP/MR host port>
22 "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT"
23 "dmaapProtocol": "http"
24 "dmaapUserName": ""
25 "dmaapUserPassword": ""
26 "dmaapContentType": "application/json"
27 "consumerId": "C12"
28 "consumerGroup": "OpenDcae-c12"
29 "timeoutMS": -1
30 "messageLimit": 1
31
32dmaapProducerConfiguration
33""""""""""""""""""""""""""
34
35.. code-block:: json
36
37 "dmaapHostName": <name of DMaaP/DR host>
38 "dmaapPortNumber": <DMaaP/DR host port>
39 "dmaapTopicName": "publish"
40 "dmaapProtocol": "httpa"
41 "dmaapUserName": "dradmin"
42 "dmaapUserPassword": "dradmin"
43 "dmaapContentType": "application/octet-stream"
44
45ftpesConfiguration
46""""""""""""""""""
47
48.. code-block:: json
49
50 "keyCert": <path to DFC certificate>
51 "keyPassword": <pssword for DFC certificate>
52 "trustedCA": <path to xNF certificate>
53 "trustedCAPassword": <password for xNF certificate>
54
55
56Sample JSON configuration
57"""""""""""""""""""""""""
58
59The format of the JSON configuration that drives all behavior of DFC is probably best described using an example:
60
61.. code-block:: json
62
63 {
64 "configs": {
65 "dmaap": {
66 "dmaapConsumerConfiguration": {
67 "dmaapHostName": "localhost",
68 "dmaapPortNumber": 2222,
69 "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT",
70 "dmaapProtocol": "http",
71 "dmaapUserName": "",
72 "dmaapUserPassword": "",
73 "dmaapContentType": "application/json",
74 "consumerId": "C12",
75 "consumerGroup": "OpenDcae-c12",
76 "timeoutMS": -1,
77 "messageLimit": 1
78 },
79 "dmaapProducerConfiguration": {
80 "dmaapHostName": "localhost",
81 "dmaapPortNumber": 3907,
82 "dmaapTopicName": "publish",
83 "dmaapProtocol": "https",
84 "dmaapUserName": "dradmin",
85 "dmaapUserPassword": "dradmin",
86 "dmaapContentType": "application/octet-stream"
87 }
88 },
89 "ftp": {
90 "ftpesConfiguration": {
91 "keyCert": "config/ftpKey.jks",
92 "keyPassword": "secret",
93 "trustedCA": "config/cacerts",
94 "trustedCAPassword": "secret"
95 }
96 }
97 }
98 }