Browse Source

add README.md file

Change-Id: I95992ad13a79cb1664ab73d6bfb097150c7ed2d2
Piotr Misiak 3 years ago
parent
commit
10277535ec
1 changed files with 68 additions and 0 deletions
  1. 68
    0
      README.md

+ 68
- 0
README.md View File

@@ -0,0 +1,68 @@
1
+SNMP trap daemon for Zabbix plugin
2
+==================================
3
+
4
+SNMP trap daemon plugin
5
+-----------------------
6
+
7
+SNMP trap daemon plugin extends Zabbix plugin functionality by adding
8
+ability to receive SNMP traps from management network and pass them to Zabbix.
9
+It installs snmptrapd daemon for receiving and snmptt for parsing and passing
10
+traps to Zabbix. This plugin do not provide any additional monitoring checks.
11
+It is a base for additional plugins which adds specific SNMP traps monitoring.
12
+
13
+Requirements
14
+------------
15
+
16
+| Requirement                      | Version/Comment |
17
+|:---------------------------------|:----------------|
18
+| Mirantis OpenStack compatibility | 6.1             |
19
+| Zabbix plugin for Fuel           | 1.0.0           |
20
+
21
+Installation Guide
22
+==================
23
+
24
+SNMP trap daemon plugin installation
25
+------------------------------------
26
+
27
+To install SNMP trap daemon plugin, follow these steps:
28
+
29
+1. Find and install Zabbix plugin for Fuel from
30
+    [Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
31
+
32
+2. Download SNMP trap daemon plugin for Zabbix from
33
+    [Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
34
+
35
+3. Copy the plugin on already installed Fuel Master node; ssh can be used for
36
+    that. If you do not have the Fuel Master node yet, see
37
+    [Quick Start Guide](https://software.mirantis.com/quick-start/) :
38
+
39
+        # scp zabbix_snmptrapd-1.0-1.0.0-1.noarch.rpm root@<Fuel_Master_ip>:/tmp
40
+
41
+4. Install the plugin:
42
+
43
+        # cd /tmp
44
+        # fuel plugins --install zabbix_snmptrapd-1.0-1.0.0-1.noarch.rpm
45
+
46
+5. Check if the plugin was installed successfully:
47
+
48
+        # fuel plugins
49
+        id | name              | version | package_version
50
+        ---|-------------------|---------|----------------
51
+        1  | zabbix_monitoring | 1.0.0   | 2.0.0
52
+        2  | zabbix_snmptrapd  | 1.0.0   | 2.0.0
53
+
54
+For more information and instructions, see the SNMP trap daemon plugin Guide
55
+in the [Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
56
+
57
+Release Notes
58
+-------------
59
+
60
+This is the first release of the plugin.
61
+
62
+Contributors
63
+------------
64
+
65
+Dmitry Klenov <dklenov@mirantis.com> (PM)  
66
+Piotr Misiak <pmisiak@mirantis.com> (developer)  
67
+Szymon Bańka <sbanka@mirantis.com> (developer)  
68
+Alexander Zatserklyany <azatserklyany@mirantis.com> (QA engineer)  

Loading…
Cancel
Save