Merge "Adding docs for TLS mutual authentication in VES."
[dcaegen2.git] / docs / sections / services / ves-http / installation.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 Installation
5 ============
6
7 To run VES Collector container on standalone mode, following parameters are required
8
9     ``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``
10
11
12 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
13
14
15 - COLLECTOR_IP
16 - DMAAPHOST - should contain an address to DMaaP, so that event publishing can work
17 - CBSPOLLTIMER - it should be put in here if we want to automatically fetch configuration from CBS.
18 - CONSUL_PROTOCOL - Consul protocol by default set to **http**, if it is need to change it then that can be set to different value 
19 - CONSUL_HOST - used with conjunction with CBSPOLLTIMER, should be a host address (without port! e.g my-ip-or-host) where Consul service lies
20 - 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
21 - CONFIG_BINDING_SERVICE - used with conjunction with CBSPOLLTIMER, should be a name of CBS as it is registered in Consul
22 - HOSTNAME - used with conjunction with CBSPOLLTIMER, should be a name of VESCollector application as it is registered in CBS catalog
23
24 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