Browse Source

Uniformize docs across supported versions and output formats

Change-Id: I66d8a7664f0c4d78f54039a85a44cf149ba93113
Olivier Bourdon 3 years ago
parent
commit
d9cd88a235

+ 49
- 2
doc/plugin-guide/source/appendix.rst View File

@@ -2,6 +2,53 @@
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
+==================== =======
31
+Name                 License
32
+==================== =======
33
+net-snmp             BSD
34
+net-snmp-libs        BSD
35
+net-snmp-perl        BSD
36
+snmptt               GPLv2+
37
+perl-Config-IniFiles GPL+
38
+perl-Crypt-DES       BSD
39
+perl-Digest-HMAC     GPL+
40
+perl-Digest-SHA1     GPL+
41
+perl-IO-stringy      GPL+
42
+perl-List-MoreUtils  GPL+
43
+perl-Net-SNMP        GPL+
44
+==================== =======
45
+
46
+puppet modules
47
+--------------
48
+
49
+==== ==========
50
+Name License
51
+==== ==========
52
+snmp Apache 2.0
53
+==== ==========
6 54
 
7
-`Zabbix 2.4 documentation - Templates <https://www.zabbix.com/documentation/2.4/manual/config/templates>`_

+ 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
+

+ 23
- 20
doc/plugin-guide/source/conf.py View File

@@ -1,7 +1,7 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 #
3
-# The Zabbix SNMP Trapd plugin for Fuel documentation build configuration file, created by
4
-# sphinx-quickstart on Tue Nov  3 10:53:03 2015.
3
+# The Zabbix SNMP Trap Daemon plugin for Fuel documentation build configuration file, created by
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']
@@ -48,25 +45,25 @@ source_suffix = '.rst'
48 45
 master_doc = 'index'
49 46
 
50 47
 # General information about the project.
51
-project = u'The Zabbix SNMP Trapd plugin for Fuel'
52
-copyright = u'2016, Mirantis'
53
-author = u'Mirantis'
48
+project = u'The Zabbix SNMP Trap Daemon plugin for Fuel'
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
57 54
 # built documents.
58 55
 #
59 56
 # The short X.Y version.
60
-version = '1.0.1'
57
+version = '1.0'
61 58
 # The full version, including alpha/beta/rc tags.
62
-release = '1.0.1'
59
+release = '1.0-1.0.1-1'
63 60
 
64 61
 # The language for content autogenerated by Sphinx. Refer to documentation
65 62
 # for a list of supported languages.
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, 'TheZabbixSNMPTrapdpluginforFuel.tex', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
227
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel-' + version + '.tex', u'The Zabbix SNMP Trap Daemon plugin for Fuel Documentation',
228 228
    author, 'manual'),
229 229
 ]
230 230
 
@@ -254,8 +254,8 @@ latex_documents = [
254 254
 # One entry per manual page. List of tuples
255 255
 # (source start file, name, description, authors, manual section).
256 256
 man_pages = [
257
-    (master_doc, 'thezabbixsnmptrapdpluginforfuel', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
258
-     [author], 1),
257
+    (master_doc, 'thezabbixsnmptrapdpluginforfuel', u'The Zabbix SNMP Trap Daemon plugin for Fuel Documentation',
258
+     [author], 1)
259 259
 ]
260 260
 
261 261
 # If true, show URL addresses after external links.
@@ -268,8 +268,8 @@ man_pages = [
268 268
 # (source start file, target name, title, author,
269 269
 #  dir menu entry, description, category)
270 270
 texinfo_documents = [
271
-  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
272
-   author, 'TheZabbixSNMPTrapdpluginforFuel'),
271
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel', u'The Zabbix SNMP Trap Daemon plugin for Fuel Documentation',
272
+   author, 'TheZabbixSNMPTrapdpluginforFuel')
273 273
 ]
274 274
 
275 275
 # Documents to append as an appendix to all manuals.
@@ -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
-SNMP trap daemon for Zabbix plugin
3
-==================================
1
+===============================================
2
+Guide to the SNMP trap daemon for Zabbix plugin
3
+===============================================
4 4
 
5 5
 This plugin extends Zabbix plugin functionality by adding ability to receive
6 6
 SNMP traps from management network and pass them to Zabbix. For more

+ 69
- 37
doc/plugin-guide/source/guide.rst View File

@@ -2,16 +2,40 @@
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
+
16
+Known problems
17
+==============
18
+
19
+- `#1529643 <https://bugs.launchpad.net/fuel-plugins/+bug/1529643>`_:
20
+  Zabbix snmptrapd: Service "snmptt" was restarted after executing of task "upload\_core\_repos"
21
+- `#1538617 <https://bugs.launchpad.net/fuel-plugins/+bug/1538617>`_:
22
+  Cross-plugin display restrictions for some plugins prevent Settings tab from opening.
23
+- See Zabbix 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. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left
37
+
38
+#. Open *Settings* tab of the Fuel web UI and scroll the page down. On the left
15 39
    choose *SNMP trap daemon for Zabbix plugin*, select the plugin checkbox and
16 40
    set *SNMP community* parameter:
17 41
 
@@ -21,7 +45,8 @@ Environment configuration
21 45
    You could see default value by clicking on the eye icon. It is highly
22 46
    recommended to change default SNMP community, because it is used to
23 47
    authorize incoming SNMP traps.
24
-4. Adjust other environment settings to your requirements and deploy the
48
+
49
+#. Adjust other environment settings to your requirements and deploy the
25 50
    environment. For more information, see
26 51
    `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
27 52
    /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
@@ -31,20 +56,23 @@ Environment validation
31 56
 
32 57
 After a successful deployment, all Controller Nodes should have the following:
33 58
 
34
-1. snmptrapd daemon running and listening on UDP/162 port on the VIP address
59
+#. snmptrapd daemon running and listening on UDP/162 port on the VIP address
35 60
    reserved for Zabbix.
36
-2. snmptrapd daemon configured to pass all SNMP traps to snmptt handler.
37
-3. snmptt daemon running which parse SNMP traps and stores them in a log file
61
+
62
+#. snmptrapd daemon configured to pass all SNMP traps to snmptt handler.
63
+
64
+#. snmptt daemon running which parse SNMP traps and stores them in a log file
38 65
    in a format accepted by Zabbix.
39
-4. Zabbix SNMPTrapper processes running which reads SNMP traps from the log
66
+
67
+#. Zabbix SNMPTrapper processes running which reads SNMP traps from the log
40 68
    file (only on node on which Zabbix Server is running).
41 69
 
42 70
 To test if everything is installed and configured properly, follow these steps:
43 71
 
44
-1. Generate a test SNMP trap running following command from any node::
72
+#. Generate a SNMP test trap by running the following command from any node::
45 73
 
46
-       [root@node-46 ~]# snmptrap -v 2c -c <SNMP_community> \
47
-       <zabbix_VIP_address> "" .1.3.6.1.4.1.8072.2.3.0.1
74
+     # snmptrap -v 2c -c <SNMP_community> <mgmt_VIP_address> "" \
75
+         .1.3.6.1.4.1.8072.2.3.0.1
48 76
 
49 77
    where:
50 78
 
@@ -55,33 +83,29 @@ To test if everything is installed and configured properly, follow these steps:
55 83
    .. image:: ../images/settings.png
56 84
       :width: 100%
57 85
 
58
-   *<zabbix_VIP_address>*
86
+   *<mgmt_VIP_address>*
59 87
 
60 88
        If you don’t know the address, run the following command on any node::
61 89
 
62
-           [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/.*: //'
63 92
 
64 93
        You should get the required VIP in the output::
65 94
 
66
-           zbx_vip_mgmt:
67
-             network_role: zabbix
68
-             ipaddr: 192.168.0.1
69
-
95
+	 192.168.0.3
70 96
 
71
-2. After several seconds of running the snmptrap command you should see a line
97
+#. After several seconds of running the snmptrap command you should see a line
72 98
    in the Zabbix Server log file similar to this one::
73 99
 
74
-       [root@node-45 ~]# grep netSnmpExampleHeartbeatNotification \
75
-       /var/log/zabbix/zabbix_server.log
76
-       10730:20150611:182933.176 unmatched trap received from [192.168.0.4]:
77
-       18:29:27 2015/06/11 .1.3.6.1.4.1.8072.2.3.0.1 Normal "Status Events"
78
-       node-46.domain.tld - netSnmpExampleHeartbeatNotification
100
+     # grep netSnmpExampleHeartbeatNotification /var/log/zabbix/zabbix_server.log
101
+     10730:20150611:182933.176 unmatched trap received from [192.168.0.4]:
102
+     18:29:27 2015/06/11 .1.3.6.1.4.1.8072.2.3.0.1 Normal "Status Events"
103
+     node-46.domain.tld - netSnmpExampleHeartbeatNotification
79 104
 
80 105
    This is a proof that test SNMP trap has been received and passed to Zabbix.
81 106
    It is “unmatched” for Zabbix because there is no configuration for this trap
82 107
    in Zabbix (this trap is for testing purposes only).
83 108
 
84
-
85 109
 How to use SNMP trap daemon for Zabbix plugin
86 110
 =============================================
87 111
 
@@ -89,37 +113,45 @@ As noted above, with this plugin you can easily create additional plugins to
89 113
 add monitoring of SNMP traps specific for your hardware. To achieve this,
90 114
 the following tasks should be done by additional plugin:
91 115
 
92
-1. On all Controller nodes, add SNMP traps to snmptt configuration:
116
+#. On all Controller nodes, add SNMP traps to snmptt configuration:
93 117
 
94
-   a. Create configuration file in */etc/snmp/snmptt.conf.d/* directory, for
118
+   #. Create configuration file in */etc/snmp/snmptt.conf.d/* directory, for
95 119
       example *emc.conf*, with SNMP traps defined, for more information, see
96 120
       `snmptt documentation <http://snmptt.sourceforge.net/docs/snmptt.shtml
97 121
       #SNMPTT.CONF-Configuration-file-format>`_.
98
-   b. Add the file (absolute path) to *snmptt_conf_files* parameter in
122
+
123
+   #. Add the file (absolute path) to *snmptt_conf_files* parameter in
99 124
       *snmptt.ini* file.
100
-   c. Reload snmptt service.
101 125
 
102
-2. Create a Zabbix monitoring Template and export it to a file. For more
126
+   #. Reload snmptt service.
127
+
128
+#. Create a Zabbix monitoring Template and export it to a file. For more
103 129
    information, see `Templates section in the Zabbix documentation <https://
104 130
    www.zabbix.com/documentation/2.4/manual/config/templates>`_.
105
-3. From Primary Controller node configure Zabbix:
106 131
 
107
-   a. Copy created Template file to the Primary Controller node.
108
-   b. Import the Template to Zabbix using *plugin_zabbix_configuration_import*
132
+#. From Primary Controller node configure Zabbix:
133
+
134
+   #. Copy created Template file to the Primary Controller node.
135
+
136
+   #. Import the Template to Zabbix using *plugin_zabbix_configuration_import*
109 137
       resource.
110
-   c. Optionally, create a Host group in Zabbix using *plugin_zabbix_hostgroup*
138
+
139
+   #. Optionally, create a Host group in Zabbix using *plugin_zabbix_hostgroup*
111 140
       resource.
112
-   d. Create Host in Zabbix using *plugin_zabbix_host* resource setting
141
+
142
+   #. Create Host in Zabbix using *plugin_zabbix_host* resource setting
113 143
       appropriate name, IP and group.
114
-   e. Link the Template with the Host using *plugin_zabbix_template_link*
144
+
145
+   #. Link the Template with the Host using *plugin_zabbix_template_link*
115 146
       resource.
116 147
 
117 148
 There are two plugins in the `Fuel Plugins Catalog <https://www.mirantis.com
118 149
 /products/openstack-drivers-and-plugins/fuel-plugins/>`_ you can refer to as an
119 150
 example:
120 151
 
121
-1. EMC hardware monitoring extension for Zabbix plugin.
122
-2. Extreme Networks hardware monitoring extension for Zabbix plugin.
152
+#. EMC hardware monitoring extension for Zabbix plugin.
153
+
154
+#. Extreme Networks hardware monitoring extension for Zabbix plugin.
123 155
 
124 156
 These plugins do all the tasks mentioned above and have their own Zabbix
125 157
 monitoring Templates. You can simply copy one of these plugins and adjust SNMP

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

@@ -1,17 +1,18 @@
1
-***********************************************
2
-Guide to the SNMP trap daemon for Zabbix plugin
3
-***********************************************
4
-
5
-This document provides instructions for installing, configuring and using
6
-SNMP trap daemon for Zabbix plugin.
1
+=======================================================================
2
+Welcome to The Zabbix SNMP trap daemon 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
16
-   licenses.rst
8
+   revisionhistory
9
+   purpose
10
+   keyterms
11
+   description
12
+   changelog
13
+   limitations
14
+   installation
15
+   guide
16
+   troubleshooting
17
+   appendix
17 18
 

+ 29
- 7
doc/plugin-guide/source/installation.rst View File

@@ -7,25 +7,28 @@ SNMP trap daemon for Zabbix plugin installation
7 7
 
8 8
 To install SNMP trap daemon for Zabbix plugin, follow these steps:
9 9
 
10
-1. Download and install the Zabbix plugin for Fuel from the
10
+.. highlight:: none
11
+
12
+#. Download and install the Zabbix plugin for Fuel from the
11 13
    `Fuel Plugins Catalog <https://www.mirantis.com/products/
12 14
    openstack-drivers-and-plugins/fuel-plugins/>`_.
13
-2. Download the SNMP trap daemon for Zabbix plugin from the
15
+
16
+#. Download the SNMP trap daemon for Zabbix plugin from the
14 17
    `Fuel Plugins Catalog <https://www.mirantis.com/products/
15 18
    openstack-drivers-and-plugins/fuel-plugins/>`_.
16
-3. Copy the plugin on already installed Fuel Master node, ssh can be used for
19
+
20
+#. Copy the plugin on already installed Fuel Master node, ssh can be used for
17 21
    that. If you do not have the Fuel Master node yet, see `Quick Start Guide
18 22
    <https://software.mirantis.com/quick-start/>`_::
19 23
 
20
-    # scp zabbix_snmptrapd-1.0-1.0.1-1.noarch.rpm \
21
-      root@<The_Fuel_Master_node_IP>:/tmp
24
+    # scp zabbix_snmptrapd-1.0-1.0.1-1.noarch.rpm root@<Fuel_Master_IP>:/tmp
22 25
 
23
-4. Log into the Fuel Master node. Install the plugin::
26
+#. Log into the Fuel Master node. Install the plugin::
24 27
 
25 28
     # cd /tmp
26 29
     # fuel plugins --install zabbix_snmptrapd-1.0-1.0.1-1.noarch.rpm
27 30
 
28
-5. Check if the plugin was installed successfully::
31
+#. Check if the plugin was installed successfully::
29 32
 
30 33
     # fuel plugins
31 34
     id | name                      | version  | package_version
@@ -33,3 +36,22 @@ To install SNMP trap daemon for Zabbix plugin, follow these steps:
33 36
     1  | zabbix_monitoring         | 2.5.0    | 3.0.0
34 37
     2  | zabbix_snmptrapd          | 1.0.1    | 2.0.0
35 38
 
39
+SNMP trap daemon for Zabbix plugin removal
40
+==========================================
41
+
42
+To uninstall SNMP Trap Daemon for Zabbix plugin, follow these steps:
43
+
44
+#. Delete all Environments in which SNMP Trap Daemon for Zabbix plugin has been enabled.
45
+
46
+#. Uninstall the plugin::
47
+
48
+     # fuel plugins --remove zabbix_snmptrapd==1.0.1
49
+
50
+#. Check if the plugin was uninstalled successfully::
51
+
52
+     # fuel plugins
53
+     id | name                      | version  | package_version
54
+     ---|---------------------------|----------|----------------
55
+     ...
56
+     You can still have other plugins listed here but not zabbix_snmptrapd
57
+

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

@@ -5,7 +5,7 @@ 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.

+ 0
- 32
doc/plugin-guide/source/licenses.rst View File

@@ -1,32 +0,0 @@
1
-===================
2
-Components licenses
3
-===================
4
-
5
-rpm packages
6
-============
7
-
8
-====================== ============
9
-Name                   License
10
-====================== ============
11
-net-snmp               BSD
12
-net-snmp-libs          BSD
13
-net-snmp-perl          BSD
14
-snmptt                 GPLv2+
15
-perl-Config-IniFiles   GPL+
16
-perl-Crypt-DES         BSD
17
-perl-Digest-HMAC       GPL+
18
-perl-Digest-SHA1       GPL+
19
-perl-IO-stringy        GPL+
20
-perl-List-MoreUtils    GPL+
21
-perl-Net-SNMP          GPL+
22
-====================== ============
23
-
24
-puppet modules
25
-==============
26
-
27
-====================== ==============
28
-Name                   License
29
-====================== ==============
30
-snmp                   Apache 2.0
31
-====================== ==============
32
-

+ 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
6
+using Zabbix SNMP trap daemon extension to the Zabbix monitoring
7
+plugin for Fuel.
8
+

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

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

+ 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 for additional troubleshooting tips
83
+

+ 23
- 20
doc/qa/source/conf.py View File

@@ -1,6 +1,6 @@
1 1
 # -*- coding: utf-8 -*-
2 2
 #
3
-# The Zabbix SNMP Trapd plugin for Fuel documentation build configuration file, created by
3
+# The Zabbix SNMP Trapd plugin for Fuel test plan documentation build configuration file, created by
4 4
 # sphinx-quickstart on Tue Nov  3 10:53:03 2015.
5 5
 #
6 6
 # This file is execfile()d with the current directory set to its
@@ -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']
@@ -48,25 +45,25 @@ source_suffix = '.rst'
48 45
 master_doc = 'index'
49 46
 
50 47
 # General information about the project.
51
-project = u'The Zabbix SNMP Trapd plugin for Fuel'
52
-copyright = u'2016, Mirantis'
53
-author = u'Mirantis'
48
+project = u'The Zabbix SNMP Trapd plugin for Fuel Test Plan'
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
57 54
 # built documents.
58 55
 #
59 56
 # The short X.Y version.
60
-version = '1.0.1'
57
+version = '1.0'
61 58
 # The full version, including alpha/beta/rc tags.
62
-release = '1.0.1'
59
+release = '1.0-1.0.1-1'
63 60
 
64 61
 # The language for content autogenerated by Sphinx. Refer to documentation
65 62
 # for a list of supported languages.
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
@@ -202,7 +199,7 @@ html_static_path = ['_static']
202 199
 #html_search_scorer = 'scorer.js'
203 200
 
204 201
 # Output file base name for HTML help builder.
205
-htmlhelp_basename = 'TheZabbixSNMPTrapdpluginforFueldoc'
202
+htmlhelp_basename = 'TheZabbixSNMPTrapdpluginforFuelTestPlanDoc'
206 203
 
207 204
 # -- Options for LaTeX output ---------------------------------------------
208 205
 
@@ -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, 'TheZabbixSNMPTrapdpluginforFuel.tex', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
227
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuelTestPlan-' + version + '.tex', u'The Zabbix SNMP Trapd plugin for Fuel Test Plan Documentation',
228 228
    author, 'manual'),
229 229
 ]
230 230
 
@@ -254,8 +254,8 @@ latex_documents = [
254 254
 # One entry per manual page. List of tuples
255 255
 # (source start file, name, description, authors, manual section).
256 256
 man_pages = [
257
-    (master_doc, 'thezabbixsnmptrapdpluginforfuel', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
258
-     [author], 1),
257
+    (master_doc, 'thezabbixsnmptrapdpluginforfueltestplan', u'The Zabbix SNMP Trapd plugin for Fuel Test Plan Documentation',
258
+     [author], 1)
259 259
 ]
260 260
 
261 261
 # If true, show URL addresses after external links.
@@ -268,8 +268,8 @@ man_pages = [
268 268
 # (source start file, target name, title, author,
269 269
 #  dir menu entry, description, category)
270 270
 texinfo_documents = [
271
-  (master_doc, 'TheZabbixSNMPTrapdpluginforFuel', u'The Zabbix SNMP Trapd plugin for Fuel Documentation',
272
-   author, 'TheZabbixSNMPTrapdpluginforFuel'),
271
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuelTestPlan', u'The Zabbix SNMP Trapd plugin for Fuel Test Plan Documentation',
272
+   author, 'TheZabbixSNMPTrapdpluginforFuelTestPlan')
273 273
 ]
274 274
 
275 275
 # Documents to append as an appendix to all manuals.
@@ -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

+ 192
- 0
doc/specs/Makefile View File

@@ -0,0 +1,192 @@
1
+# Makefile for Sphinx documentation
2
+#
3
+
4
+# You can set these variables from the command line.
5
+SPHINXOPTS    =
6
+SPHINXBUILD   = sphinx-build
7
+PAPER         =
8
+BUILDDIR      = build
9
+
10
+# User-friendly check for sphinx-build
11
+ifeq ($(shell which $(SPHINXBUILD) >/dev/null 2>&1; echo $$?), 1)
12
+$(error The '$(SPHINXBUILD)' command was not found. Make sure you have Sphinx installed, then set the SPHINXBUILD environment variable to point to the full path of the '$(SPHINXBUILD)' executable. Alternatively you can add the directory with the executable to your PATH. If you don't have Sphinx installed, grab it from http://sphinx-doc.org/)
13
+endif
14
+
15
+# Internal variables.
16
+PAPEROPT_a4     = -D latex_paper_size=a4
17
+PAPEROPT_letter = -D latex_paper_size=letter
18
+ALLSPHINXOPTS   = -d $(BUILDDIR)/doctrees $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
19
+# the i18n builder cannot share the environment and doctrees with the others
20
+I18NSPHINXOPTS  = $(PAPEROPT_$(PAPER)) $(SPHINXOPTS) source
21
+
22
+.PHONY: help clean html dirhtml singlehtml pickle json htmlhelp qthelp devhelp epub latex latexpdf text man changes linkcheck doctest coverage gettext
23
+
24
+help:
25
+	@echo "Please use \`make <target>' where <target> is one of"
26
+	@echo "  html       to make standalone HTML files"
27
+	@echo "  dirhtml    to make HTML files named index.html in directories"
28
+	@echo "  singlehtml to make a single large HTML file"
29
+	@echo "  pickle     to make pickle files"
30
+	@echo "  json       to make JSON files"
31
+	@echo "  htmlhelp   to make HTML files and a HTML help project"
32
+	@echo "  qthelp     to make HTML files and a qthelp project"
33
+	@echo "  applehelp  to make an Apple Help Book"
34
+	@echo "  devhelp    to make HTML files and a Devhelp project"
35
+	@echo "  epub       to make an epub"
36
+	@echo "  latex      to make LaTeX files, you can set PAPER=a4 or PAPER=letter"
37
+	@echo "  latexpdf   to make LaTeX files and run them through pdflatex"
38
+	@echo "  latexpdfja to make LaTeX files and run them through platex/dvipdfmx"
39
+	@echo "  text       to make text files"
40
+	@echo "  man        to make manual pages"
41
+	@echo "  texinfo    to make Texinfo files"
42
+	@echo "  info       to make Texinfo files and run them through makeinfo"
43
+	@echo "  gettext    to make PO message catalogs"
44
+	@echo "  changes    to make an overview of all changed/added/deprecated items"
45
+	@echo "  xml        to make Docutils-native XML files"
46
+	@echo "  pseudoxml  to make pseudoxml-XML files for display purposes"
47
+	@echo "  linkcheck  to check all external links for integrity"
48
+	@echo "  doctest    to run all doctests embedded in the documentation (if enabled)"
49
+	@echo "  coverage   to run coverage check of the documentation (if enabled)"
50
+
51
+clean:
52
+	rm -rf $(BUILDDIR)/*
53
+
54
+html:
55
+	$(SPHINXBUILD) -b html $(ALLSPHINXOPTS) $(BUILDDIR)/html
56
+	@echo
57
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/html."
58
+
59
+dirhtml:
60
+	$(SPHINXBUILD) -b dirhtml $(ALLSPHINXOPTS) $(BUILDDIR)/dirhtml
61
+	@echo
62
+	@echo "Build finished. The HTML pages are in $(BUILDDIR)/dirhtml."
63
+
64
+singlehtml:
65
+	$(SPHINXBUILD) -b singlehtml $(ALLSPHINXOPTS) $(BUILDDIR)/singlehtml
66
+	@echo
67
+	@echo "Build finished. The HTML page is in $(BUILDDIR)/singlehtml."
68
+
69
+pickle:
70
+	$(SPHINXBUILD) -b pickle $(ALLSPHINXOPTS) $(BUILDDIR)/pickle
71
+	@echo
72
+	@echo "Build finished; now you can process the pickle files."
73
+
74
+json:
75
+	$(SPHINXBUILD) -b json $(ALLSPHINXOPTS) $(BUILDDIR)/json
76
+	@echo
77
+	@echo "Build finished; now you can process the JSON files."
78
+
79
+htmlhelp:
80
+	$(SPHINXBUILD) -b htmlhelp $(ALLSPHINXOPTS) $(BUILDDIR)/htmlhelp
81
+	@echo
82
+	@echo "Build finished; now you can run HTML Help Workshop with the" \
83
+	      ".hhp project file in $(BUILDDIR)/htmlhelp."
84
+
85
+qthelp:
86
+	$(SPHINXBUILD) -b qthelp $(ALLSPHINXOPTS) $(BUILDDIR)/qthelp
87
+	@echo
88
+	@echo "Build finished; now you can run "qcollectiongenerator" with the" \
89
+	      ".qhcp project file in $(BUILDDIR)/qthelp, like this:"
90
+	@echo "# qcollectiongenerator $(BUILDDIR)/qthelp/TheZabbixpluginforFuel.qhcp"
91
+	@echo "To view the help file:"
92
+	@echo "# assistant -collectionFile $(BUILDDIR)/qthelp/TheZabbixpluginforFuel.qhc"
93
+
94
+applehelp:
95
+	$(SPHINXBUILD) -b applehelp $(ALLSPHINXOPTS) $(BUILDDIR)/applehelp
96
+	@echo
97
+	@echo "Build finished. The help book is in $(BUILDDIR)/applehelp."
98
+	@echo "N.B. You won't be able to view it unless you put it in" \
99
+	      "~/Library/Documentation/Help or install it in your application" \
100
+	      "bundle."
101
+
102
+devhelp:
103
+	$(SPHINXBUILD) -b devhelp $(ALLSPHINXOPTS) $(BUILDDIR)/devhelp
104
+	@echo
105
+	@echo "Build finished."
106
+	@echo "To view the help file:"
107
+	@echo "# mkdir -p $$HOME/.local/share/devhelp/TheZabbixpluginforFuel"
108
+	@echo "# ln -s $(BUILDDIR)/devhelp $$HOME/.local/share/devhelp/TheZabbixpluginforFuel"
109
+	@echo "# devhelp"
110
+
111
+epub:
112
+	$(SPHINXBUILD) -b epub $(ALLSPHINXOPTS) $(BUILDDIR)/epub
113
+	@echo
114
+	@echo "Build finished. The epub file is in $(BUILDDIR)/epub."
115
+
116
+latex:
117
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
118
+	@echo
119
+	@echo "Build finished; the LaTeX files are in $(BUILDDIR)/latex."
120
+	@echo "Run \`make' in that directory to run these through (pdf)latex" \
121
+	      "(use \`make latexpdf' here to do that automatically)."
122
+
123
+latexpdf:
124
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
125
+	@echo "Running LaTeX files through pdflatex..."
126
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf
127
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
128
+
129
+latexpdfja:
130
+	$(SPHINXBUILD) -b latex $(ALLSPHINXOPTS) $(BUILDDIR)/latex
131
+	@echo "Running LaTeX files through platex and dvipdfmx..."
132
+	$(MAKE) -C $(BUILDDIR)/latex all-pdf-ja
133
+	@echo "pdflatex finished; the PDF files are in $(BUILDDIR)/latex."
134
+
135
+text:
136
+	$(SPHINXBUILD) -b text $(ALLSPHINXOPTS) $(BUILDDIR)/text
137
+	@echo
138
+	@echo "Build finished. The text files are in $(BUILDDIR)/text."
139
+
140
+man:
141
+	$(SPHINXBUILD) -b man $(ALLSPHINXOPTS) $(BUILDDIR)/man
142
+	@echo
143
+	@echo "Build finished. The manual pages are in $(BUILDDIR)/man."
144
+
145
+texinfo:
146
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
147
+	@echo
148
+	@echo "Build finished. The Texinfo files are in $(BUILDDIR)/texinfo."
149
+	@echo "Run \`make' in that directory to run these through makeinfo" \
150
+	      "(use \`make info' here to do that automatically)."
151
+
152
+info:
153
+	$(SPHINXBUILD) -b texinfo $(ALLSPHINXOPTS) $(BUILDDIR)/texinfo
154
+	@echo "Running Texinfo files through makeinfo..."
155
+	make -C $(BUILDDIR)/texinfo info
156
+	@echo "makeinfo finished; the Info files are in $(BUILDDIR)/texinfo."
157
+
158
+gettext:
159
+	$(SPHINXBUILD) -b gettext $(I18NSPHINXOPTS) $(BUILDDIR)/locale
160
+	@echo
161
+	@echo "Build finished. The message catalogs are in $(BUILDDIR)/locale."
162
+
163
+changes:
164
+	$(SPHINXBUILD) -b changes $(ALLSPHINXOPTS) $(BUILDDIR)/changes
165
+	@echo
166
+	@echo "The overview file is in $(BUILDDIR)/changes."
167
+
168
+linkcheck:
169
+	$(SPHINXBUILD) -b linkcheck $(ALLSPHINXOPTS) $(BUILDDIR)/linkcheck
170
+	@echo
171
+	@echo "Link check complete; look for any errors in the above output " \
172
+	      "or in $(BUILDDIR)/linkcheck/output.txt."
173
+
174
+doctest:
175
+	$(SPHINXBUILD) -b doctest $(ALLSPHINXOPTS) $(BUILDDIR)/doctest
176
+	@echo "Testing of doctests in the sources finished, look at the " \
177
+	      "results in $(BUILDDIR)/doctest/output.txt."
178
+
179
+coverage:
180
+	$(SPHINXBUILD) -b coverage $(ALLSPHINXOPTS) $(BUILDDIR)/coverage
181
+	@echo "Testing of coverage in the sources finished, look at the " \
182
+	      "results in $(BUILDDIR)/coverage/python.txt."
183
+
184
+xml:
185
+	$(SPHINXBUILD) -b xml $(ALLSPHINXOPTS) $(BUILDDIR)/xml
186
+	@echo
187
+	@echo "Build finished. The XML files are in $(BUILDDIR)/xml."
188
+
189
+pseudoxml:
190
+	$(SPHINXBUILD) -b pseudoxml $(ALLSPHINXOPTS) $(BUILDDIR)/pseudoxml
191
+	@echo
192
+	@echo "Build finished. The pseudo-XML files are in $(BUILDDIR)/pseudoxml."

+ 0
- 0
doc/specs/source/_static/.gitkeep View File


+ 288
- 0
doc/specs/source/conf.py View File

@@ -0,0 +1,288 @@
1
+# -*- coding: utf-8 -*-
2
+#
3
+# The Zabbix SNMP Trapd plugin for Fuel specification documentation build configuration file, created by
4
+# sphinx-quickstart on Tue Nov  3 10:53:03 2015.
5
+#
6
+# This file is execfile()d with the current directory set to its
7
+# containing dir.
8
+#
9
+# Note that not all possible configuration values are present in this
10
+# autogenerated file.
11
+#
12
+# All configuration values have a default; values that are commented out
13
+# serve to show the default.
14
+
15
+import sys
16
+import os
17
+
18
+# If extensions (or modules to document with autodoc) are in another directory,
19
+# add these directories to sys.path here. If the directory is relative to the
20
+# documentation root, use os.path.abspath to make it absolute, like shown here.
21
+#sys.path.insert(0, os.path.abspath('.'))
22
+
23
+# -- General configuration ------------------------------------------------
24
+
25
+# If your documentation needs a minimal Sphinx version, state it here.
26
+#needs_sphinx = '1.0'
27
+
28
+# Add any Sphinx extension module names here, as strings. They can be
29
+# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
30
+# ones.
31
+extensions = [ ]
32
+
33
+# Add any paths that contain templates here, relative to this directory.
34
+templates_path = ['_templates']
35
+
36
+# The suffix(es) of source filenames.
37
+# You can specify multiple suffix as a list of string:
38
+# source_suffix = ['.rst', '.md']
39
+source_suffix = '.rst'
40
+
41
+# The encoding of source files.
42
+#source_encoding = 'utf-8-sig'
43
+
44
+# The master toctree document.
45
+master_doc = 'index'
46
+
47
+# General information about the project.
48
+project = u'The Zabbix SNMP Trapd plugin for Fuel Specification'
49
+copyright = u'2016, Mirantis Inc.'
50
+author = u'Mirantis Inc.'
51
+
52
+# The version info for the project you're documenting, acts as replacement for
53
+# |version| and |release|, also used in various other places throughout the
54
+# built documents.
55
+#
56
+# The short X.Y version.
57
+version = '1.0'
58
+# The full version, including alpha/beta/rc tags.
59
+release = '1.0-1.0.1-1'
60
+
61
+# The language for content autogenerated by Sphinx. Refer to documentation
62
+# for a list of supported languages.
63
+#
64
+# This is also used if you do content translation via gettext catalogs.
65
+# Usually you set "language" from the command line for these cases.
66
+#language = None
67
+
68
+# There are two options for replacing |today|: either, you set today to some
69
+# non-false value, then it is used:
70
+#today = ''
71
+# Else, today_fmt is used as the format for a strftime call.
72
+#today_fmt = '%B %d, %Y'
73
+
74
+# List of patterns, relative to source directory, that match files and
75
+# directories to ignore when looking for source files.
76
+#exclude_patterns = []
77
+
78
+# The reST default role (used for this markup: `text`) to use for all
79
+# documents.
80
+#default_role = None
81
+
82
+# If true, '()' will be appended to :func: etc. cross-reference text.
83
+#add_function_parentheses = True
84
+
85
+# If true, the current module name will be prepended to all description
86
+# unit titles (such as .. function::).
87
+#add_module_names = True
88
+
89
+# If true, sectionauthor and moduleauthor directives will be shown in the
90
+# output. They are ignored by default.
91
+#show_authors = False
92
+
93
+# The name of the Pygments (syntax highlighting) style to use.
94
+pygments_style = 'sphinx'
95
+
96
+# A list of ignored prefixes for module index sorting.
97
+#modindex_common_prefix = []
98
+
99
+# If true, keep warnings as "system message" paragraphs in the built documents.
100
+#keep_warnings = False
101
+
102
+# If true, `todo` and `todoList` produce output, else they produce nothing.
103
+#todo_include_todos = True
104
+
105
+
106
+# -- Options for HTML output ----------------------------------------------
107
+
108
+# The theme to use for HTML and HTML Help pages.  See the documentation for
109
+# a list of builtin themes.
110
+html_theme = 'default'
111
+
112
+# Theme options are theme-specific and customize the look and feel of a theme
113
+# further.  For a list of options available for each theme, see the
114
+# documentation.
115
+#html_theme_options = {}
116
+
117
+# Add any paths that contain custom themes here, relative to this directory.
118
+#html_theme_path = []
119
+
120
+# The name for this set of Sphinx documents.  If None, it defaults to
121
+# "<project> v<release> documentation".
122
+#html_title = None
123
+
124
+# A shorter title for the navigation bar.  Default is the same as html_title.
125
+#html_short_title = None
126
+
127
+# The name of an image file (relative to this directory) to place at the top
128
+# of the sidebar.
129
+#html_logo = None
130
+
131
+# The name of an image file (within the static path) to use as favicon of the
132
+# docs.  This file should be a Windows icon file (.ico) being 16x16 or 32x32
133
+# pixels large.
134
+#html_favicon = None
135
+
136
+# Add any paths that contain custom static files (such as style sheets) here,
137
+# relative to this directory. They are copied after the builtin static files,
138
+# so a file named "default.css" will overwrite the builtin "default.css".
139
+html_static_path = ['_static']
140
+
141
+# Add any extra paths that contain custom files (such as robots.txt or
142
+# .htaccess) here, relative to this directory. These files are copied
143
+# directly to the root of the documentation.
144
+#html_extra_path = []
145
+
146
+# If not '', a 'Last updated on:' timestamp is inserted at every page bottom,
147
+# using the given strftime format.
148
+#html_last_updated_fmt = '%b %d, %Y'
149
+
150
+# If true, SmartyPants will be used to convert quotes and dashes to
151
+# typographically correct entities.
152
+#html_use_smartypants = True
153
+
154
+# Custom sidebar templates, maps document names to template names.
155
+#html_sidebars = {}
156
+
157
+# Additional templates that should be rendered to pages, maps page names to
158
+# template names.
159
+#html_additional_pages = {}
160
+
161
+# If false, no module index is generated.
162
+#html_domain_indices = True
163
+
164
+# If false, no index is generated.
165
+#html_use_index = True
166
+
167
+# If true, the index is split into individual pages for each letter.
168
+#html_split_index = False
169
+
170
+# If true, links to the reST sources are added to the pages.
171
+#html_show_sourcelink = True
172
+
173
+# If true, "Created using Sphinx" is shown in the HTML footer. Default is True.
174
+#html_show_sphinx = True
175
+
176
+# If true, "(C) Copyright ..." is shown in the HTML footer. Default is True.
177
+#html_show_copyright = True
178
+
179
+# If true, an OpenSearch description file will be output, and all pages will
180
+# contain a <link> tag referring to it.  The value of this option must be the
181
+# base URL from which the finished HTML is served.
182
+#html_use_opensearch = ''
183
+
184
+# This is the file name suffix for HTML files (e.g. ".xhtml").
185
+#html_file_suffix = None
186
+
187
+# Language to be used for generating the HTML full-text search index.
188
+# Sphinx supports the following languages:
189
+#   'da', 'de', 'en', 'es', 'fi', 'fr', 'hu', 'it', 'ja'
190
+#   'nl', 'no', 'pt', 'ro', 'ru', 'sv', 'tr'
191
+#html_search_language = 'en'
192
+
193
+# A dictionary with options for the search language support, empty by default.
194
+# Now only 'ja' uses this config value
195
+#html_search_options = {'type': 'default'}
196
+
197
+# The name of a javascript file (relative to the configuration directory) that
198
+# implements a search results scorer. If empty, the default will be used.
199
+#html_search_scorer = 'scorer.js'
200
+
201
+# Output file base name for HTML help builder.
202
+htmlhelp_basename = 'TheZabbixSNMPTrapdpluginforFuelSpecDoc'
203
+
204
+# -- Options for LaTeX output ---------------------------------------------
205
+
206
+latex_elements = {
207
+# The paper size ('letterpaper' or 'a4paper').
208
+#'papersize': 'letterpaper',
209
+
210
+# The font size ('10pt', '11pt' or '12pt').
211
+#'pointsize': '10pt',
212
+
213
+# Additional stuff for the LaTeX preamble.
214
+#'preamble': '',
215
+
216
+# Latex figure (float) alignment
217
+#'figure_align': 'htbp',
218
+
219
+'classoptions': ',openany,oneside',
220
+'babel': '\\usepackage[english]{babel}'
221
+}
222
+
223
+# Grouping the document tree into LaTeX files. List of tuples
224
+# (source start file, target name, title,
225
+#  author, documentclass [howto, manual, or own class]).
226
+latex_documents = [
227
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuelSpec-' + version + '.tex', u'The Zabbix SNMP Trapd plugin for Fuel Specification Documentation',
228
+   author, 'manual'),
229
+]
230
+
231
+# The name of an image file (relative to this directory) to place at the top of
232
+# the title page.
233
+#latex_logo = None
234
+
235
+# For "manual" documents, if this is true, then toplevel headings are parts,
236
+# not chapters.
237
+#latex_use_parts = False
238
+
239
+# If true, show page references after internal links.
240
+#latex_show_pagerefs = False
241
+
242
+# If true, show URL addresses after external links.
243
+#latex_show_urls = False
244
+
245
+# Documents to append as an appendix to all manuals.
246
+#latex_appendices = []
247
+
248
+# If false, no module index is generated.
249
+#latex_domain_indices = True
250
+
251
+
252
+# -- Options for manual page output ---------------------------------------
253
+
254
+# One entry per manual page. List of tuples
255
+# (source start file, name, description, authors, manual section).
256
+man_pages = [
257
+    (master_doc, 'thezabbixsnmptrapdpluginforfuelspec', u'The Zabbix SNMP Trapd plugin for Fuel Specification Documentation',
258
+     [author], 1)
259
+]
260
+
261
+# If true, show URL addresses after external links.
262
+#man_show_urls = False
263
+
264
+
265
+# -- Options for Texinfo output -------------------------------------------
266
+
267
+# Grouping the document tree into Texinfo files. List of tuples
268
+# (source start file, target name, title, author,
269
+#  dir menu entry, description, category)
270
+texinfo_documents = [
271
+  (master_doc, 'TheZabbixSNMPTrapdpluginforFuelSpec', u'The Zabbix SNMP Trapd plugin for Fuel Specification Documentation',
272
+   author, 'TheZabbixSNMPTrapdpluginforFuelSpec')
273
+]
274
+
275
+# Documents to append as an appendix to all manuals.
276
+#texinfo_appendices = []
277
+
278
+# If false, no module index is generated.
279
+#texinfo_domain_indices = True
280
+
281
+# How to display URL addresses: 'footnote', 'no', or 'inline'.
282
+#texinfo_show_urls = 'footnote'
283
+
284
+# If true, do not generate a @detailmenu in the "Top" node's menu.
285
+#texinfo_no_detailmenu = False
286
+
287
+# Insert footnotes where they are defined instead of at the end.
288
+pdf_inline_footnotes = True

specs/zabbix-snmptrapd-plugin-spec.rst → doc/specs/source/index.rst View File


+ 10
- 3
tox.ini View File

@@ -1,5 +1,5 @@
1 1
 [tox]
2
-envlist = manifests,plugin_zabbix_snmptrapd,build_plugin,docs,qa_docs
2
+envlist = manifests,plugin_zabbix_snmptrapd,build_plugin,docs,qa_docs,spec_docs
3 3
 skipsdist = True
4 4
 
5 5
 [testenv]
@@ -38,14 +38,21 @@ commands =
38 38
     fpb --check {toxinidir} --debug
39 39
     fpb --build {toxinidir} --debug
40 40
 
41
+[testenv:spec_docs]
42
+changedir = {toxinidir}/doc/specs
43
+whitelist_externals = make
44
+commands =
45
+    make clean html singlehtml SPHINXOPTS=-W
46
+
41 47
 [testenv:docs]
42 48
 changedir = {toxinidir}/doc/plugin-guide
43 49
 whitelist_externals = make
44 50
 commands =
45
-    make clean html SPHINXOPTS=-W
51
+    make clean html singlehtml SPHINXOPTS=-W
46 52
 
47 53
 [testenv:qa_docs]
48 54
 changedir = {toxinidir}/doc/qa
49 55
 whitelist_externals = make
50 56
 commands =
51
-    make clean html SPHINXOPTS=-W
57
+    make clean html singlehtml SPHINXOPTS=-W
58
+

Loading…
Cancel
Save