From 0eaf06480fbdc9936b892139dc8d03e4bd250422 Mon Sep 17 00:00:00 2001 From: Piotr Misiak Date: Tue, 9 Jun 2015 16:03:46 +0200 Subject: [PATCH] add spec file Change-Id: I2dfb61bd2e239eb617d038223bde7a4ed6ee11b6 --- specs/zabbix-snmptrapd-plugin-spec.rst | 140 +++++++++++++++++++++++++ 1 file changed, 140 insertions(+) create mode 100644 specs/zabbix-snmptrapd-plugin-spec.rst diff --git a/specs/zabbix-snmptrapd-plugin-spec.rst b/specs/zabbix-snmptrapd-plugin-spec.rst new file mode 100644 index 0000000..09bba2e --- /dev/null +++ b/specs/zabbix-snmptrapd-plugin-spec.rst @@ -0,0 +1,140 @@ +.. + This work is licensed under the Apache License, Version 2.0. + + http://www.apache.org/licenses/LICENSE-2.0 + +================================== +SNMP trap daemon for Zabbix plugin +================================== + +SNMP trap daemon plugin extends Zabbix plugin functionality by adding +ability to receive SNMP traps from management network and pass them to Zabbix. +It installs snmptrapd daemon for receiving and snmptt for parsing and passing +traps to Zabbix. This plugin do not provide any additional monitoring checks. +It is a base for additional plugins which adds specific SNMP traps monitoring. + +Problem description +=================== + +Currently, Zabbix plugin for Fuel has no support for receiving and analyzing +SNMP traps from external hardware like EMC VNX arrays or network switches. +SNMP trap daemon for Zabbix plugin aims to provide a support for it. + +Proposed change +=============== + +Implement a Fuel plugin that will install and configure snmptrapd daemon for +receiving and snmptt for parsing and passing traps to Zabbix. + +Alternatives +------------ + +It might have been implemented as part of Zabbix plugin for Fuel but we decided +to make it as a separate plugin for several reasons: + +* This isn't something that all operators may want to deploy. +* Any new additional functionality makes the project's testing more difficult, + which is an additional risk for the Zabbix plugin for Fuel release. + +Data model impact +----------------- + +None + +REST API impact +--------------- + +None + +Upgrade impact +-------------- + +None + +Security impact +--------------- + +UDP/162 port opened on management VIP address on Controller nodes + +Notifications impact +-------------------- + +None + +Other end user impact +--------------------- + +None + +Performance Impact +------------------ + +None + +Other deployer impact +--------------------- + +None + +Developer impact +---------------- + +None + +Implementation +============== + +The plugin installs and configures snmptrapd daemon using snmpd puppet module. +It also installs and configures snmptt software for parsing SNMP traps and +passing them to Zabbix. The plugin delivers required official packages which +are not included in Mirantis OpenStack. + +The plugin has one task which is run on all Controller nodes and does following +actions: + +* installs and configures snmptrapd daemon +* installs and configures snmptt +* enables SNMPTrapper in Zabbix + + +Assignee(s) +----------- + +| Dmitry Klenov (PM) +| Piotr Misiak (developer) +| Szymon Bańka (developer) +| Alexander Zatserklyany (QA engineer) + +Work Items +---------- + +* Implement the Fuel plugin. +* Implement the Puppet manifests. +* Testing. +* Write the documentation. + +Dependencies +============ + +* Fuel 6.1 +* Zabbix plugin for Fuel 1.0.0 + +Testing +======= + +* Prepare a test plan. +* Test the plugin by deploying environments with all Fuel deployment modes. + +Documentation Impact +==================== + +* User Guide (which features the plugin provides, how to use them in the + deployed OpenStack environment). +* Test Plan. +* Test Report. + +References +========== + +* `Zabbix Documentation - SNMP traps + `_