Adding Documentation of Mapper
[dcaegen2.git] / docs / sections / services / mapper / 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 .. Copyright 2018 Tech Mahindra Ltd.
4
5
6 Installation
7 ============
8 Currently both Universal VES Adapter and SnmpMapper are not integrated with CONFIG_BINDING_SERVICE to get their configuration. All the required configuration needs to be passed as docker environment parameters.
9
10 | **Universal Ves Adapter**
11
12  To run Universal Ves Adapter container on standalone mode, following docker environment parameters are required.
13
14
15 - DMAAPHOST  -  Should contain an address to DMaaP, so that event publishing can work
16 - MR_PORT - DMaaP Exposed Port
17 - URL_JDBC - JDBC URL where postgres db is installed 
18 - JDBC_USERNAME - Username for postgres DB user
19 - JDBC_PASSWORD - Password for postgres  DB user
20 - CONSUL_HOST - a host address where Consul service lies
21 - CONFIG_BINDING_SERVICE - name of CBS as it is registered in Consul
22 - HOSTNAME - name of Universal Ves Adapter application as it is registered in CBS catalog
23
24 Sample docker run command could be -
25
26     ``docker run -d -p 8085:8085/tcp -e URL_JDBC=jdbc:postgresql://10.53.172.138:5432/postgres -e JDBC_USERNAME=postgres -e JDBC_PASSWORD=root -e DMAAPHOST=10.53.172.156 -e CONSUL_HOST=10.53.172.109 -e HOSTNAME=static-dcaegen2-services-mua -e MR_DEFAULT_PORT_NUMBER=3904 -e CONFIG_BINDING_SERVICE=config_binding_service nexus3.onap.org:10003/onap/org.onap.dcaegen2.services.mapper.vesadapter.universalvesadaptor:latest``
27
28 Note: you should have a postgresql  and DMaap  instance running in your system and provide their credentials and hostname to run in standalone mode.
29
30
31
32
33 | **SnmpMapper**
34
35 - To run SnmpMapper container on standalone mode, following docker environment parameters are required.
36
37 - DMAAPHOST-should contain an address to DMaaP, this will be used in future reference
38 - MR_PORT - DMaaP Exposed Port
39 - URL_JDBC- JDBC URL where postgres db is installed 
40 - JDBC_USERNAME- Username for postgres DB user
41 - JDBC_PASSWORD-Password for postgres  DB user
42 - CONSUL_HOST - a host address where Consul service lies
43 - CONFIG_BINDING_SERVICE - name of CBS as it is registered in Consul
44 - HOSTNAME - name of Universal Ves Adapter application as it is registered in CBS catalog
45
46 Sample docker run command could be -
47
48    ``docker run -d -p 8084:8080/tcp -e URL_JDBC=jdbc:postgresql://10.53.172.138:5432/postgres -e JDBC_USERNAME=postgres -e JDBC_PASSWORD=root -e DMAAPHOST=10.53.172.156 -e CONSUL_HOST=10.53.172.109 -e HOSTNAME=static-dcaegen2-services-msnmp -e MR_DEFAULT_PORT_NUMBER=3904 -e CONFIG_BINDING_SERVICE=config_binding_service nexus3.onap.org:10003/onap/org.onap.dcaegen2.services.mapper.snmpmapper:latest``