summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorJenkins <jenkins@review.openstack.org>2015-06-25 11:43:11 +0000
committerGerrit Code Review <review@openstack.org>2015-06-25 11:43:11 +0000
commit70bd3ffe111dd1d7eb870c5bdb2c1eeabda3abac (patch)
treed946c2a5b14f0f0637bbad24af5ed0014922adf3
parent5471ece50b4fce0fb46a46b75beee418a252aa15 (diff)
parent0bc575d0355af97f48a833ad7c553d65a3276d5d (diff)
Merge "add user guide documentation files"
-rw-r--r--doc/content/appendix.rst6
-rw-r--r--doc/content/description.rst25
-rw-r--r--doc/content/guide.rst118
-rw-r--r--doc/content/installation.rst39
-rw-r--r--doc/content/terms.rst19
-rw-r--r--doc/images/events.pngbin0 -> 46549 bytes
-rw-r--r--doc/images/history.pngbin0 -> 55250 bytes
-rw-r--r--doc/images/hosts.pngbin0 -> 39414 bytes
-rw-r--r--doc/images/issues.pngbin0 -> 15749 bytes
-rw-r--r--doc/images/settings.pngbin0 -> 13884 bytes
-rw-r--r--doc/images/snmptrapd_settings.pngbin0 -> 12255 bytes
-rw-r--r--doc/user_guide.rst14
12 files changed, 221 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..196712d
--- /dev/null
+++ b/doc/content/description.rst
@@ -0,0 +1,25 @@
1================================================================
2Extreme Networks hardware monitoring extension for Zabbix plugin
3================================================================
4
5Extreme Networks hardware monitoring extension plugin extends Zabbix plugin
6functionality by adding monitoring of incoming SNMP traps sent from Extreme
7Networks hardware via management network to management VIP address. For more
8information about networks, see the `Logical Networks <https://docs.mirantis
9.com/openstack/fuel/fuel-6.1/reference-architecture.html#logical-networks>`_
10section of MOS documentation. The plugin configures snmptt to parse and pass
11Extreme Networks specific traps to Zabbix. It also configures Zabbix by adding
12Template with appropriate items and triggers and by creating Hosts for each
13Extreme Networks hardware.
14
15Requirements
16============
17
18================================== ===============
19Requirement Version/Comment
20================================== ===============
21Fuel 6.1
22Zabbix plugin for Fuel 1.0.0
23SNMP trap daemon for Zabbix plugin 1.0.0
24================================== ===============
25
diff --git a/doc/content/guide.rst b/doc/content/guide.rst
new file mode 100644
index 0000000..86dd171
--- /dev/null
+++ b/doc/content/guide.rst
@@ -0,0 +1,118 @@
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 *Extreme Networks hardware to
19 monitor* parameter:
20
21 .. image:: images/settings.png
22
23 When you add your hardware to the *Extreme Networks hardware to monitor*
24 comma separated list, then the plugin will automatically configure
25 monitoring for these hardware in Zabbix by doing following actions:
26
27 - create a Host with provided Name and IP address
28 - link the Extreme Networks monitoring template to the Host
29
30 If you leave the parameter empty, you will have to add your hardware to
31 Zabbix manually.
325. Adjust other environment settings to your requirements and deploy the
33 environment. For more information, see
34 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
35 /fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_.
36
37User Guide
38==========
39
40To test if everything is configured properly, follow these steps:
41
421. Generate an example SNMP trap by running the following command from any
43 node::
44
45 [root@node-46 ~]# snmptrap -v 1 -c <SNMP_community> <management_VIP_address> '.1.3.6.1.4.1.1916' <host_ip_address> 6 10 '10' .1.3.6.1.4.1.1916 s "null" .1.3.6.1.4.1.1916 s "null" .1.3.6.1.4.1.1916 s "2"
46
47 where:
48
49 *<SNMP_ community>*
50
51 It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI:
52
53 .. image:: images/snmptrapd_settings.png
54
55 *<management_VIP_address>*
56
57 If you don’t know the address, run the following command on any node::
58
59 [root@node-46 ~]# grep management_vip /etc/astute.yaml
60
61 You should get the required VIP in the output::
62
63 management_vip: 192.168.0.1
64
65 *<host_IP_address>*
66
67 IP address of Extreme Networks hardware filled in *Extreme Networks
68 hardware to monitor* parameter
69
70
712. After several seconds of running the snmptrap command you should see a new
72 event in the Last 20 issues section of the Zabbix Dashboard (for information
73 on how to login to Zabbix Web Interface see Zabbix Plugin Guide in the `Fuel
74 Plugins Catalog <https://www.mirantis.com/products/
75 openstack-drivers-and-plugins/fuel-plugins/>`_):
76
77 .. image:: images/issues.png
78
79 When you click on a date in the *Last change* column of one of the issues,
80 you will see the **Events** page with list of events with the same type:
81
82 .. image:: images/events.png
83
84 To see a full description of the event, you have to click on event’s
85 description and choose *History*, then you will see a **History** page with
86 a full event description:
87
88 .. image:: images/history.png
89
903. After clicking *Configuration* tab and selecting *Hosts* option, you will
91 see a list of hosts with linked monitoring templates. There should be one
92 host for every hardware listed in the *Extreme Networks hardware to monitor*
93 plugin parameter:
94
95 .. image:: images/hosts.png
96
97Hardware setup
98==============
99
100You have to configure your hardware to enable SNMP traps sending. To do this,
101refer to your hardware’s manual. Generally, you have to set these two
102parameters on your hardware:
103
1041. SNMP manager - set to management VIP address of your environment
105
106 If you don’t know the address, run the following command on any node::
107
108 [root@node-46 ~]# grep management_vip /etc/astute.yaml
109
110 You should get the required VIP in the output::
111
112 management_vip: 192.168.0.1
113
1142. SNMP community - set the same value as in the *SNMP community* parameter
115 from the SNMP trap daemon for Zabbix plugin settings:
116
117 .. image:: images/snmptrapd_settings.png
118
diff --git a/doc/content/installation.rst b/doc/content/installation.rst
new file mode 100644
index 0000000..baf033d
--- /dev/null
+++ b/doc/content/installation.rst
@@ -0,0 +1,39 @@
1==================
2Installation Guide
3==================
4
5Installing Extreme Networks hardware monitoring extension
6=========================================================
7
8To install Extreme Networks hardware monitoring extension for Zabbix plugin,
9follow these steps:
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 Extreme Networks hardware monitoring extension for Zabbix
18 plugin from the `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_extreme_networks-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_extreme_networks-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_extreme_networks | 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..96d0d74
--- /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 Extreme Networks switch) to
15 monitoring 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..67e8afc
--- /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..53232a0
--- /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..2f68774
--- /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..e2fcd58
--- /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..cbd5eb1
--- /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..035e98a
--- /dev/null
+++ b/doc/user_guide.rst
@@ -0,0 +1,14 @@
1*****************************************************************************
2Guide to the Extreme Networks hardware monitoring extension for Zabbix plugin
3*****************************************************************************
4
5This document provides instructions for installing, configuring and using
6Extreme Networks hardware 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