Browse Source

add spec file

Change-Id: I2dfb61bd2e239eb617d038223bde7a4ed6ee11b6
Piotr Misiak 3 years ago
parent
commit
0eaf06480f
1 changed files with 140 additions and 0 deletions
  1. 140
    0
      specs/zabbix-snmptrapd-plugin-spec.rst

+ 140
- 0
specs/zabbix-snmptrapd-plugin-spec.rst View File

@@ -0,0 +1,140 @@
1
+..
2
+ This work is licensed under the Apache License, Version 2.0.
3
+
4
+ http://www.apache.org/licenses/LICENSE-2.0
5
+
6
+==================================
7
+SNMP trap daemon for Zabbix plugin
8
+==================================
9
+
10
+SNMP trap daemon plugin extends Zabbix plugin functionality by adding
11
+ability to receive SNMP traps from management network and pass them to Zabbix.
12
+It installs snmptrapd daemon for receiving and snmptt for parsing and passing
13
+traps to Zabbix. This plugin do not provide any additional monitoring checks.
14
+It is a base for additional plugins which adds specific SNMP traps monitoring.
15
+
16
+Problem description
17
+===================
18
+
19
+Currently, Zabbix plugin for Fuel has no support for receiving and analyzing
20
+SNMP traps from external hardware like EMC VNX arrays or network switches.
21
+SNMP trap daemon for Zabbix plugin aims to provide a support for it.
22
+
23
+Proposed change
24
+===============
25
+
26
+Implement a Fuel plugin that will install and configure snmptrapd daemon for
27
+receiving and snmptt for parsing and passing traps to Zabbix.
28
+
29
+Alternatives
30
+------------
31
+
32
+It might have been implemented as part of Zabbix plugin for Fuel but we decided
33
+to make it as a separate plugin for several reasons:
34
+
35
+* This isn't something that all operators may want to deploy.
36
+* Any new additional functionality makes the project's testing more difficult,
37
+  which is an additional risk for the Zabbix plugin for Fuel release.
38
+
39
+Data model impact
40
+-----------------
41
+
42
+None
43
+
44
+REST API impact
45
+---------------
46
+
47
+None
48
+
49
+Upgrade impact
50
+--------------
51
+
52
+None
53
+
54
+Security impact
55
+---------------
56
+
57
+UDP/162 port opened on management VIP address on Controller nodes
58
+
59
+Notifications impact
60
+--------------------
61
+
62
+None
63
+
64
+Other end user impact
65
+---------------------
66
+
67
+None
68
+
69
+Performance Impact
70
+------------------
71
+
72
+None
73
+
74
+Other deployer impact
75
+---------------------
76
+
77
+None
78
+
79
+Developer impact
80
+----------------
81
+
82
+None
83
+
84
+Implementation
85
+==============
86
+
87
+The plugin installs and configures snmptrapd daemon using snmpd puppet module.
88
+It also installs and configures snmptt software for parsing SNMP traps and
89
+passing them to Zabbix. The plugin delivers required official packages which
90
+are not included in Mirantis OpenStack.
91
+
92
+The plugin has one task which is run on all Controller nodes and does following
93
+actions:
94
+
95
+* installs and configures snmptrapd daemon
96
+* installs and configures snmptt
97
+* enables SNMPTrapper in Zabbix
98
+
99
+
100
+Assignee(s)
101
+-----------
102
+
103
+| Dmitry Klenov <dklenov@mirantis.com> (PM)
104
+| Piotr Misiak <pmisiak@mirantis.com> (developer)
105
+| Szymon Bańka <sbanka@mirantis.com> (developer)
106
+| Alexander Zatserklyany <azatserklyany@mirantis.com> (QA engineer)
107
+
108
+Work Items
109
+----------
110
+
111
+* Implement the Fuel plugin.
112
+* Implement the Puppet manifests.
113
+* Testing.
114
+* Write the documentation.
115
+
116
+Dependencies
117
+============
118
+
119
+* Fuel 6.1
120
+* Zabbix plugin for Fuel 1.0.0
121
+
122
+Testing
123
+=======
124
+
125
+* Prepare a test plan.
126
+* Test the plugin by deploying environments with all Fuel deployment modes.
127
+
128
+Documentation Impact
129
+====================
130
+
131
+* User Guide (which features the plugin provides, how to use them in the
132
+  deployed OpenStack environment).
133
+* Test Plan.
134
+* Test Report.
135
+
136
+References
137
+==========
138
+
139
+* `Zabbix Documentation - SNMP traps
140
+  <https://www.zabbix.com/documentation/2.4/manual/config/items/itemtypes/snmptrap>`_

Loading…
Cancel
Save