docs/sections/services/ves-hv/deployment.rst

   1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
   2 .. http://creativecommons.org/licenses/by/4.0
   3
   4
   5 .. _deployment:
   6
   7 Deployment
   8 ============
   9
  10 To run HV-VES Collector container you need to specify required command line options and environment variables.
  11
  12 Command line parameters can be specified either by using long form (--long-form) or short form (-s) followed by argument if needed (see `Arg` column in table below). These parameters can be omitted if corresponding environment variables are set. These variables are named after command line option name rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix, for example `VESHV_CONFIGURATION_FILE`.
  13
  14 Command line options have precedence over environment variables in cases when both are present.
  15
  16 Currently HV-VES requires single command line parameter which points to base configuration file.
  17
  18 .. csv-table::
  19     :widths: auto
  20     :delim: ;
  21     :header: Long form , Short form , Arg , Env form , Description
  22
  23     configuration-file ; c ; yes ; VESHV_CONFIGURATION_FILE  ; Path to JSON file containing HV-VES configuration
  24
  25 Environment variables that are required by HV-VES are used by collector for provisioning of run-time configuration and are usually provided by DCAE platform.
  26
  27 .. csv-table::
  28     :widths: auto
  29     :delim: ;
  30     :header: Environment variable name , Description
  31
  32     CONSUL_HOST            ; Hostname under which Consul service is available
  33     CONFIG_BINDING_SERVICE ; Hostname under which Config Binding Service is available
  34     HOSTNAME               ; Configuration key of HV-VES as seen by CBS, usually *dcae-hv-ves-collector*
  35
  36 There is also optional command line parameter which configures container-internal port for Healthcheck Server API (see :ref:`healthcheck_and_monitoring`).
  37
  38 .. csv-table::
  39     :widths: auto
  40     :delim: ;
  41     :header: Long form , Short form , Arg , Env form , Description
  42
  43     health-check-api-port ; H ; yes ; VESHV_HEALTH_CHECK_API_PORT  ; Health check rest api listen port
  44
  45 .. _configuration_file:
  46
  47 Configuration file
  48 ------------------
  49
  50 File must provide base configuration for HV-VES Collector in JSON format.
  51
  52 Some entries in configuration can also be obtained from Config Binding Service (see :ref:`run_time_configuration`). **Every entry defined in configuration file will be OVERRIDEN if it is also present in run-time configuration.**
  53
  54 Following JSON shows every possible configuration option. Default file shipped with HV-VES container can be found in the collector's repository (see :ref:`repositories`).
  55
  56 .. literalinclude:: resources/base-configuration.json
  57     :language: json
  58
  59
  60 The configuration is split into smaller sections.
  61 Tables show restrictions on fields in file configuration and short description.
  62
  63 .. csv-table::
  64     :widths: auto
  65     :delim: ;
  66     :header-rows: 2
  67
  68     Server
  69     Key                         ; Value type ; Description
  70     server.listenPort           ; number     ; Port on which HV-VES listens internally
  71     server.idleTimeoutSec       ; number     ; Idle timeout for remote hosts. After given time without any data exchange, the connection might be closed
  72
  73 .. csv-table::
  74     :widths: auto
  75     :delim: ;
  76     :header-rows: 2
  77
  78     Config Binding Service
  79     Key                      ; Value type ; Description
  80     cbs.firstRequestDelaySec ; number     ; Delay of first request to Config Binding Service in seconds
  81     cbs.requestIntervalSec   ; number     ; Interval of configuration requests in seconds
  82
  83 .. csv-table::
  84     :widths: auto
  85     :delim: ;
  86     :header-rows: 2
  87
  88     Security
  89     Key                                   ; Value type ; Description
  90     security.sslDisable                   ; boolean    ; Disables SSL encryption
  91     security.keys.keyStoreFile            ; String     ; Key store path used in HV-VES incoming connections
  92     security.keys.keyStorePasswordFile    ; String     ; Key store password file used in HV-VES incoming connections
  93     security.keys.trustStoreFile          ; String     ; Path to file with trusted certificates bundle used in HV-VES incoming connections
  94     security.keys.trustStorePasswordFile  ; String     ; Trust store password file used in HV-VES incoming connections
  95
  96 All security entries are mandatory with `security.sslDisable` set to `false`. Otherwise only `security.sslDisable` needs to be specified. If `security.sslDisable` flag is missing, then it is  interpreted same as it would be set to `false`.
  97
  98 .. csv-table::
  99     :widths: auto
 100     :delim: ;
 101     :header-rows: 2
 102
 103     Uncategorized
 104     Key                  ; Value type ; Description
 105     logLevel             ; String     ; Log level on which HV-VES publishes all log messages. Valid argument values are (case insensitive): ERROR, WARN, INFO, DEBUG, TRACE.
 106
 107
 108 Horizontal Scaling
 109 ------------------
 110
 111 Kubernetes command line tool (`kubectl`) is recommended for manual horizontal scaling of HV-VES Collector.
 112
 113 To scale HV-VES deployment you need to determine its name and namespace in which it is deployed.
 114 For default OOM deployment, HV-VES full deployment name is `deployment/dep-dcae-hv-ves-collector` and it is installed under `onap` namespace.
 115
 116 1. If the namespace is unknown, execute the following command to determine possible namespaces.
 117
 118 .. code-block:: bash
 119
 120     kubectl get namespaces
 121
 122 2. Find desired deployment (in case of huge output you can try final call in combination with `grep hv-ves` command).
 123 You can also see current replicas amount under a corresponding column.
 124
 125 .. code-block:: bash
 126
 127     ONAP_NAMESPACE=onap
 128     kubectl get --namespace ${ONAP_NAMESPACE} deployment
 129
 130 3. To scale deployment execute:
 131
 132 .. code-block:: bash
 133
 134     DEPLOYMENT_NAME=deployment/dep-dcae-hv-ves-collector
 135     DESIRED_REPLICAS_AMOUNT=5
 136     kubectl scale --namespace ${ONAP_NAMESPACE} ${DEPLOYMENT_NAME} --replicas=${DESIRED_REPLICAS_AMOUNT}
 137
 138 Result:
 139
 140 .. code-block:: bash
 141
 142     kubectl get pods --namespace ${ONAP_NAMESPACE} --selector app=dcae-hv-ves-collector