summaryrefslogtreecommitdiffstats
path: root/docs/sections/services/snmptrap/installation.rst
diff options
context:
space:
mode:
authorRich Bennett <rb2745@att.com>2018-08-25 10:43:15 -0400
committerRich Bennett <rb2745@att.com>2018-09-11 13:09:28 +0000
commit9847631e1be786f37aef897d4216b6bc2bfa16a2 (patch)
treece8f32126f8cbd25ee51b00b877416508207b720 /docs/sections/services/snmptrap/installation.rst
parentebc5d2abb27beac64cadd00f0fdb1be64c62c9e7 (diff)
Add RST Files for SNMPTRAP
Submitting RST files from abandoned patch https://gerrit.onap.org/r/57071 With updates to remove sphinx warnings Change-Id: I18da62f59943bb932bcfdd6bddfc9164d8ae9b93 Issue-ID: DCAEGEN2-624 Signed-off-by: Rich Bennett <rb2745@att.com>
Diffstat (limited to 'docs/sections/services/snmptrap/installation.rst')
-rw-r--r--docs/sections/services/snmptrap/installation.rst39
1 files changed, 39 insertions, 0 deletions
diff --git a/docs/sections/services/snmptrap/installation.rst b/docs/sections/services/snmptrap/installation.rst
new file mode 100644
index 00000000..3fbb4cde
--- /dev/null
+++ b/docs/sections/services/snmptrap/installation.rst
@@ -0,0 +1,39 @@
+.. This work is licensed under a Creative Commons Attribution 4.0 International License.
+.. http://creativecommons.org/licenses/by/4.0
+
+Installation
+============
+
+**SNMPTRAP** is delivered as a docker container. The host or VM that
+will run this container must have the docker application loaded and
+available to the userID that will be running the SNMPTRAP container.
+
+The instructions below will download and run the latest SNMPTRAP
+container from the NEXUS repository.
+
+Environment
+-----------
+
+An environment suitable for running docker containers is recommended.
+If that is not available, SNMPTRAP source can be downloaded and run
+in a VM or on baremetal.
+
+If running from a docker container, it is assumed that the config
+binding service has been installed and is successfully instantiating
+container configurations as needed.
+
+Also required is a working DMAAP/MR message router environment. SNMPTRAP
+publishes traps to DMAAP/MR as JSON messages, and expect the host
+resources and publishing credentials to be included in the CONFIG
+BINDING SERVICE config.
+
+Steps
+-----
+
+The following command will download the latest snmptrap container
+from nexus and launch it in the container named "snmptrap":
+
+.. code-block:: bash
+
+ 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
+