| Chengkai Yan | 7f278e3 | 2018-11-06 16:32:03 +0100 | [diff] [blame] | 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 | **datafile** configuration is controlled via a single JSON file called datafile_endpoints.json.
|
| 8 | This is located under datafile-app-server/config.
|
| 9 |
|
| TamasBakai | 67eccc9 | 2019-04-26 10:58:08 +0000 | [diff] [blame] | 10 | Compiling DFC
|
| 11 | =============
|
| 12 |
|
| 13 | Whole project (top level of DFC directory) and each module (sub module directory) can be compiled using
|
| 14 | `mvn clean install` command.
|
| 15 |
|
| 16 | Configuration file: Config/datafile_endpoints.json
|
| 17 |
|
| 18 |
|
| 19 |
|
| Chengkai Yan | 7f278e3 | 2018-11-06 16:32:03 +0100 | [diff] [blame] | 20 | JSON CONFIGURATION EXPLAINED
|
| 21 | ^^^^^^^^^^^^^^^^^^^^^^^^^^^^
|
| 22 |
|
| 23 | Variables 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.
|
| 24 |
|
| 25 | dmaapConsumerConfiguration
|
| 26 | """"""""""""""""""""""""""
|
| 27 |
|
| 28 | .. code-block:: json
|
| 29 |
|
| 30 | "dmaapHostName": <name of DMaaP/MR host>
|
| 31 | "dmaapPortNumber": <DMaaP/MR host port>
|
| 32 | "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT"
|
| 33 | "dmaapProtocol": "http"
|
| 34 | "dmaapUserName": ""
|
| 35 | "dmaapUserPassword": ""
|
| 36 | "dmaapContentType": "application/json"
|
| 37 | "consumerId": "C12"
|
| 38 | "consumerGroup": "OpenDcae-c12"
|
| 39 | "timeoutMS": -1
|
| 40 | "messageLimit": 1
|
| 41 |
|
| 42 | dmaapProducerConfiguration
|
| 43 | """"""""""""""""""""""""""
|
| 44 |
|
| 45 | .. code-block:: json
|
| 46 |
|
| 47 | "dmaapHostName": <name of DMaaP/DR host>
|
| 48 | "dmaapPortNumber": <DMaaP/DR host port>
|
| 49 | "dmaapTopicName": "publish"
|
| maximesson | e707b22 | 2019-05-09 14:27:34 +0000 | [diff] [blame^] | 50 | "dmaapProtocol": "https"
|
| Chengkai Yan | 7f278e3 | 2018-11-06 16:32:03 +0100 | [diff] [blame] | 51 | "dmaapUserName": "dradmin"
|
| 52 | "dmaapUserPassword": "dradmin"
|
| 53 | "dmaapContentType": "application/octet-stream"
|
| 54 |
|
| 55 | ftpesConfiguration
|
| 56 | """"""""""""""""""
|
| 57 |
|
| 58 | .. code-block:: json
|
| 59 |
|
| 60 | "keyCert": <path to DFC certificate>
|
| maximesson | c762eb1 | 2019-04-04 14:43:43 +0000 | [diff] [blame] | 61 | "keyPassword": <password for DFC certificate>
|
| 62 | "trustedCa": <path to xNF certificate>
|
| 63 | "trustedCaPassword": <password for xNF certificate>
|
| 64 |
|
| 65 | securityConfiguration
|
| 66 | """""""""""""""""""""
|
| 67 |
|
| 68 | .. code-block:: json
|
| 69 |
|
| 70 | "trustStorePath": <path to trust store>
|
| maximesson | e707b22 | 2019-05-09 14:27:34 +0000 | [diff] [blame^] | 71 | "trustStorePasswordPath": <path to trust store password>
|
| maximesson | c762eb1 | 2019-04-04 14:43:43 +0000 | [diff] [blame] | 72 | "keyStorePath": <path to key store>
|
| 73 | "keyStorePasswordPath": <path to key store password>
|
| 74 | "enableDmaapCertAuth": <boolean>. If false, all information above are ignored.
|
| 75 |
|
| Chengkai Yan | 7f278e3 | 2018-11-06 16:32:03 +0100 | [diff] [blame] | 76 |
|
| 77 |
|
| 78 | Sample JSON configuration
|
| 79 | """""""""""""""""""""""""
|
| 80 |
|
| 81 | The format of the JSON configuration that drives all behavior of DFC is probably best described using an example:
|
| 82 |
|
| 83 | .. code-block:: json
|
| 84 |
|
| 85 | {
|
| 86 | "configs": {
|
| 87 | "dmaap": {
|
| 88 | "dmaapConsumerConfiguration": {
|
| 89 | "dmaapHostName": "localhost",
|
| 90 | "dmaapPortNumber": 2222,
|
| 91 | "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT",
|
| 92 | "dmaapProtocol": "http",
|
| 93 | "dmaapUserName": "",
|
| 94 | "dmaapUserPassword": "",
|
| 95 | "dmaapContentType": "application/json",
|
| 96 | "consumerId": "C12",
|
| 97 | "consumerGroup": "OpenDcae-c12",
|
| 98 | "timeoutMS": -1,
|
| 99 | "messageLimit": 1
|
| 100 | },
|
| 101 | "dmaapProducerConfiguration": {
|
| 102 | "dmaapHostName": "localhost",
|
| 103 | "dmaapPortNumber": 3907,
|
| 104 | "dmaapTopicName": "publish",
|
| 105 | "dmaapProtocol": "https",
|
| 106 | "dmaapUserName": "dradmin",
|
| 107 | "dmaapUserPassword": "dradmin",
|
| 108 | "dmaapContentType": "application/octet-stream"
|
| 109 | }
|
| 110 | },
|
| 111 | "ftp": {
|
| maximesson | c762eb1 | 2019-04-04 14:43:43 +0000 | [diff] [blame] | 112 | "ftpesConfiguration": {
|
| 113 | "keyCert": "config/dfc.jks",
|
| 114 | "keyPassword": "secret",
|
| 115 | "trustedCa": "config/ftp.jks",
|
| 116 | "trustedCaPassword": "secret"
|
| 117 | }
|
| 118 | },
|
| 119 | "security": {
|
| 120 | "trustStorePath" : "change it",
|
| 121 | "trustStorePasswordPath" : "change it",
|
| 122 | "keyStorePath" : "change it",
|
| 123 | "keyStorePasswordPath" : "change it",
|
| 124 | "enableDmaapCertAuth" : "false"
|
| Chengkai Yan | 7f278e3 | 2018-11-06 16:32:03 +0100 | [diff] [blame] | 125 | }
|
| Chengkai Yan | 7f278e3 | 2018-11-06 16:32:03 +0100 | [diff] [blame] | 126 | }
|
| 127 | }
|