Browse Source

Merge "add user guide documentation files"

tags/1.0.1-1-rc1
Jenkins 4 years ago
parent
commit
70bd3ffe11

+ 6
- 0
doc/content/appendix.rst View File

@@ -0,0 +1,6 @@
1
+========
2
+Appendix
3
+========
4
+
5
+`Zabbix 2.4 documentation - SNMP traps <https://www.zabbix.com/documentation/2.4/manual/config/items/itemtypes/snmptrap>`_
6
+

+ 25
- 0
doc/content/description.rst View File

@@ -0,0 +1,25 @@
1
+================================================================
2
+Extreme Networks hardware monitoring extension for Zabbix plugin
3
+================================================================
4
+
5
+Extreme Networks hardware monitoring extension plugin extends Zabbix plugin
6
+functionality by adding monitoring of incoming SNMP traps sent from Extreme
7
+Networks hardware via management network to management VIP address. For more
8
+information about networks, see the `Logical Networks <https://docs.mirantis
9
+.com/openstack/fuel/fuel-6.1/reference-architecture.html#logical-networks>`_
10
+section of MOS documentation. The plugin configures snmptt to parse and pass
11
+Extreme Networks specific traps to Zabbix. It also configures Zabbix by adding
12
+Template with appropriate items and triggers and by creating Hosts for each
13
+Extreme Networks hardware.
14
+
15
+Requirements
16
+============
17
+
18
+================================== ===============
19
+Requirement                        Version/Comment
20
+================================== ===============
21
+Fuel                               6.1
22
+Zabbix plugin for Fuel             1.0.0
23
+SNMP trap daemon for Zabbix plugin 1.0.0
24
+================================== ===============
25
+

+ 118
- 0
doc/content/guide.rst View File

@@ -0,0 +1,118 @@
1
+==========
2
+User Guide
3
+==========
4
+
5
+Environment configuration
6
+=========================
7
+
8
+1. 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>`_.
11
+2. 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/>`_.
14
+3. 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/>`_.
17
+4. 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.
32
+5. 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
+
37
+User Guide
38
+==========
39
+
40
+To test if everything is configured properly, follow these steps:
41
+
42
+1. 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
+
71
+2. 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
+
90
+3. 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
+
97
+Hardware setup
98
+==============
99
+
100
+You have to configure your hardware to enable SNMP traps sending. To do this,
101
+refer to your hardware’s manual. Generally, you have to set these two
102
+parameters on your hardware:
103
+
104
+1. 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
+
114
+2. 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
+

+ 39
- 0
doc/content/installation.rst View File

@@ -0,0 +1,39 @@
1
+==================
2
+Installation Guide
3
+==================
4
+
5
+Installing Extreme Networks hardware monitoring extension
6
+=========================================================
7
+
8
+To install Extreme Networks hardware monitoring extension for Zabbix plugin,
9
+follow these steps:
10
+
11
+1. 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/>`_.
14
+2. 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/>`_.
17
+3. 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/>`_.
20
+4. 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
+
26
+5. 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
+
31
+6. 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
+

+ 19
- 0
doc/content/terms.rst View File

@@ -0,0 +1,19 @@
1
+=====================================
2
+Key terms, acronyms and abbreviations
3
+=====================================
4
+
5
+Zabbix
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
+
10
+VIP
11
+    Virtual IP Adress.
12
+
13
+SNMP trap
14
+    A message which is send from agent (for example Extreme Networks switch) to
15
+    monitoring manager.
16
+
17
+SNMP community
18
+    A password which is used for incoming SNMP traps authorization.
19
+

BIN
doc/images/events.png View File


BIN
doc/images/history.png View File


BIN
doc/images/hosts.png View File


BIN
doc/images/issues.png View File


BIN
doc/images/settings.png View File


BIN
doc/images/snmptrapd_settings.png View File


+ 14
- 0
doc/user_guide.rst View File

@@ -0,0 +1,14 @@
1
+*****************************************************************************
2
+Guide to the Extreme Networks hardware monitoring extension for Zabbix plugin
3
+*****************************************************************************
4
+
5
+This document provides instructions for installing, configuring and using
6
+Extreme 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
+

Loading…
Cancel
Save