Add RST Files for SNMPTRAP
[dcaegen2.git] / docs / sections / services / snmptrap / 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 **SNMPTRAP** is delivered as a docker container.  The host or VM that
8 will run this container must have the docker application loaded and
9 available to the userID that will be running the SNMPTRAP container.
10
11 The instructions below will download and run the latest SNMPTRAP
12 container from the NEXUS repository.
13
14 Environment
15 -----------
16
17 An environment suitable for running docker containers is recommended.
18 If that is not available, SNMPTRAP source can be downloaded and run
19 in a VM or on baremetal.  
20
21 If running from a docker container, it is assumed that the config
22 binding service has been installed and is successfully instantiating
23 container configurations as needed.
24
25 Also required is a working DMAAP/MR message router environment.  SNMPTRAP
26 publishes traps to DMAAP/MR as JSON messages, and expect the host
27 resources and publishing credentials to be included in the CONFIG
28 BINDING SERVICE config.
29
30 Steps
31 -----
32
33 The following command will download the latest snmptrap container
34 from nexus and launch it in the container named "snmptrap":
35
36 .. code-block:: bash
37
38     docker run --detach -t --rm -p 162:6162/udp -P --name=snmptrap nexus3.onap.org:10001/onap/org.onap.dcaegen2.collectors.snmptrap ./bin/snmptrapd.sh start
39