blob: 3fbb4cde93ff3118d05f3a30ab63de671829f5ca [file] [log] [blame]
Rich Bennett98476312018-08-25 10:43:15 -04001.. This work is licensed under a Creative Commons Attribution 4.0 International License.
2.. http://creativecommons.org/licenses/by/4.0
3
4Installation
5============
6
7**SNMPTRAP** is delivered as a docker container. The host or VM that
8will run this container must have the docker application loaded and
9available to the userID that will be running the SNMPTRAP container.
10
11The instructions below will download and run the latest SNMPTRAP
12container from the NEXUS repository.
13
14Environment
15-----------
16
17An environment suitable for running docker containers is recommended.
18If that is not available, SNMPTRAP source can be downloaded and run
19in a VM or on baremetal.
20
21If running from a docker container, it is assumed that the config
22binding service has been installed and is successfully instantiating
23container configurations as needed.
24
25Also required is a working DMAAP/MR message router environment. SNMPTRAP
26publishes traps to DMAAP/MR as JSON messages, and expect the host
27resources and publishing credentials to be included in the CONFIG
28BINDING SERVICE config.
29
30Steps
31-----
32
33The following command will download the latest snmptrap container
34from 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