docs/sections/services/dfc/installation-helm.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3 .. _dfc-installation-helm:
   4
   5 DataFile Collector Helm Installation
   6 ====================================
   7
   8 DataFile Collector is a microservice that can be installed via Helm.
   9 The chart files are hosted in `OOM <https://gerrit.onap.org/r/gitweb?p=oom.git;a=tree;f=kubernetes/dcaegen2-services/components/dcae-datafile-collector>`_ repository.
  10
  11     Example command:
  12
  13 .. code-block:: bash
  14
  15         helm -n onap install dev-dcaegen2-datafile-collector -f <custom values filename> --set global.centralizedLoggingEnabled=false dcaegen2-services/components/dcae-datafile-collector/
  16
  17
  18 Dependencies
  19 ^^^^^^^^^^^^
  20
  21 List of services which should be running prior PM-Mapper installation:
  22
  23     - DMaaP Message Router
  24     - DMaaP Data Router
  25     - DMaaP Bus Controller post install jobs should have completed successfully (executed as part of an OOM install).
  26
  27 Configuration
  28 ^^^^^^^^^^^^^
  29
  30 DataFile uses SDK's Config Binding Service client for configuration application.
  31 Consul is not needed anymore. It is used as a second choice source of configuration (if the default one is unavailable).
  32 By default, a ConfigMap is used to load the configuration.
  33
  34 The location of the configuration file should be set in ``CBS_CLIENT_CONFIG_PATH`` env, for example:
  35
  36     ``CBS_CLIENT_CONFIG_PATH: /app-config-input/application_config.yaml``
  37
  38 Example yaml file with DataFile Collector configuration:
  39
  40 .. code-block:: yaml
  41
  42     dmaap.certificateConfig.keyCert: /opt/app/datafile/etc/cert/cert.p12
  43     dmaap.certificateConfig.keyPasswordPath: /opt/app/datafile/etc/cert/p12.pass
  44     dmaap.certificateConfig.trustedCa: /opt/app/datafile/etc/cert/trust.jks
  45     dmaap.certificateConfig.trustedCaPasswordPath: /opt/app/datafile/etc/cert/trust.pass
  46     dmaap.certificateConfig.enableCertAuth: true
  47     dmaap.dmaapConsumerConfiguration.consumerGroup: OpenDcae-c12
  48     dmaap.dmaapConsumerConfiguration.consumerId: C12
  49     dmaap.dmaapConsumerConfiguration.timeoutMs: -1
  50     dmaap.security.enableDmaapCertAuth: true
  51     dmaap.security.keyStorePasswordPath: /opt/app/datafile/etc/cert/jks.pass
  52     dmaap.security.keyStorePath: /opt/app/datafile/etc/cert/cert.jks
  53     dmaap.security.trustStorePasswordPath: /opt/app/datafile/etc/cert/trust.pass
  54     dmaap.security.trustStorePath: /opt/app/datafile/etc/cert/trust.jks
  55     service_calls: []
  56     sftp.security.strictHostKeyChecking: true
  57     streams_publishes:
  58       PM_MEAS_FILES:
  59         dmaap_info:
  60           location: loc00
  61           log_url: ${DR_LOG_URL_0}
  62           password: ${DR_PASSWORD}
  63           publish_url: ${DR_FILES_PUBLISHER_URL_0}
  64           publisher_id: ${DR_FILES_PUBLISHER_ID_0}
  65           username: ${DR_USERNAME}
  66         type: data_router
  67     streams_subscribes:
  68       dmaap_subscriber:
  69         dmaap_info:
  70           topic_url: https://message-router:3905/events/unauthenticated.VES_NOTIFICATION_OUTPUT
  71         type: message_router
  72
  73
  74 More information about properties could be found in configuration section, see :ref:`dfc_configuration`.