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": <pssword for DFC certificate>\r
  52   "trustedCA": <path to xNF certificate>\r
  53   "trustedCAPassword": <password for xNF certificate>\r
  54 \r
  55 \r
  56 Sample JSON configuration\r
  57 """""""""""""""""""""""""\r
  58 \r
  59 The format of the JSON configuration that drives all behavior of DFC is probably best described using an example:\r
  60 \r
  61 .. code-block:: json\r
  62 \r
  63   {\r
  64     "configs": {\r
  65       "dmaap": {\r
  66         "dmaapConsumerConfiguration": {\r
  67           "dmaapHostName": "localhost",\r
  68           "dmaapPortNumber": 2222,\r
  69           "dmaapTopicName": "/events/unauthenticated.VES_NOTIFICATION_OUTPUT",\r
  70           "dmaapProtocol": "http",\r
  71           "dmaapUserName": "",\r
  72           "dmaapUserPassword": "",\r
  73           "dmaapContentType": "application/json",\r
  74           "consumerId": "C12",\r
  75           "consumerGroup": "OpenDcae-c12",\r
  76           "timeoutMS": -1,\r
  77           "messageLimit": 1\r
  78         },\r
  79         "dmaapProducerConfiguration": {\r
  80           "dmaapHostName": "localhost",\r
  81           "dmaapPortNumber": 3907,\r
  82           "dmaapTopicName": "publish",\r
  83           "dmaapProtocol": "https",\r
  84           "dmaapUserName": "dradmin",\r
  85           "dmaapUserPassword": "dradmin",\r
  86           "dmaapContentType": "application/octet-stream"\r
  87         }\r
  88       },\r
  89       "ftp": {\r
  90         "ftpesConfiguration": {\r
  91           "keyCert": "config/ftpKey.jks",\r
  92           "keyPassword": "secret",\r
  93           "trustedCA": "config/cacerts",\r
  94           "trustedCAPassword": "secret"\r
  95         }\r
  96       }\r
  97     }\r
  98   }\r