diff options
author | Filip Krzywka <filip.krzywka@nokia.com> | 2018-09-25 10:57:17 +0200 |
---|---|---|
committer | Filip Krzywka <filip.krzywka@nokia.com> | 2018-10-01 09:42:08 +0200 |
commit | 4bb79b722985784e650243248e7450e279485fa9 (patch) | |
tree | 6fc5980f98c66d6a2467d872df402b5435536e78 /docs/sections/services/ves-hv/installation.rst | |
parent | 19736a929017aaa9801b268ca8387745cd1a90ca (diff) |
HV-VES main documentation draft
Change-Id: I2416a73b703494bdbc8ef35c3608711ea2807018
Issue-ID: DCAEGEN2-831
Signed-off-by: Filip Krzywka <filip.krzywka@nokia.com>
Diffstat (limited to 'docs/sections/services/ves-hv/installation.rst')
-rw-r--r-- | docs/sections/services/ves-hv/installation.rst | 27 |
1 files changed, 27 insertions, 0 deletions
diff --git a/docs/sections/services/ves-hv/installation.rst b/docs/sections/services/ves-hv/installation.rst new file mode 100644 index 00000000..7dafeaed --- /dev/null +++ b/docs/sections/services/ves-hv/installation.rst @@ -0,0 +1,27 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +To run HV-VES Collector container you need to specify required parameters: + +- listen-port - the port on which HV-VES will listen internally +- config-url - URL of HV-VES configuration on consul + +There are also optional configuration parameters: + +- health-check-api-port - Health check rest api listen port +- first-request-delay - Delay of first request to consul in seconds +- request-interval - Interval of consul configuration requests in seconds +- ssl-disable - Disable SSL encryption +- key-store - Key store in PKCS12 format path +- key-store-password - Key store password +- trust-store - File with trusted certificate bundle in PKCS12 format path +- trust-store-password - Trust store password +- idle-timeout-sec - Idle timeout for remote hosts. After given time without any data exchange the connection might be closed + + +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`.
\ No newline at end of file |