blob: 555290612175177b13c3363ce44bcb834fe58c0c (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
|
.. This work is licensed under a Creative Commons Attribution 4.0 International License.
.. http://creativecommons.org/licenses/by/4.0
.. _deployment:
Deployment
============
To run HV-VES Collector container, you need to specify required parameters by passing them as command
line arguments either by using long form (--long-form) or short form (-s) followed by argument if needed.
All parameters can also be configured by specifying environment variables. These variables have to be named after command line option name
rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix, for example `VESHV_LISTEN_PORT`.
Command line options have precedence over environment variables.
+-------------+------------+-------------------+----------+-----+-------------------------------------------------+
| Long form | Short form | Env form | Required | Arg | Description |
+=============+============+===================+==========+=====+=================================================+
| listen-port | p | VESHV_LISTEN_PORT | yes | yes | Port on which HV-VES listens internally |
+-------------+------------+-------------------+----------+-----+-------------------------------------------------+
| config-url | c | VESHV_CONFIG_URL | yes | yes | URL of HV-VES configuration on Consul service |
+-------------+------------+-------------------+----------+-----+-------------------------------------------------+
HV-VES requires also to specify if SSL should be used when handling incoming TCP connections.
This can be done by passing the flag below to the command line.
+-------------+------------+-------------------+----------+-----+-------------------------------------------------+
| Long form | Short form | Env form | Required | Arg | Description |
+=============+============+===================+==========+=====+=================================================+
| ssl-disable | l | VESHV_SSL_DISABLE | no | no | Disables SSL encryption |
+-------------+------------+-------------------+----------+-----+-------------------------------------------------+
Minimal command for running the container:
.. code-block:: bash
docker run nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.hv-ves.hv-collector-main --listen-port 6061 --config-url http://consul:8500/v1/kv/dcae-hv-ves-collector --ssl-disable
Optional configuration parameters:
+-----------------------+------------+----------------------------+----------+-----+-----------------+-------------------------------------------------------+
| Long form | Short form | Env form | Required | Arg | Default | Description |
+=======================+============+============================+==========+=====+=================+=======================================================+
| health-check-api-port | H | VESHV_HEALTHCHECK_API_PORT | no | yes | 6060 | Health check REST API listen port |
+-----------------------+------------+----------------------------+----------+-----+-----------------+-------------------------------------------------------+
| first-request-delay | d | VESHV_FIRST_REQUEST_DELAY | no | yes | 10 | Delay of first request to Consul service in seconds |
+-----------------------+------------+----------------------------+----------+-----+-----------------+-------------------------------------------------------+
| request-interval | I | VESHV_REQUEST_INTERVAL | no | yes | 5 | Interval of Consul configuration requests in seconds |
+-----------------------+------------+----------------------------+----------+-----+-----------------+-------------------------------------------------------+
| idle-timeout-sec | i | VESHV_IDLE_TIMEOUT_SEC | no | yes | 60 | Idle timeout for remote hosts. After given time |
| | | | | | | without any data exchange, the connection |
| | | | | | | might be closed. |
+-----------------------+------------+----------------------------+----------+-----+-----------------+-------------------------------------------------------+
| max-payload-size | m | VESHV_MAX_PAYLOAD_SIZE | no | yes | 1048576 (1 MiB) | Maximum supported payload size in bytes |
+-----------------------+------------+----------------------------+----------+-----+-----------------+-------------------------------------------------------+
As part of experimental API if you do not specify `ssl-disable` flag, there is need to specify additional
parameters for security configuration.
+-----------------------+------------+----------------------------+----------+-----+------------------------+--------------------------------------------------------------+
| Long form | Short form | Env form | Required | Arg | Default | Description |
+=======================+============+============================+==========+=====+========================+==============================================================+
| key-store | k | VESHV_KEY_STORE | no | yes | /etc/ves-hv/server.p12 | Key store in PKCS12 format path |
+-----------------------+------------+----------------------------+----------+-----+------------------------+--------------------------------------------------------------+
| key-store-password | kp | VESHV_KEY_STORE_PASSWORD | no | yes | | Key store password |
+-----------------------+------------+----------------------------+----------+-----+------------------------+--------------------------------------------------------------+
| trust-store | t | VESHV_TRUST_STORE | no | yes | /etc/ves-hv/trust.p12 | File with trusted certificate bundle in PKCS12 format path |
+-----------------------+------------+----------------------------+----------+-----+------------------------+--------------------------------------------------------------+
| trust-store-password | tp | VESHV_TRUST_STORE_PASSWORD | no | yes | | Trust store password |
+-----------------------+------------+----------------------------+----------+-----+------------------------+--------------------------------------------------------------+
Passwords are mandatory without ssl-disable flag. If key-store or trust-store location is not specified, HV-VES will try to read them from default locations.
These parameters can be configured either by passing command line option during `docker run` call or
by specifying environment variables named after command line option name
rewritten using `UPPER_SNAKE_CASE` and prepended with `VESHV_` prefix e.g. `VESHV_LISTEN_PORT`.
Healthcheck
===========
Inside HV-VES docker container runs small http service for healthcheck - exact port for this service can be configured
at deployment using `--health-check-api-port` command line option.
This service exposes single endpoint **GET /health/ready** which returns **HTTP 200 OK** in case HV-VES is healthy
and ready for connections. Otherwise it returns **HTTP 503 Service Unavailable** with short reason of unhealthiness.
|
