diff options
| author |   Vijay VK <vv770d@att.com> | 2018-10-23 16:35:29 +0100 |
|---|---|---|
| committer | VENKATESH KUMAR <vv770d@att.com> | 2018-10-23 12:02:55 -0400 |
| commit | 86cd893e8dbbbd02a1b3209baa6da60337ae417a (patch) | |
| tree | 5d867dcc5dcfdeb46c79dbada9b30a0cb5ce9c53 /docs/sections/services/ves-http/installation.rst | |
| parent | 2133aae7fd41c0d100dbc31ebb5ac2d5456fc15a (diff) | |
dcaegen2 doc updates
Change-Id: I8f0a8a733b6e28fc9d18bed81c9ac4e82c954af8
Signed-off-by: VENKATESH KUMAR <vv770d@att.com>
Issue-ID: DCAEGEN2-573
Diffstat (limited to 'docs/sections/services/ves-http/installation.rst')
| -rw-r--r-- | docs/sections/services/ves-http/installation.rst | 24 |
1 files changed, 24 insertions, 0 deletions
diff --git a/docs/sections/services/ves-http/installation.rst b/docs/sections/services/ves-http/installation.rst new file mode 100644 index 00000000..27f46463 --- /dev/null +++ b/docs/sections/services/ves-http/installation.rst @@ -0,0 +1,24 @@ +.. This work is licensed under a Creative Commons Attribution 4.0 International License. +.. http://creativecommons.org/licenses/by/4.0 + +Installation +============ + +To run VES Collector container on standalone mode, following parameters are required + + ``docker run -d -p 8080:8080/tcp -p 8443:8443/tcp -P -e DMAAPHOST='10.0.11.1' nexus.onap.org:10001/onap/org.onap.dcaegen2.collectors.ves.vescollector:1.3.1`` + + +DMAAPHOST is required for standalone; for normal platform installed instance the publish URL are obtained from Consul. Below parameters are exposed for DCAE platform (cloudify) deployed instance + + +- COLLECTOR_IP +- DMAAPHOST - should contain an address to DMaaP, so that event publishing can work +- CBSPOLLTIMER - it should be put in here if we want to automatically fetch configuration from CBS. +- CONSUL_PROTOCOL - Consul protocol by default set to **http**, if it is need to change it then that can be set to different value +- CONSUL_HOST - used with conjunction with CBSPOLLTIMER, should be a host address (without port! e.g my-ip-or-host) where Consul service lies +- CBS_PROTOCOL - Config Binding Service protocol by default set to **http**, if it is need to change it then that can be set to different value +- CONFIG_BINDING_SERVICE - used with conjunction with CBSPOLLTIMER, should be a name of CBS as it is registered in Consul +- HOSTNAME - used with conjunction with CBSPOLLTIMER, should be a name of VESCollector application as it is registered in CBS catalog + +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
\ No newline at end of file |