summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlivier Bourdon <obourdon@mirantis.com>2016-03-14 17:59:33 +0100
committerOlivier Bourdon <obourdon@mirantis.com>2016-03-21 12:38:57 +0100
commit2e68d2ac586cafa1adca175b033d8da18df1e2a6 (patch)
treea1489bb8efc134400c7730297738982a0df44b05
parentce5666608f6087a97730ec475db7af963e01cc91 (diff)
Uniformize docs across supported versions and output formats
Notes
Notes (review): Code-Review+2: Swann Croiset <scroiset@mirantis.com> Code-Review+2: Olivier Bourdon <obourdon@mirantis.com> Workflow+1: Olivier Bourdon <obourdon@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Mon, 21 Mar 2016 11:41:06 +0000 Reviewed-on: https://review.openstack.org/292513 Project: openstack/fuel-plugin-zabbix-monitoring-extreme-networks Branch: refs/heads/master
-rw-r--r--doc/plugin-guide/source/appendix.rst34
-rw-r--r--doc/plugin-guide/source/changelog.rst11
-rw-r--r--doc/plugin-guide/source/conf.py27
-rw-r--r--doc/plugin-guide/source/description.rst6
-rw-r--r--doc/plugin-guide/source/guide.rst76
-rw-r--r--doc/plugin-guide/source/index.rst26
-rw-r--r--doc/plugin-guide/source/installation.rst48
-rw-r--r--doc/plugin-guide/source/keyterms.rst (renamed from doc/plugin-guide/source/terms.rst)4
-rw-r--r--doc/plugin-guide/source/limitations.rst5
-rw-r--r--doc/plugin-guide/source/purpose.rst8
-rw-r--r--doc/plugin-guide/source/revisionhistory.rst27
-rw-r--r--doc/plugin-guide/source/troubleshooting.rst83
12 files changed, 288 insertions, 67 deletions
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 @@
2Appendix 2Appendix
3======== 3========
4 4
5`Zabbix 2.4 documentation - SNMP traps <https://www.zabbix.com/documentation/2.4/manual/config/items/itemtypes/snmptrap>`_ 5.. _links:
6
7Links
8=====
9
10- `Zabbix Official site <http://www.zabbix.com>`_
11- `Zabbix 2.4 documentation <https://www.zabbix.com/documentation/2.4/start>`_
12- `Zabbix 2.4 documentation - SNMP traps <https://www.zabbix.com/documentation
13 /2.4/manual/config/items/itemtypes/snmptrap>`_
14- `Zabbix 2.4 documentation - Templates <https://www.zabbix.com/documentation
15 /2.4/manual/config/templates>`_
16- `Fuel Plugins CLI guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0
17 /user-guide.html#fuel-plugins-cli>`_
18
19.. _licenses:
20
21Components licenses
22===================
23
24deb packages
25------------
26
27rpm packages
28------------
29
30puppet modules
31--------------
32
33==== ==========
34Name License
35==== ==========
36snmp Apache 2.0
37==== ==========
6 38
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 @@
1Release notes / Changelog
2=========================
3
4**1.0.1**
5
6* Compatibility with MOS 8.0
7
8**1.0.0**
9
10* This is the first release of the plugin.
11
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 @@
1# -*- coding: utf-8 -*- 1# -*- coding: utf-8 -*-
2# 2#
3# The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension documentation build configuration file, created by 3# The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension documentation build configuration file, created by
4# sphinx-quickstart on Tue Nov 3 10:53:03 2015. 4# sphinx-quickstart on Wed Feb 24 17:05:59 2016.
5# 5#
6# This file is execfile()d with the current directory set to its 6# This file is execfile()d with the current directory set to its
7# containing dir. 7# containing dir.
@@ -14,7 +14,6 @@
14 14
15import sys 15import sys
16import os 16import os
17import shlex
18 17
19# If extensions (or modules to document with autodoc) are in another directory, 18# If extensions (or modules to document with autodoc) are in another directory,
20# add these directories to sys.path here. If the directory is relative to the 19# add these directories to sys.path here. If the directory is relative to the
@@ -29,9 +28,7 @@ import shlex
29# Add any Sphinx extension module names here, as strings. They can be 28# Add any Sphinx extension module names here, as strings. They can be
30# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom 29# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31# ones. 30# ones.
32extensions = [ 31extensions = [ ]
33 'sphinx.ext.todo',
34]
35 32
36# Add any paths that contain templates here, relative to this directory. 33# Add any paths that contain templates here, relative to this directory.
37templates_path = ['_templates'] 34templates_path = ['_templates']
@@ -49,8 +46,8 @@ master_doc = 'index'
49 46
50# General information about the project. 47# General information about the project.
51project = u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension' 48project = u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension'
52copyright = u'2016, Mirantis' 49copyright = u'2016, Mirantis Inc.'
53author = u'Mirantis' 50author = u'Mirantis Inc.'
54 51
55# The version info for the project you're documenting, acts as replacement for 52# The version info for the project you're documenting, acts as replacement for
56# |version| and |release|, also used in various other places throughout the 53# |version| and |release|, also used in various other places throughout the
@@ -66,7 +63,7 @@ release = '1.0-1.0.1-1'
66# 63#
67# This is also used if you do content translation via gettext catalogs. 64# This is also used if you do content translation via gettext catalogs.
68# Usually you set "language" from the command line for these cases. 65# Usually you set "language" from the command line for these cases.
69language = None 66#language = None
70 67
71# There are two options for replacing |today|: either, you set today to some 68# There are two options for replacing |today|: either, you set today to some
72# non-false value, then it is used: 69# non-false value, then it is used:
@@ -76,7 +73,7 @@ language = None
76 73
77# List of patterns, relative to source directory, that match files and 74# List of patterns, relative to source directory, that match files and
78# directories to ignore when looking for source files. 75# directories to ignore when looking for source files.
79exclude_patterns = [] 76#exclude_patterns = []
80 77
81# The reST default role (used for this markup: `text`) to use for all 78# The reST default role (used for this markup: `text`) to use for all
82# documents. 79# documents.
@@ -103,14 +100,14 @@ pygments_style = 'sphinx'
103#keep_warnings = False 100#keep_warnings = False
104 101
105# If true, `todo` and `todoList` produce output, else they produce nothing. 102# If true, `todo` and `todoList` produce output, else they produce nothing.
106todo_include_todos = True 103#todo_include_todos = True
107 104
108 105
109# -- Options for HTML output ---------------------------------------------- 106# -- Options for HTML output ----------------------------------------------
110 107
111# The theme to use for HTML and HTML Help pages. See the documentation for 108# The theme to use for HTML and HTML Help pages. See the documentation for
112# a list of builtin themes. 109# a list of builtin themes.
113html_theme = 'classic' 110html_theme = 'default'
114 111
115# Theme options are theme-specific and customize the look and feel of a theme 112# Theme options are theme-specific and customize the look and feel of a theme
116# further. For a list of options available for each theme, see the 113# further. For a list of options available for each theme, see the
@@ -218,13 +215,16 @@ latex_elements = {
218 215
219# Latex figure (float) alignment 216# Latex figure (float) alignment
220#'figure_align': 'htbp', 217#'figure_align': 'htbp',
218
219'classoptions': ',openany,oneside',
220'babel': '\\usepackage[english]{babel}'
221} 221}
222 222
223# Grouping the document tree into LaTeX files. List of tuples 223# Grouping the document tree into LaTeX files. List of tuples
224# (source start file, target name, title, 224# (source start file, target name, title,
225# author, documentclass [howto, manual, or own class]). 225# author, documentclass [howto, manual, or own class]).
226latex_documents = [ 226latex_documents = [
227 (master_doc, 'TheZabbixpluginforFuelExtremeNetworksExtension.tex', u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension Documentation', 227 (master_doc, 'TheZabbixpluginforFuelExtremeNetworksExtension-' + version + '.tex', u'The Zabbix plugin for Fuel Extreme Networks hardware monitoring extension Documentation',
228 author, 'manual'), 228 author, 'manual'),
229] 229]
230 230
@@ -283,3 +283,6 @@ texinfo_documents = [
283 283
284# If true, do not generate a @detailmenu in the "Top" node's menu. 284# If true, do not generate a @detailmenu in the "Top" node's menu.
285#texinfo_no_detailmenu = False 285#texinfo_no_detailmenu = False
286
287# Insert footnotes where they are defined instead of at the end.
288pdf_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 @@
1================================================================ 1=============================================================================
2Extreme Networks hardware monitoring extension for Zabbix plugin 2Guide to the Extreme Networks hardware monitoring extension for Zabbix plugin
3================================================================ 3=============================================================================
4 4
5Extreme Networks hardware monitoring extension plugin extends Zabbix plugin 5Extreme Networks hardware monitoring extension plugin extends Zabbix plugin
6functionality by adding monitoring of incoming SNMP traps sent from Extreme 6functionality 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 @@
2User Guide 2User Guide
3========== 3==========
4 4
5Important preliminary notes
6===========================
7
8- It is highly recommended to do a network verification check prior
9 to any deployment.
10- This plugin version only supports Ubuntu OS type.
11- You can also choose any supervisor and/or also change the
12 networking configuration according to your needs but you can not use
13 the old legacy networking mode (nova-network) as this is not supported.
14- See Zabbix Plugin for Fuel Documentation for additional notes
15- See Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional notes
16
17Known problems
18==============
19
20- `#1538617 <https://bugs.launchpad.net/fuel-plugins/+bug/1538617>`_:
21 Cross-plugin display restrictions for some plugins prevent Settings tab from opening.
22- See Zabbix Plugin for Fuel Documentation for additional problems
23- See Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional problems
24
5Environment configuration 25Environment configuration
6========================= 26=========================
7 27
81. Create an environment. For more information about environment creation, see 28.. highlight:: none
29
30#. Create an environment. For more information about environment creation, see
9 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel 31 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
10 /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_. 32 /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
112. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix 33
34#. Enable and configure Zabbix plugin for Fuel. For instructions, see Zabbix
12 Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com 35 Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com
13 /products/openstack-drivers-and-plugins/fuel-plugins/>`_. 36 /products/openstack-drivers-and-plugins/fuel-plugins/>`_.
143. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions, 37
15 see Zabbix Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis 38#. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions,
16 .com/products/openstack-drivers-and-plugins/fuel-plugins/>`_. 39 see Zabbix Plugin Guide and Zabbix SNMP Trap Daemon Plugin Guide
174. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left 40 in the `Fuel Plugins Catalog <https://www.mirantis.com/products/
41 openstack-drivers-and-plugins/fuel-plugins/>`_.
42
43#. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left
18 choose *Extreme Networks hardware monitoring extension for Zabbix plugin*, 44 choose *Extreme Networks hardware monitoring extension for Zabbix plugin*,
19 select the plugin checkbox and optionally fill in *Extreme Networks hardware 45 select the plugin checkbox and optionally fill in *Extreme Networks hardware
20 to monitor* parameter: 46 to monitor* parameter:
@@ -24,14 +50,15 @@ Environment configuration
24 50
25 When you add your hardware to the *Extreme Networks hardware to monitor* 51 When you add your hardware to the *Extreme Networks hardware to monitor*
26 comma separated list, then the plugin will automatically configure 52 comma separated list, then the plugin will automatically configure
27 monitoring for hardware in Zabbix by doing following actions: 53 monitoring for this hardware in Zabbix by doing following actions:
28 54
29 - create a Host with provided Name and IP address 55 - create a Host with provided Name and IP address
30 - link the Extreme Networks monitoring template to the Host 56 - link the Extreme Networks monitoring template to the Host
31 57
32 If you leave the parameter empty, you will have to add your hardware to 58 If you leave the parameter empty, you will have to add your hardware to
33 Zabbix manually. 59 Zabbix manually.
345. Adjust other environment settings to your requirements and deploy the 60
61#. Adjust other environment settings to your requirements and deploy the
35 environment. For more information, see 62 environment. For more information, see
36 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel 63 `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
37 /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_. 64 /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
@@ -39,13 +66,12 @@ Environment configuration
39User Guide 66User Guide
40========== 67==========
41 68
42To test if everything is configured properly, follow these steps: 69To test if everything is installed and configured properly, follow these steps:
43 70
441. Generate an example SNMP trap by running the following command from any 71#. Generate a SNMP test trap by running the following command from any node::
45 node::
46 72
47 [root@node-46 ~]# snmptrap -v 1 -c <SNMP_community> \ 73 # snmptrap -v 1 -c <SNMP_community> <mgmt_VIP_address> \
48 <zabbix_VIP_address> '.1.3.6.1.4.1.1916' <host_ip_address> 6 10 '10' \ 74 '.1.3.6.1.4.1.1916' <host_ip_address> 6 10 '10' \
49 .1.3.6.1.4.1.1916 s "null" .1.3.6.1.4.1.1916 s "null" \ 75 .1.3.6.1.4.1.1916 s "null" .1.3.6.1.4.1.1916 s "null" \
50 .1.3.6.1.4.1.1916 s "2" 76 .1.3.6.1.4.1.1916 s "2"
51 77
@@ -58,17 +84,16 @@ To test if everything is configured properly, follow these steps:
58 .. image:: ../images/snmptrapd_settings.png 84 .. image:: ../images/snmptrapd_settings.png
59 :width: 100% 85 :width: 100%
60 86
61 *<zabbix_VIP_address>* 87 *<mgmt_VIP_address>*
62 88
63 If you don’t know the address, run the following command on any node:: 89 If you don’t know the address, run the following command on any node::
64 90
65 [root@node-46 ~]# grep -A2 ^zbx_vip_mgmt /etc/astute.yaml 91 # awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \
92 /etc/astute.yaml | sed -e 's/.*: //'
66 93
67 You should get the required VIP in the output:: 94 You should get the required VIP in the output::
68 95
69 zbx_vip_mgmt: 96 192.168.0.3
70 network_role: zabbix
71 ipaddr: 192.168.0.1
72 97
73 *<host_IP_address>* 98 *<host_IP_address>*
74 99
@@ -76,7 +101,7 @@ To test if everything is configured properly, follow these steps:
76 hardware to monitor* parameter 101 hardware to monitor* parameter
77 102
78 103
792. After several seconds of running the snmptrap command you should see a new 104#. After several seconds of running the snmptrap command you should see a new
80 event in the Last 20 issues section of the Zabbix Dashboard (for information 105 event in the Last 20 issues section of the Zabbix Dashboard (for information
81 on how to login to Zabbix Web Interface see Zabbix Plugin Guide in the `Fuel 106 on how to login to Zabbix Web Interface see Zabbix Plugin Guide in the `Fuel
82 Plugins Catalog <https://www.mirantis.com/products/ 107 Plugins Catalog <https://www.mirantis.com/products/
@@ -98,7 +123,7 @@ To test if everything is configured properly, follow these steps:
98 .. image:: ../images/history.png 123 .. image:: ../images/history.png
99 :width: 100% 124 :width: 100%
100 125
1013. After clicking *Configuration* tab and selecting *Hosts* option, you will 126#. After clicking *Configuration* tab and selecting *Hosts* option, you will
102 see a list of hosts with linked monitoring templates. There should be one 127 see a list of hosts with linked monitoring templates. There should be one
103 host for every hardware listed in the *Extreme Networks hardware to monitor* 128 host for every hardware listed in the *Extreme Networks hardware to monitor*
104 plugin parameter: 129 plugin parameter:
@@ -113,19 +138,18 @@ You have to configure your hardware to enable SNMP traps sending. To do this,
113refer to your hardware’s manual. Generally, you have to set these two 138refer to your hardware’s manual. Generally, you have to set these two
114parameters on your hardware: 139parameters on your hardware:
115 140
1161. SNMP manager - set to Zabbix VIP address of your environment 141#. SNMP manager - set to Zabbix VIP address of your environment
117 142
118 If you don’t know the address, run the following command on any node:: 143 If you don’t know the address, run the following command on any node::
119 144
120 [root@node-46 ~]# grep -A2 ^zbx_vip_mgmt /etc/astute.yaml 145 # awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \
146 /etc/astute.yaml | sed -e 's/.*: //'
121 147
122 You should get the required VIP in the output:: 148 You should get the required VIP in the output::
123 149
124 zbx_vip_mgmt: 150 192.168.0.3
125 network_role: zabbix
126 ipaddr: 192.168.0.1
127 151
1282. SNMP community - set the same value as in the *SNMP community* parameter 152#. SNMP community - set the same value as in the *SNMP community* parameter
129 from the SNMP trap daemon for Zabbix plugin settings: 153 from the SNMP trap daemon for Zabbix plugin settings:
130 154
131 .. image:: ../images/snmptrapd_settings.png 155 .. image:: ../images/snmptrapd_settings.png
diff --git a/doc/plugin-guide/source/index.rst b/doc/plugin-guide/source/index.rst
index 83d1204..41c6944 100644
--- a/doc/plugin-guide/source/index.rst
+++ b/doc/plugin-guide/source/index.rst
@@ -1,16 +1,18 @@
1***************************************************************************** 1=====================================================================================================
2Guide to the Extreme Networks hardware monitoring extension for Zabbix plugin 2Welcome to the Zabbix Extreme Networks hardware monitoring extension plugin for Fuel's documentation!
3***************************************************************************** 3=====================================================================================================
4
5This document provides instructions for installing, configuring and using
6Extreme Networks hardware monitoring extension for Zabbix plugin.
7 4
8.. toctree:: 5.. toctree::
9 :maxdepth: 2 6 :maxdepth: 3
10 7
11 terms.rst 8 revisionhistory
12 description.rst 9 purpose
13 installation.rst 10 keyterms
14 guide.rst 11 description
15 appendix.rst 12 changelog
13 limitations
14 installation
15 guide
16 troubleshooting
17 appendix
16 18
diff --git a/doc/plugin-guide/source/installation.rst b/doc/plugin-guide/source/installation.rst
index 939f8a8..09b94ff 100644
--- a/doc/plugin-guide/source/installation.rst
+++ b/doc/plugin-guide/source/installation.rst
@@ -2,33 +2,38 @@
2Installation Guide 2Installation Guide
3================== 3==================
4 4
5Installing Extreme Networks hardware monitoring extension 5Extreme Networks hardware monitoring extension installation
6========================================================= 6===========================================================
7 7
8To install Extreme Networks hardware monitoring extension for Zabbix plugin, 8To install Extreme Networks hardware monitoring extension for Zabbix plugin,
9follow these steps: 9follow these steps:
10 10
111. Download and install the Zabbix plugin for Fuel from the 11.. highlight:: none
12
13#. Download and install the Zabbix plugin for Fuel from the
12 `Fuel Plugins Catalog <https://www.mirantis.com/products/ 14 `Fuel Plugins Catalog <https://www.mirantis.com/products/
13 openstack-drivers-and-plugins/fuel-plugins/>`_. 15 openstack-drivers-and-plugins/fuel-plugins/>`_.
142. Download and install the SNMP trap daemon for Zabbix plugin from the 16
17#. Download and install the SNMP trap daemon for Zabbix plugin from the
15 `Fuel Plugins Catalog <https://www.mirantis.com/products/ 18 `Fuel Plugins Catalog <https://www.mirantis.com/products/
16 openstack-drivers-and-plugins/fuel-plugins/>`_. 19 openstack-drivers-and-plugins/fuel-plugins/>`_.
173. Download the Extreme Networks hardware monitoring extension for Zabbix 20
21#. Download the Extreme Networks hardware monitoring extension for Zabbix
18 plugin from the `Fuel Plugins Catalog <https://www.mirantis.com/products/ 22 plugin from the `Fuel Plugins Catalog <https://www.mirantis.com/products/
19 openstack-drivers-and-plugins/fuel-plugins/>`_. 23 openstack-drivers-and-plugins/fuel-plugins/>`_.
204. Copy all three plugins from your local machine to a previously deployed 24
25#. Copy all three plugins from your local machine to a previously deployed
21 Fuel Master node using ssh. If you do not have the Fuel Master node yet, 26 Fuel Master node using ssh. If you do not have the Fuel Master node yet,
22 see `Quick Start Guide <https://software.mirantis.com/quick-start/>`_:: 27 see `Quick Start Guide <https://software.mirantis.com/quick-start/>`_::
23 28
24 # scp zabbix_monitoring-2.5-2.5.0-1.noarch.rpm \ 29 # scp zabbix_monitoring-2.5-2.5.0-1.noarch.rpm \
25 root@<The_Fuel_Master_node_IP>:/tmp 30 root@<Fuel_Master_IP>:/tmp
26 # scp zabbix_snmptrapd-1.0-1.0.1-1.noarch.rpm \ 31 # scp zabbix_snmptrapd-1.0-1.0.1-1.noarch.rpm \
27 root@<The_Fuel_Master_node_IP>:/tmp 32 root@<Fuel_Master_IP>:/tmp
28 # scp zabbix_monitoring_extreme_networks-1.0-1.0.1-1.noarch.rpm \ 33 # scp zabbix_monitoring_extreme_networks-1.0-1.0.1-1.noarch.rpm \
29 root@<The_Fuel_Master_node_IP>:/tmp 34 root@<Fuel_Master_IP>:/tmp
30 35
315. Log into the Fuel Master node. Install each of the three plugins using 36#. Log into the Fuel Master node. Install each of the three plugins using
32 the following commands:: 37 the following commands::
33 38
34 # cd /tmp 39 # cd /tmp
@@ -39,7 +44,7 @@ follow these steps:
39 # fuel plugins --install \ 44 # fuel plugins --install \
40 zabbix_monitoring_extreme_networks-1.0-1.0.1-1.noarch.rpm 45 zabbix_monitoring_extreme_networks-1.0-1.0.1-1.noarch.rpm
41 46
426. Make sure the plugins were installed correctly:: 476# Make sure the plugins were installed correctly::
43 48
44 # fuel plugins 49 # fuel plugins
45 id | name | version | package_version 50 id | name | version | package_version
@@ -48,3 +53,24 @@ follow these steps:
48 2 | zabbix_snmptrapd | 1.0.1 | 2.0.0 53 2 | zabbix_snmptrapd | 1.0.1 | 2.0.0
49 3 | zabbix_monitoring_extreme_networks | 1.0.1 | 2.0.0 54 3 | zabbix_monitoring_extreme_networks | 1.0.1 | 2.0.0
50 55
56Extreme Networks hardware monitoring extension removal
57======================================================
58
59To uninstall Extreme Networks hardware monitoring extension for Zabbix plugin,
60follow these steps:
61
62#. Delete all Environments in which Extreme Networks hardware monitoring extension
63for Zabbix plugin has been enabled.
64
65#. Uninstall the plugin::
66
67 # fuel plugins --remove zabbix_monitoring_extreme_networks==1.0.1
68
69#. Check if the plugin was uninstalled successfully::
70
71 # fuel plugins
72 id | name | version | package_version
73 ---|---------------------------|----------|----------------
74 ...
75 You can still have other plugins listed here but not zabbix_monitoring_extreme_networks
76
diff --git a/doc/plugin-guide/source/terms.rst b/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
5Zabbix 5Zabbix
6 An enterprise open source monitoring solution for networks and 6 An enterprise open source monitoring solution for networks and
7 applications. It is designed to monitor and track the status of various 7 applications. It is designed to monitor and track the status of various
8 network services,servers, and other network hardware. 8 network services, servers, and other network hardware.
9 9
10VIP 10VIP
11 Virtual IP Address. 11 Virtual IP Address.
12 12
13SNMP trap 13SNMP trap
14 A message which is send from agent (for example Extreme Networks switch) to 14 A message which is send from agent (for example, from Extreme Networks switch) to
15 monitoring manager. 15 monitoring manager.
16 16
17SNMP community 17SNMP 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 @@
1Limitations
2===========
3
4The plugin only supports neutron when specifying network settings. Old legacy mode (nova-network) is not supported
5
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 @@
1================
2Document purpose
3================
4
5This document provides instructions for installing, configuring and using
6Extreme Networks hardware monitoring extension to the Zabbix monitoring
7plugin for Fuel.
8
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 @@
1================
2Revision history
3================
4
5======= ============= ============================ =====================
6Version Revision date Editor Comment
7======= ============= ============================ =====================
80.1 06.22.2015 Piotr Misiak First release
9 (pmisiak@mirantis.com)
10------- ------------- ---------------------------- ---------------------
110.2 08.13.2015 Piotr Misiak Updated release
12 (pmisiak@mirantis.com)
13------- ------------- ---------------------------- ---------------------
140.3 09.02.2015 Marciej Relewicz Updated for fix
15 (mrelewicz@mirantis.com)
16------- ------------- ---------------------------- ---------------------
170.4 09.15.2015 Marciej Relewicz Updated documentation
18 (mrelewicz@mirantis.com)
19------- ------------- ---------------------------- ---------------------
201.0.0 11.20.2015 Swann Croiset New Major version
21 (scroiset@mirantis.com)
22------- ------------- ---------------------------- ---------------------
231.0.1 03.14.2016 Olivier Bourdon Added MOS 8.0 support
24 (obourdon@mirantis.com)
25 Doc fixes
26======= ============= ============================ =====================
27
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 @@
1===============
2Troubleshooting
3===============
4
5.. highlight:: none
6
7Running processes
8=================
9
10After a successfull deployment the following processes should be running on
11the controller node which runs the Zabbix server (lines have been wrapped
12for more readability)::
13
14 root 10222 1 0 13:54 ? 00:00:00
15 /usr/sbin/snmptrapd -Lsd -p /var/run/snmptrapd.pid
16 root 10330 1 0 13:54 ? 00:00:00
17 /usr/bin/perl /usr/sbin/snmptt --daemon
18 snmptt 10331 10330 0 13:54 ? 00:00:00
19 /usr/bin/perl /usr/sbin/snmptt --daemon
20 snmp 19521 1 0 13:49 ? 00:00:00
21 /usr/sbin/snmpd -Lsd -Lf /dev/null -u snmp -g snmp -I
22 -smux mteTrigger mteTriggerConf -p /var/run/snmpd.pid
23
24This processes ensure that the SNMP traps can be handled by Zabbix
25
26If some of them do not run, please try to relaunch them appropriately using one of the following commands::
27
28 # service snmpd restart
29 # service snmptt restart
30
31For the snmptrapper process, please make sure the contents of the corresponding
32Zabbix configuration file is accurate::
33
34 # cat /etc/zabbix/conf.d/zabbix_snmp.conf
35 ### Managed by Puppet ###
36 # This is SNMP config file for ZABBIX server process
37 # To get more information about ZABBIX,
38 # go http://www.zabbix.com
39
40 ############ GENERAL PARAMETERS #################
41
42 #SNMP Trapper
43 StartSNMPTrapper=1
44 SNMPTrapperFile=/var/log/snmptt/snmptt.log
45
46and potentially restart the Zabbix server process which is managed by pacemaker.
47See Zabbix Plugin for Fuel Documentation to see how to do this.
48
49Finding the management VIP to use to send SNMP traps
50====================================================
51
52On the Fuel master node, use the primary controller node (here node-3)::
53
54 # ssh -q node-3 ip netns exec haproxy ifconfig b_zbx_vip_mgmt | \
55 grep 'inet addr:' | sed -e 's/[^:]*://' -e 's/ .*//'
56 192.168.0.3
57
58Note that there is another way to find this::
59
60 # ssh -q node-3 "awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \
61 /etc/astute.yaml" | sed -e 's/.*: //'
62 192.168.0.3
63
64SNMP processes log files
65========================
66
67The files can be found under::
68
69 /var/log/snmptt/snmpttsystem.log
70
71Zabbix log files
72================
73
74On any of the cluster node, you might want to look into the Zabbix
75agents and server log files under::
76
77 /var/log/zabbix
78
79Additional reading
80==================
81
82See Zabbix Plugin for Fuel Documentation and Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional troubleshooting tips
83