diff --git a/doc/plugin-guide/source/appendix.rst b/doc/plugin-guide/source/appendix.rst index a816531..cfbe558 100644 --- a/doc/plugin-guide/source/appendix.rst +++ b/doc/plugin-guide/source/appendix.rst @@ -2,5 +2,37 @@ Appendix ======== -`Zabbix 2.4 documentation - SNMP traps `_ +.. _links: + +Links +===== + +- `Zabbix Official site `_ +- `Zabbix 2.4 documentation `_ +- `Zabbix 2.4 documentation - SNMP traps `_ +- `Zabbix 2.4 documentation - Templates `_ +- `Fuel Plugins CLI guide `_ + +.. _licenses: + +Components licenses +=================== + +deb packages +------------ + +rpm packages +------------ + +puppet modules +-------------- + +==== ========== +Name License +==== ========== +snmp Apache 2.0 +==== ========== diff --git a/doc/plugin-guide/source/changelog.rst b/doc/plugin-guide/source/changelog.rst new file mode 100644 index 0000000..fb8e7b8 --- /dev/null +++ b/doc/plugin-guide/source/changelog.rst @@ -0,0 +1,11 @@ +Release notes / Changelog +========================= + +**1.0.1** + +* Compatibility with MOS 8.0 + +**1.0.0** + +* This is the first release of the plugin. + diff --git a/doc/plugin-guide/source/conf.py b/doc/plugin-guide/source/conf.py index 0d7ca9f..ffed83c 100644 --- a/doc/plugin-guide/source/conf.py +++ b/doc/plugin-guide/source/conf.py @@ -1,7 +1,7 @@ # -*- coding: utf-8 -*- # # The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension documentation build configuration file, created by -# sphinx-quickstart on Tue Nov 3 10:53:03 2015. +# sphinx-quickstart on Wed Feb 24 17:05:59 2016. # # This file is execfile()d with the current directory set to its # containing dir. @@ -14,7 +14,6 @@ import sys import os -import shlex # If extensions (or modules to document with autodoc) are in another directory, # add these directories to sys.path here. If the directory is relative to the @@ -29,9 +28,7 @@ import shlex # Add any Sphinx extension module names here, as strings. They can be # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom # ones. -extensions = [ - 'sphinx.ext.todo', -] +extensions = [ ] # Add any paths that contain templates here, relative to this directory. templates_path = ['_templates'] @@ -49,8 +46,8 @@ master_doc = 'index' # General information about the project. project = u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension' -copyright = u'2016, Mirantis' -author = u'Mirantis' +copyright = u'2016, Mirantis Inc.' +author = u'Mirantis Inc.' # The version info for the project you're documenting, acts as replacement for # |version| and |release|, also used in various other places throughout the @@ -66,7 +63,7 @@ release = '1.0-1.0.1-1' # # This is also used if you do content translation via gettext catalogs. # Usually you set "language" from the command line for these cases. -language = None +#language = None # There are two options for replacing |today|: either, you set today to some # non-false value, then it is used: @@ -76,7 +73,7 @@ language = None # List of patterns, relative to source directory, that match files and # directories to ignore when looking for source files. -exclude_patterns = [] +#exclude_patterns = [] # The reST default role (used for this markup: `text`) to use for all # documents. @@ -103,14 +100,14 @@ pygments_style = 'sphinx' #keep_warnings = False # If true, `todo` and `todoList` produce output, else they produce nothing. -todo_include_todos = True +#todo_include_todos = True # -- Options for HTML output ---------------------------------------------- # The theme to use for HTML and HTML Help pages. See the documentation for # a list of builtin themes. -html_theme = 'classic' +html_theme = 'default' # Theme options are theme-specific and customize the look and feel of a theme # further. For a list of options available for each theme, see the @@ -218,13 +215,16 @@ latex_elements = { # Latex figure (float) alignment #'figure_align': 'htbp', + +'classoptions': ',openany,oneside', +'babel': '\\usepackage[english]{babel}' } # Grouping the document tree into LaTeX files. List of tuples # (source start file, target name, title, # author, documentclass [howto, manual, or own class]). latex_documents = [ - (master_doc, 'TheZabbixpluginforFuelExtremeNetworksExtension.tex', u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension Documentation', + (master_doc, 'TheZabbixpluginforFuelExtremeNetworksExtension-' + version + '.tex', u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension Documentation', author, 'manual'), ] @@ -283,3 +283,6 @@ texinfo_documents = [ # If true, do not generate a @detailmenu in the "Top" node's menu. #texinfo_no_detailmenu = False + +# Insert footnotes where they are defined instead of at the end. +pdf_inline_footnotes = True diff --git a/doc/plugin-guide/source/description.rst b/doc/plugin-guide/source/description.rst index 3df059e..4592c34 100644 --- a/doc/plugin-guide/source/description.rst +++ b/doc/plugin-guide/source/description.rst @@ -1,6 +1,6 @@ -================================================================ -Extreme Networks hardware monitoring extension for Zabbix plugin -================================================================ +============================================================================= +Guide to the 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 diff --git a/doc/plugin-guide/source/guide.rst b/doc/plugin-guide/source/guide.rst index 82caaab..2e3f8c2 100644 --- a/doc/plugin-guide/source/guide.rst +++ b/doc/plugin-guide/source/guide.rst @@ -2,19 +2,45 @@ User Guide ========== +Important preliminary notes +=========================== + +- It is highly recommended to do a network verification check prior + to any deployment. +- This plugin version only supports Ubuntu OS type. +- You can also choose any supervisor and/or also change the + networking configuration according to your needs but you can not use + the old legacy networking mode (nova-network) as this is not supported. +- See Zabbix Plugin for Fuel Documentation for additional notes +- See Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional notes + +Known problems +============== + +- `#1538617 `_: + Cross-plugin display restrictions for some plugins prevent Settings tab from opening. +- See Zabbix Plugin for Fuel Documentation for additional problems +- See Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional problems + Environment configuration ========================= -1. Create an environment. For more information about environment creation, see +.. highlight:: none + +#. Create an environment. For more information about environment creation, see `Mirantis OpenStack User Guide `_. -2. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix + +#. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix Plugin Guide in the `Fuel Plugins Catalog `_. -3. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions, - see Zabbix Plugin Guide in the `Fuel Plugins Catalog `_. -4. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left + +#. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions, + see Zabbix Plugin Guide and Zabbix SNMP Trap Daemon Plugin Guide + in the `Fuel Plugins Catalog `_. + +#. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left choose *Extreme Networks hardware monitoring extension for Zabbix plugin*, select the plugin checkbox and optionally fill in *Extreme Networks hardware to monitor* parameter: @@ -24,14 +50,15 @@ Environment configuration When you add your hardware to the *Extreme Networks hardware to monitor* comma separated list, then the plugin will automatically configure - monitoring for hardware in Zabbix by doing following actions: + monitoring for this 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 + +#. Adjust other environment settings to your requirements and deploy the environment. For more information, see `Mirantis OpenStack User Guide `_. @@ -39,13 +66,12 @@ Environment configuration User Guide ========== -To test if everything is configured properly, follow these steps: +To test if everything is installed and configured properly, follow these steps: -1. Generate an example SNMP trap by running the following command from any - node:: +#. Generate a SNMP test trap by running the following command from any node:: - [root@node-46 ~]# snmptrap -v 1 -c \ - '.1.3.6.1.4.1.1916' 6 10 '10' \ + # snmptrap -v 1 -c \ + '.1.3.6.1.4.1.1916' 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" @@ -58,17 +84,16 @@ To test if everything is configured properly, follow these steps: .. image:: ../images/snmptrapd_settings.png :width: 100% - ** + ** If you don’t know the address, run the following command on any node:: - [root@node-46 ~]# grep -A2 ^zbx_vip_mgmt /etc/astute.yaml + # awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \ + /etc/astute.yaml | sed -e 's/.*: //' You should get the required VIP in the output:: - zbx_vip_mgmt: - network_role: zabbix - ipaddr: 192.168.0.1 + 192.168.0.3 ** @@ -76,7 +101,7 @@ To test if everything is configured properly, follow these steps: hardware to monitor* parameter -2. After several seconds of running the snmptrap command you should see a new +#. 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 `_. -2. Download and install the SNMP trap daemon for Zabbix plugin from the + +#. Download and install the SNMP trap daemon for Zabbix plugin from the `Fuel Plugins Catalog `_. -3. Download the Extreme Networks hardware monitoring extension for Zabbix + +#. Download the Extreme Networks hardware monitoring extension for Zabbix plugin from the `Fuel Plugins Catalog `_. -4. Copy all three plugins from your local machine to a previously deployed + +#. Copy all three plugins from your local machine to a previously deployed Fuel Master node using ssh. If you do not have the Fuel Master node yet, see `Quick Start Guide `_:: # scp zabbix_monitoring-2.5-2.5.0-1.noarch.rpm \ - root@:/tmp + root@:/tmp # scp zabbix_snmptrapd-1.0-1.0.1-1.noarch.rpm \ - root@:/tmp + root@:/tmp # scp zabbix_monitoring_extreme_networks-1.0-1.0.1-1.noarch.rpm \ - root@:/tmp + root@:/tmp -5. Log into the Fuel Master node. Install each of the three plugins using +#. Log into the Fuel Master node. Install each of the three plugins using the following commands:: # cd /tmp @@ -39,7 +44,7 @@ follow these steps: # fuel plugins --install \ zabbix_monitoring_extreme_networks-1.0-1.0.1-1.noarch.rpm -6. Make sure the plugins were installed correctly:: +6# Make sure the plugins were installed correctly:: # fuel plugins id | name | version | package_version @@ -48,3 +53,24 @@ follow these steps: 2 | zabbix_snmptrapd | 1.0.1 | 2.0.0 3 | zabbix_monitoring_extreme_networks | 1.0.1 | 2.0.0 +Extreme Networks hardware monitoring extension removal +====================================================== + +To uninstall Extreme Networks hardware monitoring extension for Zabbix plugin, +follow these steps: + +#. Delete all Environments in which Extreme Networks hardware monitoring extension +for Zabbix plugin has been enabled. + +#. Uninstall the plugin:: + + # fuel plugins --remove zabbix_monitoring_extreme_networks==1.0.1 + +#. Check if the plugin was uninstalled successfully:: + + # fuel plugins + id | name | version | package_version + ---|---------------------------|----------|---------------- + ... + You can still have other plugins listed here but not zabbix_monitoring_extreme_networks + diff --git a/doc/plugin-guide/source/terms.rst b/doc/plugin-guide/source/keyterms.rst similarity index 74% rename from doc/plugin-guide/source/terms.rst rename to doc/plugin-guide/source/keyterms.rst index e858550..f493bab 100644 --- a/doc/plugin-guide/source/terms.rst +++ b/doc/plugin-guide/source/keyterms.rst @@ -5,13 +5,13 @@ 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. + network services, servers, and other network hardware. VIP Virtual IP Address. SNMP trap - A message which is send from agent (for example Extreme Networks switch) to + A message which is send from agent (for example, from Extreme Networks switch) to monitoring manager. SNMP community diff --git a/doc/plugin-guide/source/limitations.rst b/doc/plugin-guide/source/limitations.rst new file mode 100644 index 0000000..b691d77 --- /dev/null +++ b/doc/plugin-guide/source/limitations.rst @@ -0,0 +1,5 @@ +Limitations +=========== + +The plugin only supports neutron when specifying network settings. Old legacy mode (nova-network) is not supported + diff --git a/doc/plugin-guide/source/purpose.rst b/doc/plugin-guide/source/purpose.rst new file mode 100644 index 0000000..4ac8132 --- /dev/null +++ b/doc/plugin-guide/source/purpose.rst @@ -0,0 +1,8 @@ +================ +Document purpose +================ + +This document provides instructions for installing, configuring and using +Extreme Networks hardware monitoring extension to the Zabbix monitoring +plugin for Fuel. + diff --git a/doc/plugin-guide/source/revisionhistory.rst b/doc/plugin-guide/source/revisionhistory.rst new file mode 100644 index 0000000..0b5df9b --- /dev/null +++ b/doc/plugin-guide/source/revisionhistory.rst @@ -0,0 +1,27 @@ +================ +Revision history +================ + +======= ============= ============================ ===================== +Version Revision date Editor Comment +======= ============= ============================ ===================== +0.1 06.22.2015 Piotr Misiak First release + (pmisiak@mirantis.com) +------- ------------- ---------------------------- --------------------- +0.2 08.13.2015 Piotr Misiak Updated release + (pmisiak@mirantis.com) +------- ------------- ---------------------------- --------------------- +0.3 09.02.2015 Marciej Relewicz Updated for fix + (mrelewicz@mirantis.com) +------- ------------- ---------------------------- --------------------- +0.4 09.15.2015 Marciej Relewicz Updated documentation + (mrelewicz@mirantis.com) +------- ------------- ---------------------------- --------------------- +1.0.0 11.20.2015 Swann Croiset New Major version + (scroiset@mirantis.com) +------- ------------- ---------------------------- --------------------- +1.0.1 03.14.2016 Olivier Bourdon Added MOS 8.0 support + (obourdon@mirantis.com) + Doc fixes +======= ============= ============================ ===================== + diff --git a/doc/plugin-guide/source/troubleshooting.rst b/doc/plugin-guide/source/troubleshooting.rst new file mode 100644 index 0000000..5744c7b --- /dev/null +++ b/doc/plugin-guide/source/troubleshooting.rst @@ -0,0 +1,83 @@ +=============== +Troubleshooting +=============== + +.. highlight:: none + +Running processes +================= + +After a successfull deployment the following processes should be running on +the controller node which runs the Zabbix server (lines have been wrapped +for more readability):: + + root 10222 1 0 13:54 ? 00:00:00 + /usr/sbin/snmptrapd -Lsd -p /var/run/snmptrapd.pid + root 10330 1 0 13:54 ? 00:00:00 + /usr/bin/perl /usr/sbin/snmptt --daemon + snmptt 10331 10330 0 13:54 ? 00:00:00 + /usr/bin/perl /usr/sbin/snmptt --daemon + snmp 19521 1 0 13:49 ? 00:00:00 + /usr/sbin/snmpd -Lsd -Lf /dev/null -u snmp -g snmp -I + -smux mteTrigger mteTriggerConf -p /var/run/snmpd.pid + +This processes ensure that the SNMP traps can be handled by Zabbix + +If some of them do not run, please try to relaunch them appropriately using one of the following commands:: + + # service snmpd restart + # service snmptt restart + +For the snmptrapper process, please make sure the contents of the corresponding +Zabbix configuration file is accurate:: + + # cat /etc/zabbix/conf.d/zabbix_snmp.conf + ### Managed by Puppet ### + # This is SNMP config file for ZABBIX server process + # To get more information about ZABBIX, + # go http://www.zabbix.com + + ############ GENERAL PARAMETERS ################# + + #SNMP Trapper + StartSNMPTrapper=1 + SNMPTrapperFile=/var/log/snmptt/snmptt.log + +and potentially restart the Zabbix server process which is managed by pacemaker. +See Zabbix Plugin for Fuel Documentation to see how to do this. + +Finding the management VIP to use to send SNMP traps +==================================================== + +On the Fuel master node, use the primary controller node (here node-3):: + + # ssh -q node-3 ip netns exec haproxy ifconfig b_zbx_vip_mgmt | \ + grep 'inet addr:' | sed -e 's/[^:]*://' -e 's/ .*//' + 192.168.0.3 + +Note that there is another way to find this:: + + # ssh -q node-3 "awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \ + /etc/astute.yaml" | sed -e 's/.*: //' + 192.168.0.3 + +SNMP processes log files +======================== + +The files can be found under:: + + /var/log/snmptt/snmpttsystem.log + +Zabbix log files +================ + +On any of the cluster node, you might want to look into the Zabbix +agents and server log files under:: + + /var/log/zabbix + +Additional reading +================== + +See Zabbix Plugin for Fuel Documentation and Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional troubleshooting tips +