summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorPiotr Misiak <pmisiak@mirantis.com>2015-06-22 14:30:33 +0200
committerPiotr Misiak <pmisiak@mirantis.com>2015-06-22 14:30:33 +0200
commitdf65f0f787666bb88463007727a9c1faa9c0ab5e (patch)
treecd7fce9e371fe8b1985e976a343b037b9218238d
parentc54ec723e7478da70977ab7d8e56f48f7e04ee2f (diff)
add user guide documentation files
Notes
Notes (review): Verified+2: Jenkins Code-Review+2: Szymon Banka <sbanka@mirantis.com> Workflow+1: Szymon Banka <sbanka@mirantis.com> Code-Review+1: Tatyana Dubyk <tdubyk@mirantis.com> Submitted-by: Jenkins Submitted-at: Thu, 25 Jun 2015 11:43:04 +0000 Reviewed-on: https://review.openstack.org/194118 Project: stackforge/fuel-plugin-zabbix-monitoring-emc Branch: refs/heads/master
-rw-r--r--doc/content/appendix.rst6
-rw-r--r--doc/content/description.rst24
-rw-r--r--doc/content/guide.rst116
-rw-r--r--doc/content/installation.rst39
-rw-r--r--doc/content/terms.rst19
-rw-r--r--doc/images/events.pngbin0 -> 47282 bytes
-rw-r--r--doc/images/history.pngbin0 -> 58520 bytes
-rw-r--r--doc/images/hosts.pngbin0 -> 37835 bytes
-rw-r--r--doc/images/issues.pngbin0 -> 27785 bytes
-rw-r--r--doc/images/settings.pngbin0 -> 12398 bytes
-rw-r--r--doc/images/snmptrapd_settings.pngbin0 -> 12255 bytes
-rw-r--r--doc/user_guide.rst14
12 files changed, 218 insertions, 0 deletions
diff --git a/doc/content/appendix.rst b/doc/content/appendix.rst
new file mode 100644
index 0000000..a816531
--- /dev/null
+++ b/doc/content/appendix.rst
@@ -0,0 +1,6 @@
1========
2Appendix
3========
4
5`Zabbix 2.4 documentation - SNMP traps <https://www.zabbix.com/documentation/2.4/manual/config/items/itemtypes/snmptrap>`_
6
diff --git a/doc/content/description.rst b/doc/content/description.rst
new file mode 100644
index 0000000..a06aab9
--- /dev/null
+++ b/doc/content/description.rst
@@ -0,0 +1,24 @@
1===================================================
2EMC hardware monitoring extension for Zabbix plugin
3===================================================
4
5EMC hardware monitoring extension plugin extends Zabbix plugin functionality
6by adding monitoring of incoming SNMP traps sent from EMC VNX arrays via
7management network to management VIP address. For more information about
8networks, see the `Logical Networks <https://docs.mirantis.com/openstack/fuel
9/fuel-6.1/reference-architecture.html#logical-networks>`_ section of MOS
10documentation. The plugin configures snmptt to parse and pass EMC VNX specific
11traps to Zabbix. It also configures Zabbix by adding Template with appropriate
12items and triggers and by creating Hosts for each EMC VNX array.
13
14Requirements
15============
16
17================================== ===============
18Requirement Version/Comment
19================================== ===============
20Fuel 6.1
21Zabbix plugin for Fuel 1.0.0
22SNMP trap daemon for Zabbix plugin 1.0.0
23================================== ===============
24
diff --git a/doc/content/guide.rst b/doc/content/guide.rst
new file mode 100644
index 0000000..3e3c7e4
--- /dev/null
+++ b/doc/content/guide.rst
@@ -0,0 +1,116 @@
1==========
2User Guide
3==========
4
5Environment configuration
6=========================
7
81. Create an environment. For more information about environment creation, see
9 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
10 /fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_.
112. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix
12 Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com
13 /products/openstack-drivers-and-plugins/fuel-plugins/>`_.
143. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions,
15 see Zabbix Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis
16 .com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
174. Open *Settings* tab of the Fuel web UI and scroll the page down. Select the
18 plugin checkbox and optionally fill in *EMC hardware to monitor* parameter:
19
20 .. image:: images/settings.png
21
22 When you add your hardware to the *EMC hardware to monitor* comma separated
23 list, then the plugin will automatically configure monitoring for these
24 hardware in Zabbix by doing following actions:
25
26 - create a Host with provided Name and IP address
27 - link the EMC monitoring template to the Host
28
29 If you leave the parameter empty, you will have to add your hardware to
30 Zabbix manually.
315. Adjust other environment settings to your requirements and deploy the
32 environment. For more information, see
33 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
34 /fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_.
35
36User Guide
37==========
38
39To test if everything is configured properly, follow these steps:
40
411. Generate an example SNMP trap by running the following command from any
42 node::
43
44 [root@node-46 ~]# snmptrap -v 1 -c <SNMP_community> <management_VIP_address> '.1.3.6.1.4.1.1981' <host_ip_address> 6 6 '10' .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "a37"
45
46 where:
47
48 *<SNMP_ community>*
49
50 It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI:
51
52 .. image:: images/snmptrapd_settings.png
53
54 *<management_VIP_address>*
55
56 If you don’t know the address, run the following command on any node::
57
58 [root@node-46 ~]# grep management_vip /etc/astute.yaml
59
60 You should get the required VIP in the output::
61
62 management_vip: 192.168.0.1
63
64 *<host_IP_address>*
65
66 IP address of EMC hardware filled in *EMC hardware to monitor* parameter
67
68
692. After several seconds of running the snmptrap command you should see a new
70 event in the Last 20 issues section of the Zabbix Dashboard (for information
71 on how to login to Zabbix Web Interface see Zabbix Plugin Guide in the `Fuel
72 Plugins Catalog <https://www.mirantis.com/products/
73 openstack-drivers-and-plugins/fuel-plugins/>`_):
74
75 .. image:: images/issues.png
76
77 When you click on a date in the *Last change* column of one of the issues,
78 you will see the **Events** page with list of events with the same type:
79
80 .. image:: images/events.png
81
82 To see a full description of the event, you have to click on event’s
83 description and choose *History*, then you will see a **History** page with
84 a full event description:
85
86 .. image:: images/history.png
87
883. After clicking *Configuration* tab and selecting *Hosts* option, you will
89 see a list of hosts with linked monitoring templates. There should be one
90 host for every hardware listed in the *EMC hardware to monitor* plugin
91 parameter:
92
93 .. image:: images/hosts.png
94
95Hardware setup
96==============
97
98You have to configure your hardware to enable SNMP traps sending. To do this,
99refer to your hardware’s manual. Generally, you have to set these two
100parameters on your hardware:
101
1021. SNMP manager - set to management VIP address of your environment
103
104 If you don’t know the address, run the following command on any node::
105
106 [root@node-46 ~]# grep management_vip /etc/astute.yaml
107
108 You should get the required VIP in the output::
109
110 management_vip: 192.168.0.1
111
1122. SNMP community - set the same value as in the *SNMP community* parameter
113 from the SNMP trap daemon for Zabbix plugin settings:
114
115 .. image:: images/snmptrapd_settings.png
116
diff --git a/doc/content/installation.rst b/doc/content/installation.rst
new file mode 100644
index 0000000..520b652
--- /dev/null
+++ b/doc/content/installation.rst
@@ -0,0 +1,39 @@
1==================
2Installation Guide
3==================
4
5Installing EMC hardware monitoring extension
6============================================
7
8To install EMC hardware monitoring extension for Zabbix plugin, follow these
9steps:
10
111. Download and install the Zabbix plugin for Fuel from the
12 `Fuel Plugins Catalog <https://www.mirantis.com/products/
13 openstack-drivers-and-plugins/fuel-plugins/>`_.
142. Download and install the SNMP trap daemon for Zabbix plugin from the
15 `Fuel Plugins Catalog <https://www.mirantis.com/products/
16 openstack-drivers-and-plugins/fuel-plugins/>`_.
173. Download the EMC hardware monitoring extension for Zabbix plugin from the
18 `Fuel Plugins Catalog <https://www.mirantis.com/products/
19 openstack-drivers-and-plugins/fuel-plugins/>`_.
204. Copy the plugin on already installed Fuel Master node; ssh can be used for
21 that. If you do not have the Fuel Master node yet, see `Quick Start Guide
22 <https://software.mirantis.com/quick-start/>`_::
23
24 # scp zabbix_monitoring_emc-1.0-1.0.0-1.noarch.rpm root@<The_Fuel_Master_node_IP>:/tmp
25
265. Log into the Fuel Master node. Install the plugin::
27
28 # cd /tmp
29 # fuel plugins --install zabbix_monitoring_emc-1.0-1.0.0-1.noarch.rpm
30
316. Check if the plugin was installed successfully::
32
33 # fuel plugins
34 id | name | version | package_version
35 ---|---------------------------|----------|----------------
36 1 | zabbix_monitoring | 1.0.0 | 2.0.0
37 2 | zabbix_snmptrapd | 1.0.0 | 2.0.0
38 3 | zabbix_monitoring_emc | 1.0.0 | 2.0.0
39
diff --git a/doc/content/terms.rst b/doc/content/terms.rst
new file mode 100644
index 0000000..64406fa
--- /dev/null
+++ b/doc/content/terms.rst
@@ -0,0 +1,19 @@
1=====================================
2Key terms, acronyms and abbreviations
3=====================================
4
5Zabbix
6 An enterprise open source monitoring solution for networks and
7 applications. It is designed to monitor and track the status of various
8 network services,servers, and other network hardware.
9
10VIP
11 Virtual IP Adress.
12
13SNMP trap
14 A message which is send from agent (for example EMC array) to monitoring
15 manager.
16
17SNMP community
18 A password which is used for incoming SNMP traps authorization.
19
diff --git a/doc/images/events.png b/doc/images/events.png
new file mode 100644
index 0000000..903db40
--- /dev/null
+++ b/doc/images/events.png
Binary files differ
diff --git a/doc/images/history.png b/doc/images/history.png
new file mode 100644
index 0000000..2f8bb42
--- /dev/null
+++ b/doc/images/history.png
Binary files differ
diff --git a/doc/images/hosts.png b/doc/images/hosts.png
new file mode 100644
index 0000000..5052475
--- /dev/null
+++ b/doc/images/hosts.png
Binary files differ
diff --git a/doc/images/issues.png b/doc/images/issues.png
new file mode 100644
index 0000000..befaaf7
--- /dev/null
+++ b/doc/images/issues.png
Binary files differ
diff --git a/doc/images/settings.png b/doc/images/settings.png
new file mode 100644
index 0000000..d890f33
--- /dev/null
+++ b/doc/images/settings.png
Binary files differ
diff --git a/doc/images/snmptrapd_settings.png b/doc/images/snmptrapd_settings.png
new file mode 100644
index 0000000..07dfce7
--- /dev/null
+++ b/doc/images/snmptrapd_settings.png
Binary files differ
diff --git a/doc/user_guide.rst b/doc/user_guide.rst
new file mode 100644
index 0000000..69ffcbe
--- /dev/null
+++ b/doc/user_guide.rst
@@ -0,0 +1,14 @@
1****************************************************************
2Guide to the EMC hardware monitoring extension for Zabbix plugin
3****************************************************************
4
5This document provides instructions for installing, configuring and using EMC
6hardware monitoring extension for Zabbix plugin.
7
8.. contents::
9.. include:: content/terms.rst
10.. include:: content/description.rst
11.. include:: content/installation.rst
12.. include:: content/guide.rst
13.. include:: content/appendix.rst
14