Update documentation
Roll back version from 2.6.0 to 2.5.1 Restructured docs which are now more uniform across plugins and branches Change-Id: I7b75ef3f424e90392dbad2cc5c0c85db086f01bd
This commit is contained in:
Olivier Bourdon
@@ -43,7 +43,7 @@ To install Zabbix plugin, follow these steps:
|
||||
# fuel plugins
|
||||
id | name | version | package_version
|
||||
---|-------------------|---------|----------------
|
||||
1 | zabbix_monitoring | 2.6.0 | 3.0.0
|
||||
1 | zabbix_monitoring | 2.5.1 | 3.0.0
|
||||
|
||||
For further details see the Zabbix Plugin Guide in the
|
||||
[Fuel Plugins Catalog](https://software.mirantis.com/fuel-plugins)
|
||||
|
||||
60
doc/plugin-guide/source/changelog.rst
Normal file
60
doc/plugin-guide/source/changelog.rst
Normal file
@@ -0,0 +1,60 @@
|
||||
Release notes / Changelog
|
||||
=========================
|
||||
|
||||
**2.5.1**
|
||||
|
||||
* Compatibility with MOS 7.0, 8.0 and 9.0
|
||||
|
||||
**2.5.0**
|
||||
|
||||
* Service "zabbix_server" was restarted after executing of task "upload_core_repos" (bug 1529642_)
|
||||
* Monitoring of HAProxy vips doesn't work when the backend name contains dots (bug 1525713_)
|
||||
* Zabbix plugin should provide zabbix_get command (bug 1525924_)
|
||||
* Fail to deploy with base-os or virt roles (bug 1515956_)
|
||||
* Enhance :ref:`Ceph` monitoring
|
||||
* :ref:`tuning` for server and agents
|
||||
* Add :ref:`MySQL` cluster metrics (wsrep global variables)
|
||||
* Embed all package dependencies (bug 1483983_)
|
||||
* Fix HAproxy configuration behind the Zabbix VIP (bug 1510115_)
|
||||
* Compatibility with MOS 7.0 and 8.0
|
||||
|
||||
* Fix NTP monitoring on controller nodes (bug 1513454_)
|
||||
* Monitor `cinder-volume` process (instead of the Pacemaker resource which has
|
||||
been removed)
|
||||
* Fix trigger for Neutron DHCP/L3 agents (these agents run now on all controllers)
|
||||
* Fix Swift container TCP check (bug 1517472_)
|
||||
|
||||
* New process checks
|
||||
|
||||
* nova-conductor
|
||||
* nova-novncproxy
|
||||
|
||||
* Generate documentation with `Sphinx <http://sphinx-doc.org/>`_
|
||||
* Allow deployment without Horizon (bug 1517005_)
|
||||
* Skip zabbix agent installation when node has either 'base-os' or 'virt' role (bug 1515956_)
|
||||
|
||||
.. _1529642: https://bugs.launchpad.net/fuel-plugins/+bug/1529642
|
||||
.. _1525713: https://bugs.launchpad.net/fuel-plugins/+bug/1525713
|
||||
.. _1525924: https://bugs.launchpad.net/fuel-plugins/+bug/1525924
|
||||
.. _1515956: https://bugs.launchpad.net/fuel-plugins/+bug/1515956
|
||||
.. _1483983: https://bugs.launchpad.net/fuel/7.0.x/+bug/1483983
|
||||
.. _1510115: https://bugs.launchpad.net/fuel/+bug/1510115
|
||||
.. _1513454: https://bugs.launchpad.net/fuel-plugins/+bug/1513454
|
||||
.. _1517472: https://bugs.launchpad.net/fuel/+bug/1517472
|
||||
.. _1517005: https://bugs.launchpad.net/fuel/+bug/1517005
|
||||
.. _1515956: https://bugs.launchpad.net/fuel-plugins/+bug/1515956
|
||||
|
||||
**2.0.0**
|
||||
|
||||
* Fix HA issue when scaling down/up a controller (bug 1506767_)
|
||||
* Compatibility with MOS 7.0
|
||||
* Disable user Guest in zabbix
|
||||
* Use HTTPS Zabbix UI
|
||||
* Use dedicated VIP for Zabbix server
|
||||
|
||||
.. _1506767: https://bugs.launchpad.net/fuel-plugins/+bug/1506767
|
||||
|
||||
**1.0.0**
|
||||
|
||||
* This is the first release of the plugin.
|
||||
|
||||
@@ -14,7 +14,6 @@
|
||||
|
||||
import sys
|
||||
import os
|
||||
import shlex
|
||||
|
||||
# If extensions (or modules to document with autodoc) are in another directory,
|
||||
# add these directories to sys.path here. If the directory is relative to the
|
||||
@@ -29,9 +28,7 @@ import shlex
|
||||
# Add any Sphinx extension module names here, as strings. They can be
|
||||
# extensions coming with Sphinx (named 'sphinx.ext.*') or your custom
|
||||
# ones.
|
||||
extensions = [
|
||||
'sphinx.ext.todo',
|
||||
]
|
||||
extensions = [ ]
|
||||
|
||||
# Add any paths that contain templates here, relative to this directory.
|
||||
templates_path = ['_templates']
|
||||
@@ -49,24 +46,24 @@ master_doc = 'index'
|
||||
|
||||
# General information about the project.
|
||||
project = u'The Zabbix plugin for Fuel'
|
||||
copyright = u'2015, Mirantis'
|
||||
author = u'Mirantis'
|
||||
copyright = u'2016, Mirantis Inc.'
|
||||
author = u'Mirantis Inc.'
|
||||
|
||||
# The version info for the project you're documenting, acts as replacement for
|
||||
# |version| and |release|, also used in various other places throughout the
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '2.6'
|
||||
version = '2.5'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '2.6.0'
|
||||
release = '2.5-2.5.1-1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
#
|
||||
# This is also used if you do content translation via gettext catalogs.
|
||||
# Usually you set "language" from the command line for these cases.
|
||||
language = None
|
||||
#language = None
|
||||
|
||||
# There are two options for replacing |today|: either, you set today to some
|
||||
# non-false value, then it is used:
|
||||
@@ -76,7 +73,7 @@ language = None
|
||||
|
||||
# List of patterns, relative to source directory, that match files and
|
||||
# directories to ignore when looking for source files.
|
||||
exclude_patterns = []
|
||||
#exclude_patterns = []
|
||||
|
||||
# The reST default role (used for this markup: `text`) to use for all
|
||||
# documents.
|
||||
@@ -103,14 +100,14 @@ pygments_style = 'sphinx'
|
||||
#keep_warnings = False
|
||||
|
||||
# If true, `todo` and `todoList` produce output, else they produce nothing.
|
||||
todo_include_todos = True
|
||||
#todo_include_todos = True
|
||||
|
||||
|
||||
# -- Options for HTML output ----------------------------------------------
|
||||
|
||||
# The theme to use for HTML and HTML Help pages. See the documentation for
|
||||
# a list of builtin themes.
|
||||
html_theme = 'classic'
|
||||
html_theme = 'default'
|
||||
|
||||
# Theme options are theme-specific and customize the look and feel of a theme
|
||||
# further. For a list of options available for each theme, see the
|
||||
@@ -218,14 +215,17 @@ latex_elements = {
|
||||
|
||||
# Latex figure (float) alignment
|
||||
#'figure_align': 'htbp',
|
||||
|
||||
'classoptions': ',openany,oneside',
|
||||
'babel': '\\usepackage[english]{babel}'
|
||||
}
|
||||
|
||||
# Grouping the document tree into LaTeX files. List of tuples
|
||||
# (source start file, target name, title,
|
||||
# author, documentclass [howto, manual, or own class]).
|
||||
latex_documents = [
|
||||
(master_doc, 'TheZabbixpluginforFuel.tex', u'The Zabbix plugin for Fuel Documentation',
|
||||
u'Mirantis', 'manual'),
|
||||
(master_doc, 'TheZabbixpluginforFuel-' + version + '.tex', u'The Zabbix plugin for Fuel Documentation',
|
||||
author, 'manual'),
|
||||
]
|
||||
|
||||
# The name of an image file (relative to this directory) to place at the top of
|
||||
@@ -269,8 +269,7 @@ man_pages = [
|
||||
# dir menu entry, description, category)
|
||||
texinfo_documents = [
|
||||
(master_doc, 'TheZabbixpluginforFuel', u'The Zabbix plugin for Fuel Documentation',
|
||||
author, 'TheZabbixpluginforFuel', 'One line description of project.',
|
||||
'Miscellaneous'),
|
||||
author, 'TheZabbixpluginforFuel')
|
||||
]
|
||||
|
||||
# Documents to append as an appendix to all manuals.
|
||||
@@ -284,3 +283,6 @@ texinfo_documents = [
|
||||
|
||||
# If true, do not generate a @detailmenu in the "Top" node's menu.
|
||||
#texinfo_no_detailmenu = False
|
||||
|
||||
# Insert footnotes where they are defined instead of at the end.
|
||||
pdf_inline_footnotes = True
|
||||
|
||||
@@ -16,77 +16,3 @@ Requirement Version/Comment
|
||||
Fuel 7.0, 8.0 and 9.0
|
||||
================================== ================
|
||||
|
||||
Release Notes
|
||||
=============
|
||||
|
||||
**2.6.0**
|
||||
|
||||
* Compatibility with MOS 7.0, 8.0 and 9.0
|
||||
|
||||
**2.5.0**
|
||||
|
||||
* Service "zabbix_server" was restarted after executing of task "upload_core_repos" (bug 1529642_)
|
||||
* Monitoring of HAProxy vips doesn't work when the backend name contains dots (bug 1525713_)
|
||||
* Zabbix plugin should provide zabbix_get command (bug 1525924_)
|
||||
* fail to deploy with base-os or virt roles (bug 1515956_)
|
||||
* Enhance :ref:`Ceph` monitoring
|
||||
* :ref:`tuning` for server and agents
|
||||
* Add :ref:`MySQL` cluster metrics (wsrep global variables)
|
||||
* Embed all package dependencies (bug 1483983_)
|
||||
* Fix HAproxy configuration behind the Zabbix VIP (bug 1510115_)
|
||||
* Compatibility with MOS 7.0 and 8.0
|
||||
|
||||
* Fix NTP monitoring on controller nodes (bug 1513454_)
|
||||
* Monitor `cinder-volume` process (instead of the Pacemaker resource which has
|
||||
been removed)
|
||||
* Fix trigger for Neutron DHCP/L3 agents (these agents run now on all controllers)
|
||||
* Fix Swift container TCP check (bug 1517472_)
|
||||
|
||||
* New process checks
|
||||
|
||||
* nova-conductor
|
||||
* nova-novncproxy
|
||||
|
||||
* Generate documentation with `Sphinx <http://sphinx-doc.org/>`_
|
||||
* Allow deployment without Horizon (bug 1517005_)
|
||||
* Skip zabbix agent installation when node has either 'base-os' or 'virt' role (bug 1515956_)
|
||||
|
||||
.. _1529642: https://bugs.launchpad.net/fuel-plugins/+bug/1529642
|
||||
.. _1525713: https://bugs.launchpad.net/fuel-plugins/+bug/1525713
|
||||
.. _1525924: https://bugs.launchpad.net/fuel-plugins/+bug/1525924
|
||||
.. _1515956: https://bugs.launchpad.net/fuel-plugins/+bug/1515956
|
||||
.. _1483983: https://bugs.launchpad.net/fuel/7.0.x/+bug/1483983
|
||||
.. _1510115: https://bugs.launchpad.net/fuel/+bug/1510115
|
||||
.. _1513454: https://bugs.launchpad.net/fuel-plugins/+bug/1513454
|
||||
.. _1517472: https://bugs.launchpad.net/fuel/+bug/1517472
|
||||
.. _1517005: https://bugs.launchpad.net/fuel/+bug/1517005
|
||||
.. _1515956: https://bugs.launchpad.net/fuel-plugins/+bug/1515956
|
||||
|
||||
**2.0.0**
|
||||
|
||||
* Fix HA issue when scaling down/up a controller (bug 1506767_)
|
||||
* Compatibility with MOS 7.0
|
||||
* Disable user Guest in zabbix
|
||||
* Use HTTPS Zabbix UI
|
||||
* Use dedicated VIP for Zabbix server
|
||||
|
||||
.. _1506767: https://bugs.launchpad.net/fuel-plugins/+bug/1506767
|
||||
|
||||
**1.0.0**
|
||||
|
||||
* This is the first release of the plugin.
|
||||
|
||||
|
||||
|
||||
Limitations
|
||||
===========
|
||||
|
||||
* If a base-os role node is deployed within the environment, the plugin
|
||||
installation may fail because the management network is not configured
|
||||
(see bug `1515956 <https://bugs.launchpad.net/fuel-plugins/+bug/1515956>`_).
|
||||
|
||||
* Prior to version 2.5.0, the plugin requires access to distribution repository,
|
||||
external or local mirror, in order to download necessary packages for proper
|
||||
installation.
|
||||
Since plugin version 2.5.0, the `fuel-createmirror` command is supported.
|
||||
|
||||
|
||||
@@ -44,7 +44,7 @@ Environment configuration
|
||||
/openstack/fuel/fuel-7.0/operations.html#using-networking-templates>`_.
|
||||
|
||||
Zabbix frontend UI
|
||||
=========================
|
||||
==================
|
||||
|
||||
#. After successful deployment you will see a green notification: “Deployment
|
||||
of environment 'test' is done. Access the OpenStack dashboard (Horizon) at
|
||||
@@ -86,7 +86,7 @@ Zabbix frontend UI
|
||||
recorded by Zabbix.
|
||||
|
||||
Pages
|
||||
=========================
|
||||
=====
|
||||
|
||||
Below there are a few screenshots from Zabbix configuration pages to show how
|
||||
it should look after a successful environment deployment. Zabbix UI provides
|
||||
|
||||
@@ -2,17 +2,17 @@
|
||||
Welcome to The Zabbix plugin for Fuel's documentation!
|
||||
======================================================
|
||||
|
||||
User documentation
|
||||
==================
|
||||
|
||||
.. toctree::
|
||||
:maxdepth: 2
|
||||
:maxdepth: 3
|
||||
|
||||
terms
|
||||
revisionhistory
|
||||
purpose
|
||||
keyterms
|
||||
description
|
||||
changelog
|
||||
limitations
|
||||
installation
|
||||
guide
|
||||
troubleshooting
|
||||
removal
|
||||
appendix
|
||||
|
||||
|
||||
@@ -3,7 +3,7 @@ Installation Guide
|
||||
==================
|
||||
|
||||
Zabbix plugin installation
|
||||
============================================
|
||||
==========================
|
||||
|
||||
To install Zabbix plugin, follow these steps:
|
||||
|
||||
@@ -11,21 +11,39 @@ To install Zabbix plugin, follow these steps:
|
||||
`Fuel Plugins Catalog <https://www.mirantis.com/products/
|
||||
openstack-drivers-and-plugins/fuel-plugins/>`_.
|
||||
|
||||
#. Copy the plugin on already installed Fuel Master node, ssh can be used for
|
||||
that. If you do not have the Fuel Master node yet, see `Quick Start Guide
|
||||
<https://software.mirantis.com/quick-start/>`_::
|
||||
#. Copy the plugin from your local machine to a previously deployed
|
||||
Fuel Master node using SSH. If you do not have the Fuel Master node yet,
|
||||
see `Quick Start Guide <https://software.mirantis.com/quick-start/>`_::
|
||||
|
||||
# scp zabbix_monitoring-2.5-2.6.0-1.noarch.rpm root@<Fuel_Master_IP>:/tmp
|
||||
# scp zabbix_monitoring-2.5-2.5.1-1.noarch.rpm root@<Fuel_Master_IP>:/tmp
|
||||
|
||||
#. Log into the Fuel Master node. Install the plugin::
|
||||
|
||||
# cd /tmp
|
||||
# fuel plugins --install zabbix_monitoring-2.6-2.6.0-1.noarch.rpm
|
||||
# fuel plugins --install zabbix_monitoring-2.5-2.5.1-1.noarch.rpm
|
||||
|
||||
#. Check if the plugin was installed successfully::
|
||||
|
||||
# fuel plugins
|
||||
id | name | version | package_version
|
||||
---|---------------------------|----------|----------------
|
||||
1 | zabbix_monitoring | 2.6.0 | 3.0.0
|
||||
1 | zabbix_monitoring | 2.5.1 | 3.0.0
|
||||
|
||||
Zabbix plugin removal
|
||||
=====================
|
||||
|
||||
To uninstall Zabbix plugin, follow these steps:
|
||||
|
||||
#. Delete all environments in which Zabbix plugin has been enabled.
|
||||
|
||||
#. Uninstall the plugin::
|
||||
|
||||
# fuel plugins --remove zabbix_monitoring==2.5.1
|
||||
|
||||
#. Check if the plugin was uninstalled successfully::
|
||||
|
||||
# fuel plugins
|
||||
id | name | version | package_version
|
||||
---|---------------------------|----------|----------------
|
||||
...
|
||||
You can still have other plugins listed here but not zabbix_monitoring
|
||||
|
||||
@@ -8,4 +8,5 @@ Zabbix
|
||||
network services, servers, and other network hardware.
|
||||
|
||||
VIP
|
||||
Virtual IP Adress.
|
||||
Virtual IP Address.
|
||||
|
||||
14
doc/plugin-guide/source/limitations.rst
Normal file
14
doc/plugin-guide/source/limitations.rst
Normal file
@@ -0,0 +1,14 @@
|
||||
Limitations
|
||||
===========
|
||||
|
||||
* The plugin only supports neutron when specifying network settings. Old legacy mode (nova-network) is not supported
|
||||
|
||||
* If a base-os role node is deployed within the environment, the plugin
|
||||
installation may fail because the management network is not configured
|
||||
(see bug `1515956 <https://bugs.launchpad.net/fuel-plugins/+bug/1515956>`_).
|
||||
|
||||
* Prior to version 2.5.0, the plugin requires access to distribution repository,
|
||||
external or local mirror, in order to download necessary packages for proper
|
||||
installation.
|
||||
Since plugin version 2.5.0, the `fuel-mirror` (formerly `fuel-createmirror`) command is supported.
|
||||
|
||||
7
doc/plugin-guide/source/purpose.rst
Normal file
7
doc/plugin-guide/source/purpose.rst
Normal file
@@ -0,0 +1,7 @@
|
||||
================
|
||||
Document purpose
|
||||
================
|
||||
|
||||
This document provides instructions for installing, configuring and
|
||||
using Zabbix monitoring plugin for Fuel.
|
||||
|
||||
@@ -1,20 +0,0 @@
|
||||
Zabbix plugin removal
|
||||
============================================
|
||||
|
||||
To uninstall Zabbix plugin, follow these steps:
|
||||
|
||||
#. Delete all Environments in which Zabbix plugin has been enabled.
|
||||
|
||||
#. Uninstall the plugin:
|
||||
|
||||
::
|
||||
|
||||
# fuel plugins --remove zabbix_monitoring==2.6.0
|
||||
|
||||
#. Check if the plugin was uninstalled successfully:
|
||||
|
||||
::
|
||||
|
||||
# fuel plugins
|
||||
id | name | version | package_version
|
||||
---|---------------------------|----------|----------------
|
||||
35
doc/plugin-guide/source/revisionhistory.rst
Normal file
35
doc/plugin-guide/source/revisionhistory.rst
Normal file
@@ -0,0 +1,35 @@
|
||||
================
|
||||
Revision history
|
||||
================
|
||||
|
||||
======= ============= ============================ =====================
|
||||
Version Revision date Editor Comment
|
||||
======= ============= ============================ =====================
|
||||
0.1 08.17.2015 Marciej Relewicz First release
|
||||
(mrelewicz@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
0.2 09.04.2015 Marciej Relewicz Updated release
|
||||
(mrelewicz@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
0.3 09.09.2015 Bartosz Kupidura Network templates
|
||||
(bkupidura@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
0.4 09.18.2015 Marciej Relewicz Doc fixes
|
||||
(mrelewicz@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
1.0.0 09.22.2015 Marciej Relewicz New updated release
|
||||
(mrelewicz@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
2.0.0 11.05.2015 Swann Croiset New Major version
|
||||
(scroiset@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
2.0.1 11.10.2015 Swann Croiset Added troubleshooting
|
||||
(scroiset@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
2.5.0 11.13.2015 Swann Croiset Added MOS 8.0 support
|
||||
(scroiset@mirantis.com)
|
||||
------- ------------- ---------------------------- ---------------------
|
||||
2.5.1 07.20.2016 Olivier Bourdon Added MOS 9.0 support
|
||||
(obourdon@mirantis.com)
|
||||
======= ============= ============================ =====================
|
||||
|
||||
@@ -57,9 +57,9 @@ author = u'Mirantis'
|
||||
# built documents.
|
||||
#
|
||||
# The short X.Y version.
|
||||
version = '2.6'
|
||||
version = '2.5'
|
||||
# The full version, including alpha/beta/rc tags.
|
||||
release = '2.6.0'
|
||||
release = '2.5.1'
|
||||
|
||||
# The language for content autogenerated by Sphinx. Refer to documentation
|
||||
# for a list of supported languages.
|
||||
|
||||
@@ -28,6 +28,6 @@ Product compatibility matrix
|
||||
+====================+=================+
|
||||
| Mirantis OpenStack | 7.0, 8.0 and 9.0|
|
||||
+--------------------+-----------------+
|
||||
| Zabbix monitoring | 2.6.0 |
|
||||
| Zabbix monitoring | 2.5.1 |
|
||||
+--------------------+-----------------+
|
||||
|
||||
|
||||
@@ -2,7 +2,7 @@
|
||||
name: zabbix_monitoring
|
||||
title: Zabbix for Fuel
|
||||
# Plugin version
|
||||
version: 2.6.0
|
||||
version: 2.5.1
|
||||
# Description
|
||||
description: Enables Zabbix Monitoring. For information how to access Zabbix UI refer to Zabbix plugin User Guide. Zabbix URL schema is http://<VIP>/zabbix
|
||||
# Required fuel version
|
||||
|
||||
Reference in New Issue
Block a user