Browse Source

Uniformize docs across supported versions and output formats

Change-Id: If213a0a7eb3c1b9fbb037fa7e754fa1339e77fe2
tags/1.0.1-1-rc1
Olivier Bourdon 3 years ago
parent
commit
bc67fcce7b

+ 33
- 1
doc/plugin-guide/source/appendix.rst View File

@@ -2,5 +2,37 @@
2 2
 Appendix
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
+
7
+Links
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
+
21
+Components licenses
22
+===================
23
+
24
+deb packages
25
+------------
26
+
27
+rpm packages
28
+------------
29
+
30
+puppet modules
31
+--------------
32
+
33
+==== ==========
34
+Name License
35
+==== ==========
36
+snmp Apache 2.0
37
+==== ==========
6 38
 

+ 11
- 0
doc/plugin-guide/source/changelog.rst View File

@@ -0,0 +1,11 @@
1
+Release 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
+

+ 15
- 12
doc/plugin-guide/source/conf.py View File

@@ -1,7 +1,7 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 #
3 3
 # The Zabbix plugin for Fuel EMC 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 6
 # This file is execfile()d with the current directory set to its
7 7
 # containing dir.
@@ -14,7 +14,6 @@
14 14
 
15 15
 import sys
16 16
 import os
17
-import shlex
18 17
 
19 18
 # If extensions (or modules to document with autodoc) are in another directory,
20 19
 # add these directories to sys.path here. If the directory is relative to the
@@ -29,9 +28,7 @@ import shlex
29 28
 # Add any Sphinx extension module names here, as strings. They can be
30 29
 # extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
31 30
 # ones.
32
-extensions = [
33
-    'sphinx.ext.todo',
34
-]
31
+extensions = [ ]
35 32
 
36 33
 # Add any paths that contain templates here, relative to this directory.
37 34
 templates_path = ['_templates']
@@ -49,8 +46,8 @@ master_doc = 'index'
49 46
 
50 47
 # General information about the project.
51 48
 project = u'The Zabbix plugin for Fuel EMC hardware monitoring extension'
52
-copyright = u'2016, Mirantis'
53
-author = u'Mirantis'
49
+copyright = u'2016, Mirantis Inc.'
50
+author = u'Mirantis Inc.'
54 51
 
55 52
 # The version info for the project you're documenting, acts as replacement for
56 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 64
 # This is also used if you do content translation via gettext catalogs.
68 65
 # Usually you set "language" from the command line for these cases.
69
-language = None
66
+#language = None
70 67
 
71 68
 # There are two options for replacing |today|: either, you set today to some
72 69
 # non-false value, then it is used:
@@ -76,7 +73,7 @@ language = None
76 73
 
77 74
 # List of patterns, relative to source directory, that match files and
78 75
 # directories to ignore when looking for source files.
79
-exclude_patterns = []
76
+#exclude_patterns = []
80 77
 
81 78
 # The reST default role (used for this markup: `text`) to use for all
82 79
 # documents.
@@ -103,14 +100,14 @@ pygments_style = 'sphinx'
103 100
 #keep_warnings = False
104 101
 
105 102
 # If true, `todo` and `todoList` produce output, else they produce nothing.
106
-todo_include_todos = True
103
+#todo_include_todos = True
107 104
 
108 105
 
109 106
 # -- Options for HTML output ----------------------------------------------
110 107
 
111 108
 # The theme to use for HTML and HTML Help pages.  See the documentation for
112 109
 # a list of builtin themes.
113
-html_theme = 'classic'
110
+html_theme = 'default'
114 111
 
115 112
 # Theme options are theme-specific and customize the look and feel of a theme
116 113
 # further.  For a list of options available for each theme, see the
@@ -218,13 +215,16 @@ latex_elements = {
218 215
 
219 216
 # Latex figure (float) alignment
220 217
 #'figure_align': 'htbp',
218
+
219
+'classoptions': ',openany,oneside',
220
+'babel': '\\usepackage[english]{babel}'
221 221
 }
222 222
 
223 223
 # Grouping the document tree into LaTeX files. List of tuples
224 224
 # (source start file, target name, title,
225 225
 #  author, documentclass [howto, manual, or own class]).
226 226
 latex_documents = [
227
-  (master_doc, 'TheZabbixpluginforFuelEMCExtension.tex', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Documentation',
227
+  (master_doc, 'TheZabbixpluginforFuelEMCExtension-' + version + '.tex', u'The Zabbix plugin for Fuel EMC hardware monitoring extension Documentation',
228 228
    author, 'manual'),
229 229
 ]
230 230
 
@@ -283,3 +283,6 @@ texinfo_documents = [
283 283
 
284 284
 # If true, do not generate a @detailmenu in the "Top" node's menu.
285 285
 #texinfo_no_detailmenu = False
286
+
287
+# Insert footnotes where they are defined instead of at the end.
288
+pdf_inline_footnotes = True

+ 3
- 3
doc/plugin-guide/source/description.rst View File

@@ -1,6 +1,6 @@
1
-===================================================
2
-EMC hardware monitoring extension for Zabbix plugin
3
-===================================================
1
+================================================================
2
+Guide to the EMC hardware monitoring extension for Zabbix plugin
3
+================================================================
4 4
 
5 5
 EMC hardware monitoring extension plugin extends Zabbix plugin functionality
6 6
 by adding monitoring of incoming SNMP traps sent from EMC VNX arrays via

+ 51
- 27
doc/plugin-guide/source/guide.rst View File

@@ -2,19 +2,45 @@
2 2
 User Guide
3 3
 ==========
4 4
 
5
+Important 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
+
17
+Known 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
+
5 25
 Environment configuration
6 26
 =========================
7 27
 
8
-1. 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 31
    `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
10 32
    /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
11
-2. 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 35
    Plugin Guide in the `Fuel Plugins Catalog <https://www.mirantis.com
13 36
    /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. On the left
37
+
38
+#. Enable and configure SNMP trap daemon for Zabbix plugin. For instructions,
39
+   see Zabbix Plugin Guide and Zabbix SNMP Trap Daemon Plugin Guide
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 44
    choose *EMC hardware monitoring extension for Zabbix plugin*, select the
19 45
    plugin checkbox and optionally fill in *EMC hardware to monitor* parameter:
20 46
 
@@ -22,15 +48,16 @@ Environment configuration
22 48
       :width: 100%
23 49
 
24 50
    When you add your hardware to the *EMC hardware to monitor* comma separated
25
-   list, then the plugin will automatically configure monitoring for these
26
-   hardware in Zabbix by doing following actions:
51
+   list, then the plugin will automatically configure monitoring
52
+   for this hardware in Zabbix by doing following actions:
27 53
 
28 54
    - create a Host with provided Name and IP address
29 55
    - link the EMC monitoring template to the Host
30 56
 
31 57
    If you leave the parameter empty, you will have to add your hardware to
32 58
    Zabbix manually.
33
-5. Adjust other environment settings to your requirements and deploy the
59
+
60
+#. Adjust other environment settings to your requirements and deploy the
34 61
    environment. For more information, see
35 62
    `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
36 63
    /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
@@ -38,13 +65,12 @@ Environment configuration
38 65
 User Guide
39 66
 ==========
40 67
 
41
-To test if everything is configured properly, follow these steps:
68
+To test if everything is installed and configured properly, follow these steps:
42 69
 
43
-1. Generate an example SNMP trap by running the following command from any
44
-   node::
70
+#. Generate a SNMP test trap by running the following command from any node::
45 71
 
46
-       [root@node-46 ~]# snmptrap -v 1 -c <SNMP_community> \
47
-       <zabbix_VIP_address> '.1.3.6.1.4.1.1981' <host_ip_address> 6 6 '10' \
72
+       # snmptrap -v 1 -c <SNMP_community> <mgmt_VIP_address> \
73
+       '.1.3.6.1.4.1.1981' <host_ip_address> 6 6 '10' \
48 74
        .1.3.6.1.4.1.1981 s "null" .1.3.6.1.4.1.1981 s "null" \
49 75
        .1.3.6.1.4.1.1981 s "a37"
50 76
 
@@ -57,24 +83,23 @@ To test if everything is configured properly, follow these steps:
57 83
    .. image:: ../images/snmptrapd_settings.png
58 84
       :width: 100%
59 85
 
60
-   *<zabbix_VIP_address>*
86
+   *<mgmt_VIP_address>*
61 87
 
62 88
        If you don’t know the address, run the following command on any node::
63 89
 
64
-           [root@node-46 ~]# grep -A2 ^zbx_vip_mgmt /etc/astute.yaml
90
+	 # awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \
91
+	       /etc/astute.yaml | sed -e 's/.*: //'
65 92
 
66 93
        You should get the required VIP in the output::
67 94
 
68
-           zbx_vip_mgmt:
69
-             network_role: zabbix
70
-             ipaddr: 192.168.0.1
95
+	 192.168.0.3
71 96
 
72 97
    *<host_IP_address>*
73 98
 
74 99
        IP address of EMC hardware filled in *EMC hardware to monitor* parameter
75 100
 
76 101
 
77
-2. After several seconds of running the snmptrap command you should see a new
102
+#. After several seconds of running the snmptrap command you should see a new
78 103
    event in the Last 20 issues section of the Zabbix Dashboard (for information
79 104
    on how to login to Zabbix Web Interface see Zabbix Plugin Guide in the `Fuel
80 105
    Plugins Catalog <https://www.mirantis.com/products/
@@ -96,7 +121,7 @@ To test if everything is configured properly, follow these steps:
96 121
    .. image:: ../images/history.png
97 122
       :width: 100%
98 123
 
99
-3. After clicking *Configuration* tab and selecting *Hosts* option, you will
124
+#. After clicking *Configuration* tab and selecting *Hosts* option, you will
100 125
    see a list of hosts with linked monitoring templates. There should be one
101 126
    host for every hardware listed in the *EMC hardware to monitor* plugin
102 127
    parameter:
@@ -111,19 +136,18 @@ You have to configure your hardware to enable SNMP traps sending. To do this,
111 136
 refer to your hardware’s manual. Generally, you have to set these two
112 137
 parameters on your hardware:
113 138
 
114
-1. SNMP manager - set to Zabbix VIP address of your environment
139
+#. SNMP manager - set to Zabbix VIP address of your environment
115 140
 
116 141
    If you don’t know the address, run the following command on any node::
117 142
 
118
-       [root@node-46 ~]# grep -A2 ^zbx_vip_mgmt /etc/astute.yaml
143
+     # awk '/zbx_vip_mgmt/ {n=1} n==1 && /ipaddr/ {print;exit}' \
144
+     /etc/astute.yaml | sed -e 's/.*: //'
119 145
 
120 146
    You should get the required VIP in the output::
121 147
 
122
-       zbx_vip_mgmt:
123
-         network_role: zabbix
124
-         ipaddr: 192.168.0.1
148
+     192.168.0.3
125 149
 
126
-2. SNMP community - set the same value as in the *SNMP community* parameter
150
+#. SNMP community - set the same value as in the *SNMP community* parameter
127 151
    from the SNMP trap daemon for Zabbix plugin settings:
128 152
 
129 153
    .. image:: ../images/snmptrapd_settings.png

+ 14
- 12
doc/plugin-guide/source/index.rst View File

@@ -1,16 +1,18 @@
1
-****************************************************************
2
-Guide to the EMC hardware monitoring extension for Zabbix plugin
3
-****************************************************************
4
-
5
-This document provides instructions for installing, configuring and using EMC
6
-hardware monitoring extension for Zabbix plugin.
1
+========================================================================================
2
+Welcome to the Zabbix EMC hardware monitoring extension plugin for Fuel's documentation!
3
+========================================================================================
7 4
 
8 5
 .. toctree::
9
-   :maxdepth: 2
6
+   :maxdepth: 3
10 7
 
11
-   terms.rst
12
-   description.rst
13
-   installation.rst
14
-   guide.rst
15
-   appendix.rst
8
+   revisionhistory
9
+   purpose
10
+   keyterms
11
+   description
12
+   changelog
13
+   limitations
14
+   installation
15
+   guide
16
+   troubleshooting
17
+   appendix
16 18
 

doc/plugin-guide/source/terms.rst → doc/plugin-guide/source/keyterms.rst View File

@@ -5,14 +5,14 @@ Key terms, acronyms and abbreviations
5 5
 Zabbix
6 6
     An enterprise open source monitoring solution for networks and
7 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
 
10 10
 VIP
11 11
     Virtual IP Address.
12 12
 
13 13
 SNMP trap
14
-    A message which is send from agent (for example EMC array) to monitoring
15
-    manager.
14
+    A message which is send from agent (for example, from EMC array) to
15
+    monitoring manager.
16 16
 
17 17
 SNMP community
18 18
     A password which is used for incoming SNMP traps authorization.

+ 5
- 0
doc/plugin-guide/source/limitations.rst View File

@@ -0,0 +1,5 @@
1
+Limitations
2
+===========
3
+
4
+The plugin only supports neutron when specifying network settings. Old legacy mode (nova-network) is not supported
5
+

+ 8
- 0
doc/plugin-guide/source/purpose.rst View File

@@ -0,0 +1,8 @@
1
+================
2
+Document purpose
3
+================
4
+
5
+This document provides instructions for installing, configuring and using
6
+EMC hardware monitoring extension to the Zabbix monitoring
7
+plugin for Fuel.
8
+

+ 27
- 0
doc/plugin-guide/source/revisionhistory.rst View File

@@ -0,0 +1,27 @@
1
+================
2
+Revision history
3
+================
4
+
5
+======= ============= ============================ =====================
6
+Version Revision date Editor                       Comment              
7
+======= ============= ============================ =====================
8
+0.1     06.22.2015    Piotr Misiak                 First release
9
+                      (pmisiak@mirantis.com)                            
10
+------- ------------- ---------------------------- ---------------------
11
+0.2     08.13.2015    Piotr Misiak                 Updated release
12
+                      (pmisiak@mirantis.com)                            
13
+------- ------------- ---------------------------- ---------------------
14
+0.3     08.17.2015    Piotr Misiak                 Minor doc updates
15
+                      (pmisiak@mirantis.com)                            
16
+------- ------------- ---------------------------- ---------------------
17
+0.4     09.02.2015    Marciej Relewicz             Updated for fix
18
+                      (mrelewicz@mirantis.com)
19
+------- ------------- ---------------------------- ---------------------
20
+1.0.0   11.20.2015    Swann Croiset                New Major version        
21
+                      (scroiset@mirantis.com)      
22
+------- ------------- ---------------------------- ---------------------
23
+1.0.1   03.14.2016    Olivier Bourdon              Added MOS 8.0 support
24
+                      (obourdon@mirantis.com)      
25
+                                                   Doc fixes
26
+======= ============= ============================ =====================
27
+

+ 83
- 0
doc/plugin-guide/source/troubleshooting.rst View File

@@ -0,0 +1,83 @@
1
+===============
2
+Troubleshooting
3
+===============
4
+
5
+.. highlight:: none
6
+
7
+Running processes
8
+=================
9
+
10
+After a successfull deployment the following processes should be running on
11
+the controller node which runs the Zabbix server (lines have been wrapped
12
+for 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
+
24
+This processes ensure that the SNMP traps can be handled by Zabbix
25
+
26
+If 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
+
31
+For the snmptrapper process, please make sure the contents of the corresponding
32
+Zabbix 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
+
46
+and potentially restart the Zabbix server process which is managed by pacemaker.
47
+See Zabbix Plugin for Fuel Documentation to see how to do this.
48
+
49
+Finding the management VIP to use to send SNMP traps
50
+====================================================
51
+
52
+On 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
+
58
+Note 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
+
64
+SNMP processes log files
65
+========================
66
+
67
+The files can be found under::
68
+
69
+  /var/log/snmptt/snmpttsystem.log
70
+
71
+Zabbix log files
72
+================
73
+
74
+On any of the cluster node, you might want to look into the Zabbix
75
+agents and server log files under::
76
+
77
+  /var/log/zabbix
78
+
79
+Additional reading
80
+==================
81
+
82
+See Zabbix Plugin for Fuel Documentation and Zabbix SNMP Trap Daemon Plugin for Fuel Documentation for additional troubleshooting tips
83
+

Loading…
Cancel
Save