diff options
author | Ladue, David (dl3158) <dl3158@att.com> | 2018-10-16 16:29:58 -0400 |
---|---|---|
committer | Ladue, David (dl3158) <dl3158@att.com> | 2018-10-19 12:20:34 -0400 |
commit | bb896893a798b1ddf5abd9cd17af77455ddd7432 (patch) | |
tree | e832b8b37c88332b708a0d2b4c84bb2d4552cc53 /docs/sections/services/snmptrap/architecture.rst | |
parent | 2df4b8cac0edf477f4ae62ea3ea2ce8b4d3eaa20 (diff) |
expanding docs, including V3 specs
Change-Id: Id9aff7c62426d8e695374799df30ef6b12be667b
Issue-ID: DCAEGEN2-624
Signed-off-by: Ladue, David (dl3158) <dl3158@att.com>
Diffstat (limited to 'docs/sections/services/snmptrap/architecture.rst')
-rw-r--r-- | docs/sections/services/snmptrap/architecture.rst | 64 |
1 files changed, 13 insertions, 51 deletions
diff --git a/docs/sections/services/snmptrap/architecture.rst b/docs/sections/services/snmptrap/architecture.rst index 7f51f5f4..e65be786 100644 --- a/docs/sections/services/snmptrap/architecture.rst +++ b/docs/sections/services/snmptrap/architecture.rst @@ -4,16 +4,13 @@ Architecture ============ -**SNMPTRAP** (or "trapd", as in trap daemon) is a network facing ONAP platform -component. +The ONAP **SNMPTRAP** project (referred to as **"trapd"** - as in "trap daemon" throughout +this documentation) is a network facing ONAP platform component. -The simple network management protocol (or "SNMP", for short) is a -standardized communication protocol used between managed devices (physical, -virtual - or anything in between!) and a management system. It is used to -relay data that can be valuable in the operation, fault identification and -planning processes of all networks. - -It is the "front line" of management in all environments. +The simple network management protocol (or "SNMP", for short) is a pervasive +communication protocol standard used between managed devices and a management system. +It is used to relay data that can be valuable in the operation, fault identification +and planning processes of all networks. SNMP utilizes a message called a "trap" to inform SNMP managers of abnormal or changed conditions on a resource that is running a SNMP agent. These @@ -25,44 +22,15 @@ software processes or anything else specific to the agent's environment. Capabilities ------------ -**SNMPTRAP** receives simple network management protocol ("SNMP") traps -and publishes them to a message router (DMAAP/MR) instance based on -attributes obtained from configuration binding service ("CBS"). - -.. blockdiag:: - - blockdiag layers { - orientation = portrait - snmp_agent_1 -> SNMPTRAP; - snmp_agent_2 -> SNMPTRAP; - snmp_agent_n -> SNMPTRAP; - config_binding_service -> SNMPTRAP; - SNMPTRAP -> dmaap_mr; - - group l1 { - color = orange; - snmp_agent_1; snmp_agent_2; snmp_agent_n; - } - group l2 { - color = blue; - SNMPTRAP; - } - group l3 { - color = orange; - dmaap_mr; - } - group l4 { - color = gray; - config_binding_service; - } +**trapd** receives SNMP traps and publishes them to a message router (DMAAP/MR) +instance based on attributes obtained from configuration binding service ("CBS"). - } +.. image:: ./ONAP_trapd.png Interactions ------------ - Traps are published to DMAAP/MR in a json format. Once traps are published to a DMAAP/MR instance, they are available to consumers that are subscribed to the topic they were published to. @@ -71,14 +39,8 @@ subscribed to the topic they were published to. Usage Scenarios --------------- -**SNMPTRAP** runs in a docker container based on python 3.6. Running -an instance of **SNMPTRAP** will result in arriving traps being published +**trapd** runs in a docker container based on python 3.6. Running +an instance of **trapd** will result in arriving traps being published to the topic specified by config binding services. If CBS is not present, -SNMPTRAP will look for or a JSON configuration file specified via the -environment variable CBS_SIM_JSON at startup. Note that relative paths -will be located from the bin (<SNMPTRAP base directory>/bin directory. E.g. - -.. code-block:: bash - - CBS_SIM_JSON=../etc/snmptrapd.json - +SNMPTRAP will look for a JSON configuration file specified via the +environment variable CBS_SIM_JSON at startup (see "CONFIGURATION" link for details). |