1 .. This work is licensed under a Creative Commons Attribution 4.0 International License.
2 .. http://creativecommons.org/licenses/by/4.0
9 To run HV-VES Collector container you need to specify required command line options and environment variables.
11 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 Command line options have precedence over environment variables in cases when both are present.
15 Currently HV-VES requires single command line parameter which points to base configuration file.
20 :header: Long form , Short form , Arg , Env form , Description
22 configuration-file ; c ; yes ; VESHV_CONFIGURATION_FILE ; Path to JSON file containing HV-VES configuration
24 Environment variables that are required by HV-VES are used by collector for provisioning of run-time configuration and are provided by DCAE platform.
29 :header: Environment variable name , Description
31 CONSUL_HOST ; Hostname under which Consul service is available
32 CONFIG_BINDING_SERVICE ; Hostname under which Config Binding Service is available
33 HOSTNAME ; Configuration key of HV-VES as seen by CBS, usually *dcae-hv-ves-collector*
35 There is also optional command line parameter which configures container-internal port for Healthcheck Server API (see :ref:`healthcheck_and_monitoring`).
40 :header: Long form , Short form , Arg , Env form , Description
42 health-check-api-port ; H ; yes ; VESHV_HEALTH_CHECK_API_PORT ; Health check rest api listen port
44 .. _configuration_file:
49 File must provide base configuration for HV-VES Collector in JSON format.
51 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 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 .. literalinclude:: resources/base-configuration.json
59 The configuration is split into smaller sections.
60 Tables show restrictions on fields in file configuration and short description.
68 Key ; Value type ; Description
69 server.listenPort ; number ; Port on which HV-VES listens internally
70 server.idleTimeoutSec ; number ; Idle timeout for remote hosts. After given time without any data exchange, the connection is closed
77 Config Binding Service
78 Key ; Value type ; Description
79 cbs.firstRequestDelaySec ; number ; Delay of first request to Config Binding Service in seconds
80 cbs.requestIntervalSec ; number ; Interval of configuration requests in seconds
88 Key ; Value type ; Description
89 security.sslDisable ; boolean ; Disables SSL encryption
90 security.keys.keyStoreFile ; String ; Key store path used in HV-VES incoming connections
91 security.keys.keyStorePasswordFile ; String ; Key store password file used in HV-VES incoming connections
92 security.keys.trustStoreFile ; String ; Path to file with trusted certificates bundle used in HV-VES incoming connections
93 security.keys.trustStorePasswordFile ; String ; Trust store password file used in HV-VES incoming connections
95 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 as it was set to `false`.
103 Key ; Value type ; Description
104 logLevel ; String ; Log level on which HV-VES publishes all log messages. Valid argument values are (case insensitive): ERROR, WARN, INFO, DEBUG, TRACE.
110 Kubernetes command line tool (`kubectl`) is recommended for manual horizontal scaling of HV-VES Collector.
112 To scale HV-VES deployment you need to determine its name and namespace in which it is deployed.
113 For default OOM deployment, HV-VES full deployment name is `deployment/dep-dcae-hv-ves-collector` and it is installed under `onap` namespace.
115 1. If the namespace is unknown, execute the following command to determine possible namespaces.
119 kubectl get namespaces
121 2. Find desired deployment (in case of huge output you can try final call in combination with `grep hv-ves` command).
122 You can also see current replicas amount under a corresponding column.
127 kubectl get --namespace ${ONAP_NAMESPACE} deployment
129 3. To scale deployment, execute the following commands:
133 DEPLOYMENT_NAME=deployment/dep-dcae-hv-ves-collector
134 DESIRED_REPLICAS_AMOUNT=5
135 kubectl scale --namespace ${ONAP_NAMESPACE} ${DEPLOYMENT_NAME} --replicas=${DESIRED_REPLICAS_AMOUNT}
141 kubectl get pods --namespace ${ONAP_NAMESPACE} --selector app=dcae-hv-ves-collector