add user guide documentation files
Change-Id: Ib0ce42cfa419e474f8d2f734208497f960561cb9
This commit is contained in:
parent
767cad8dc6
commit
0bc575d035
6
doc/content/appendix.rst
Normal file
6
doc/content/appendix.rst
Normal file
@ -0,0 +1,6 @@
|
|||||||
|
========
|
||||||
|
Appendix
|
||||||
|
========
|
||||||
|
|
||||||
|
`Zabbix 2.4 documentation - SNMP traps <https://www.zabbix.com/documentation/2.4/manual/config/items/itemtypes/snmptrap>`_
|
||||||
|
|
25
doc/content/description.rst
Normal file
25
doc/content/description.rst
Normal file
@ -0,0 +1,25 @@
|
|||||||
|
================================================================
|
||||||
|
Extreme Networks hardware monitoring extension for Zabbix plugin
|
||||||
|
================================================================
|
||||||
|
|
||||||
|
Extreme Networks hardware monitoring extension plugin extends Zabbix plugin
|
||||||
|
functionality by adding monitoring of incoming SNMP traps sent from Extreme
|
||||||
|
Networks hardware via management network to management VIP address. For more
|
||||||
|
information about networks, see the `Logical Networks <https://docs.mirantis
|
||||||
|
.com/openstack/fuel/fuel-6.1/reference-architecture.html#logical-networks>`_
|
||||||
|
section of MOS documentation. The plugin configures snmptt to parse and pass
|
||||||
|
Extreme Networks specific traps to Zabbix. It also configures Zabbix by adding
|
||||||
|
Template with appropriate items and triggers and by creating Hosts for each
|
||||||
|
Extreme Networks hardware.
|
||||||
|
|
||||||
|
Requirements
|
||||||
|
============
|
||||||
|
|
||||||
|
================================== ===============
|
||||||
|
Requirement Version/Comment
|
||||||
|
================================== ===============
|
||||||
|
Fuel 6.1
|
||||||
|
Zabbix plugin for Fuel 1.0.0
|
||||||
|
SNMP trap daemon for Zabbix plugin 1.0.0
|
||||||
|
================================== ===============
|
||||||
|
|
118
doc/content/guide.rst
Normal file
118
doc/content/guide.rst
Normal file
@ -0,0 +1,118 @@
|
|||||||
|
==========
|
||||||
|
User Guide
|
||||||
|
==========
|
||||||
|
|
||||||
|
Environment configuration
|
||||||
|
=========================
|
||||||
|
|
||||||
|
1. Create an environment. For more information about environment creation, see
|
||||||
|
`Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
|
||||||
|
/fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_.
|
||||||
|
2. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix
|
||||||
|
Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com
|
||||||
|
/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||||
|
3. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions,
|
||||||
|
see Zabbix Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis
|
||||||
|
.com/products/openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||||
|
4. Open *Settings* tab of the Fuel web UI and scroll the page down. Select the
|
||||||
|
plugin checkbox and optionally fill in *Extreme Networks hardware to
|
||||||
|
monitor* parameter:
|
||||||
|
|
||||||
|
.. image:: images/settings.png
|
||||||
|
|
||||||
|
When you add your hardware to the *Extreme Networks hardware to monitor*
|
||||||
|
comma separated list, then the plugin will automatically configure
|
||||||
|
monitoring for these hardware in Zabbix by doing following actions:
|
||||||
|
|
||||||
|
- create a Host with provided Name and IP address
|
||||||
|
- link the Extreme Networks monitoring template to the Host
|
||||||
|
|
||||||
|
If you leave the parameter empty, you will have to add your hardware to
|
||||||
|
Zabbix manually.
|
||||||
|
5. Adjust other environment settings to your requirements and deploy the
|
||||||
|
environment. For more information, see
|
||||||
|
`Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
|
||||||
|
/fuel-6.1/user-guide.html#create-a-new-openstack-environment>`_.
|
||||||
|
|
||||||
|
User Guide
|
||||||
|
==========
|
||||||
|
|
||||||
|
To test if everything is configured properly, follow these steps:
|
||||||
|
|
||||||
|
1. Generate an example SNMP trap by running the following command from any
|
||||||
|
node::
|
||||||
|
|
||||||
|
[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"
|
||||||
|
|
||||||
|
where:
|
||||||
|
|
||||||
|
*<SNMP_ community>*
|
||||||
|
|
||||||
|
It is set in the SNMP trap daemon for Zabbix plugin Settings in Fuel UI:
|
||||||
|
|
||||||
|
.. image:: images/snmptrapd_settings.png
|
||||||
|
|
||||||
|
*<management_VIP_address>*
|
||||||
|
|
||||||
|
If you don’t know the address, run the following command on any node::
|
||||||
|
|
||||||
|
[root@node-46 ~]# grep management_vip /etc/astute.yaml
|
||||||
|
|
||||||
|
You should get the required VIP in the output::
|
||||||
|
|
||||||
|
management_vip: 192.168.0.1
|
||||||
|
|
||||||
|
*<host_IP_address>*
|
||||||
|
|
||||||
|
IP address of Extreme Networks hardware filled in *Extreme Networks
|
||||||
|
hardware to monitor* parameter
|
||||||
|
|
||||||
|
|
||||||
|
2. After several seconds of running the snmptrap command you should see a new
|
||||||
|
event in the Last 20 issues section of the Zabbix Dashboard (for information
|
||||||
|
on how to login to Zabbix Web Interface see Zabbix Plugin Guide in the `Fuel
|
||||||
|
Plugins Catalog <https://www.mirantis.com/products/
|
||||||
|
openstack-drivers-and-plugins/fuel-plugins/>`_):
|
||||||
|
|
||||||
|
.. image:: images/issues.png
|
||||||
|
|
||||||
|
When you click on a date in the *Last change* column of one of the issues,
|
||||||
|
you will see the **Events** page with list of events with the same type:
|
||||||
|
|
||||||
|
.. image:: images/events.png
|
||||||
|
|
||||||
|
To see a full description of the event, you have to click on event’s
|
||||||
|
description and choose *History*, then you will see a **History** page with
|
||||||
|
a full event description:
|
||||||
|
|
||||||
|
.. image:: images/history.png
|
||||||
|
|
||||||
|
3. After clicking *Configuration* tab and selecting *Hosts* option, you will
|
||||||
|
see a list of hosts with linked monitoring templates. There should be one
|
||||||
|
host for every hardware listed in the *Extreme Networks hardware to monitor*
|
||||||
|
plugin parameter:
|
||||||
|
|
||||||
|
.. image:: images/hosts.png
|
||||||
|
|
||||||
|
Hardware setup
|
||||||
|
==============
|
||||||
|
|
||||||
|
You have to configure your hardware to enable SNMP traps sending. To do this,
|
||||||
|
refer to your hardware’s manual. Generally, you have to set these two
|
||||||
|
parameters on your hardware:
|
||||||
|
|
||||||
|
1. SNMP manager - set to management VIP address of your environment
|
||||||
|
|
||||||
|
If you don’t know the address, run the following command on any node::
|
||||||
|
|
||||||
|
[root@node-46 ~]# grep management_vip /etc/astute.yaml
|
||||||
|
|
||||||
|
You should get the required VIP in the output::
|
||||||
|
|
||||||
|
management_vip: 192.168.0.1
|
||||||
|
|
||||||
|
2. SNMP community - set the same value as in the *SNMP community* parameter
|
||||||
|
from the SNMP trap daemon for Zabbix plugin settings:
|
||||||
|
|
||||||
|
.. image:: images/snmptrapd_settings.png
|
||||||
|
|
39
doc/content/installation.rst
Normal file
39
doc/content/installation.rst
Normal file
@ -0,0 +1,39 @@
|
|||||||
|
==================
|
||||||
|
Installation Guide
|
||||||
|
==================
|
||||||
|
|
||||||
|
Installing Extreme Networks hardware monitoring extension
|
||||||
|
=========================================================
|
||||||
|
|
||||||
|
To install Extreme Networks hardware monitoring extension for Zabbix plugin,
|
||||||
|
follow these steps:
|
||||||
|
|
||||||
|
1. Download and install the Zabbix plugin for Fuel from the
|
||||||
|
`Fuel Plugins Catalog <https://www.mirantis.com/products/
|
||||||
|
openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||||
|
2. Download and install the SNMP trap daemon for Zabbix plugin from the
|
||||||
|
`Fuel Plugins Catalog <https://www.mirantis.com/products/
|
||||||
|
openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||||
|
3. Download the Extreme Networks hardware monitoring extension for Zabbix
|
||||||
|
plugin from the `Fuel Plugins Catalog <https://www.mirantis.com/products/
|
||||||
|
openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||||
|
4. Copy the plugin on already installed Fuel Master node; ssh can be used for
|
||||||
|
that. If you do not have the Fuel Master node yet, see `Quick Start Guide
|
||||||
|
<https://software.mirantis.com/quick-start/>`_::
|
||||||
|
|
||||||
|
# scp zabbix_monitoring_extreme_networks-1.0-1.0.0-1.noarch.rpm root@<The_Fuel_Master_node_IP>:/tmp
|
||||||
|
|
||||||
|
5. Log into the Fuel Master node. Install the plugin::
|
||||||
|
|
||||||
|
# cd /tmp
|
||||||
|
# fuel plugins --install zabbix_monitoring_extreme_networks-1.0-1.0.0-1.noarch.rpm
|
||||||
|
|
||||||
|
6. Check if the plugin was installed successfully::
|
||||||
|
|
||||||
|
# fuel plugins
|
||||||
|
id | name | version | package_version
|
||||||
|
---|------------------------------------|----------|----------------
|
||||||
|
1 | zabbix_monitoring | 1.0.0 | 2.0.0
|
||||||
|
2 | zabbix_snmptrapd | 1.0.0 | 2.0.0
|
||||||
|
3 | zabbix_monitoring_extreme_networks | 1.0.0 | 2.0.0
|
||||||
|
|
19
doc/content/terms.rst
Normal file
19
doc/content/terms.rst
Normal file
@ -0,0 +1,19 @@
|
|||||||
|
=====================================
|
||||||
|
Key terms, acronyms and abbreviations
|
||||||
|
=====================================
|
||||||
|
|
||||||
|
Zabbix
|
||||||
|
An enterprise open source monitoring solution for networks and
|
||||||
|
applications. It is designed to monitor and track the status of various
|
||||||
|
network services,servers, and other network hardware.
|
||||||
|
|
||||||
|
VIP
|
||||||
|
Virtual IP Adress.
|
||||||
|
|
||||||
|
SNMP trap
|
||||||
|
A message which is send from agent (for example Extreme Networks switch) to
|
||||||
|
monitoring manager.
|
||||||
|
|
||||||
|
SNMP community
|
||||||
|
A password which is used for incoming SNMP traps authorization.
|
||||||
|
|
BIN
doc/images/events.png
Normal file
BIN
doc/images/events.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 46 KiB |
BIN
doc/images/history.png
Normal file
BIN
doc/images/history.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 54 KiB |
BIN
doc/images/hosts.png
Normal file
BIN
doc/images/hosts.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 38 KiB |
BIN
doc/images/issues.png
Normal file
BIN
doc/images/issues.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 15 KiB |
BIN
doc/images/settings.png
Normal file
BIN
doc/images/settings.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 14 KiB |
BIN
doc/images/snmptrapd_settings.png
Normal file
BIN
doc/images/snmptrapd_settings.png
Normal file
Binary file not shown.
After Width: | Height: | Size: 12 KiB |
14
doc/user_guide.rst
Normal file
14
doc/user_guide.rst
Normal file
@ -0,0 +1,14 @@
|
|||||||
|
*****************************************************************************
|
||||||
|
Guide to the Extreme Networks hardware monitoring extension for Zabbix plugin
|
||||||
|
*****************************************************************************
|
||||||
|
|
||||||
|
This document provides instructions for installing, configuring and using
|
||||||
|
Extreme Networks hardware monitoring extension for Zabbix plugin.
|
||||||
|
|
||||||
|
.. contents::
|
||||||
|
.. include:: content/terms.rst
|
||||||
|
.. include:: content/description.rst
|
||||||
|
.. include:: content/installation.rst
|
||||||
|
.. include:: content/guide.rst
|
||||||
|
.. include:: content/appendix.rst
|
||||||
|
|
Loading…
Reference in New Issue
Block a user