| Vijay VK | 86cd893 | 2018-10-23 16:35:29 +0100 | [diff] [blame] | 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 | |
| Vijay VK | edaf8b1 | 2019-05-23 22:02:50 +0100 | [diff] [blame^] | 7 | VESCollector is installed via cloudify blueprint by DCAE bootstrap process on typical ONAP installation. |
| 8 | As the service is containerized, it can be started on stand-alone mode also. |
| 9 | |
| 10 | |
| Vijay VK | 86cd893 | 2018-10-23 16:35:29 +0100 | [diff] [blame] | 11 | To run VES Collector container on standalone mode, following parameters are required |
| 12 | |
| VENKATESH KUMAR | fac34a1 | 2019-01-20 20:15:08 -0500 | [diff] [blame] | 13 | ``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.2`` |
| Vijay VK | 86cd893 | 2018-10-23 16:35:29 +0100 | [diff] [blame] | 14 | |
| 15 | |
| 16 | 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 |
| 17 | |
| 18 | |
| 19 | - COLLECTOR_IP |
| 20 | - DMAAPHOST - should contain an address to DMaaP, so that event publishing can work |
| 21 | - CBSPOLLTIMER - it should be put in here if we want to automatically fetch configuration from CBS. |
| 22 | - CONSUL_PROTOCOL - Consul protocol by default set to **http**, if it is need to change it then that can be set to different value |
| 23 | - CONSUL_HOST - used with conjunction with CBSPOLLTIMER, should be a host address (without port! e.g my-ip-or-host) where Consul service lies |
| 24 | - 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 |
| 25 | - CONFIG_BINDING_SERVICE - used with conjunction with CBSPOLLTIMER, should be a name of CBS as it is registered in Consul |
| 26 | - HOSTNAME - used with conjunction with CBSPOLLTIMER, should be a name of VESCollector application as it is registered in CBS catalog |
| 27 | |
| 28 | 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 |