docs/sections/services/dfc/configuration.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.\r
   2 .. http://creativecommons.org/licenses/by/4.0\r
   3 \r
   4 Configuration\r
   5 =============\r
   6 \r
   7 **datafile** configuration is controlled via a single JSON file called datafile_endpoints.json.\r
   8 This is located under datafile-app-server/config.\r
   9 \r
  10 JSON CONFIGURATION EXPLAINED\r
  11 ^^^^^^^^^^^^^^^^^^^^^^^^^^^^\r
  12 \r
  13 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.\r
  14 \r
  15 dmaapConsumerConfiguration\r
  16 """"""""""""""""""""""""""\r
  17 \r
  18 .. code-block:: json\r
  19 \r
  20   "dmaapHostName": <name of DMaaP/MR host>\r
  21   "dmaapPortNumber": <DMaaP/MR host port>\r
  22   "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT"\r
  23   "dmaapProtocol": "http"\r
  24   "dmaapUserName": ""\r
  25   "dmaapUserPassword": ""\r
  26   "dmaapContentType": "application/json"\r
  27   "consumerId": "C12"\r
  28   "consumerGroup": "OpenDcae-c12"\r
  29   "timeoutMS": -1\r
  30   "messageLimit": 1\r
  31 \r
  32 dmaapProducerConfiguration\r
  33 """"""""""""""""""""""""""\r
  34 \r
  35 .. code-block:: json\r
  36 \r
  37   "dmaapHostName": <name of DMaaP/DR host>\r
  38   "dmaapPortNumber": <DMaaP/DR host port>\r
  39   "dmaapTopicName": "publish"\r
  40   "dmaapProtocol": "httpa"\r
  41   "dmaapUserName": "dradmin"\r
  42   "dmaapUserPassword": "dradmin"\r
  43   "dmaapContentType": "application/octet-stream"\r
  44 \r
  45 ftpesConfiguration\r
  46 """"""""""""""""""\r
  47 \r
  48 .. code-block:: json\r
  49 \r
  50   "keyCert": <path to DFC certificate>\r
  51   "keyPassword": <password for DFC certificate>\r
  52   "trustedCa": <path to xNF certificate>\r
  53   "trustedCaPassword": <password for xNF certificate>\r
  54 \r
  55 securityConfiguration\r
  56 """""""""""""""""""""\r
  57 \r
  58 .. code-block:: json\r
  59 \r
  60   "trustStorePath": <path to trust store>\r
  61   "trustStorePasswordPath": <path to trsust store password>\r
  62   "keyStorePath": <path to key store>\r
  63   "keyStorePasswordPath": <path to key store password>\r
  64   "enableDmaapCertAuth": <boolean>. If false, all information above are ignored.\r
  65 \r
  66 \r
  67 \r
  68 Sample JSON configuration\r
  69 """""""""""""""""""""""""\r
  70 \r
  71 The format of the JSON configuration that drives all behavior of DFC is probably best described using an example:\r
  72 \r
  73 .. code-block:: json\r
  74 \r
  75   {\r
  76     "configs": {\r
  77       "dmaap": {\r
  78         "dmaapConsumerConfiguration": {\r
  79           "dmaapHostName": "localhost",\r
  80           "dmaapPortNumber": 2222,\r
  81           "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT",\r
  82           "dmaapProtocol": "http",\r
  83           "dmaapUserName": "",\r
  84           "dmaapUserPassword": "",\r
  85           "dmaapContentType": "application/json",\r
  86           "consumerId": "C12",\r
  87           "consumerGroup": "OpenDcae-c12",\r
  88           "timeoutMS": -1,\r
  89           "messageLimit": 1\r
  90         },\r
  91         "dmaapProducerConfiguration": {\r
  92           "dmaapHostName": "localhost",\r
  93           "dmaapPortNumber": 3907,\r
  94           "dmaapTopicName": "publish",\r
  95           "dmaapProtocol": "https",\r
  96           "dmaapUserName": "dradmin",\r
  97           "dmaapUserPassword": "dradmin",\r
  98           "dmaapContentType": "application/octet-stream"\r
  99         }\r
 100       },\r
 101       "ftp": {\r
 102             "ftpesConfiguration": {\r
 103                 "keyCert": "config/dfc.jks",\r
 104                 "keyPassword": "secret",\r
 105                 "trustedCa": "config/ftp.jks",\r
 106                 "trustedCaPassword": "secret"\r
 107             }\r
 108       },\r
 109         "security": {\r
 110             "trustStorePath" : "change it",\r
 111             "trustStorePasswordPath" : "change it",\r
 112             "keyStorePath" : "change it",\r
 113             "keyStorePasswordPath" : "change it",\r
 114             "enableDmaapCertAuth" : "false"\r
 115         }\r
 116     }\r
 117   }\r