Documentation: update and conversion into RST format

Change-Id: I5d78b94a654443be8a88f446f5184ec78408faee

README.md

@@ -14,7 +14,7 @@ Requirements
 
 | Requirement                      | Version/Comment |
 |:---------------------------------|:----------------|
-| Mirantis OpenStack compatibility | >= 6.1          |
+| Mirantis OpenStack compatibility | >= 7.0          |
 
 Installation Guide
 ==================
@@ -31,19 +31,19 @@ To install Zabbix plugin, follow these steps:
     that. If you do not have the Fuel Master node yet, see
     [Quick Start Guide](https://software.mirantis.com/quick-start/) :
 
-        # scp zabbix_monitoring-1.0-1.0.0-0.noarch.rpm root@<Fuel_Master_ip>:/tmp
+        # scp zabbix_monitoring-2.0-2.0.0-0.noarch.rpm root@<Fuel_Master_ip>:/tmp
 
 3. Install the plugin:
 
         # cd /tmp
-        # fuel plugins --install zabbix_monitoring-1.0-1.0.0-0.noarch.rpm
+        # fuel plugins --install zabbix_monitoring-2.0-2.0.0-0.noarch.rpm
 
 4. Check if the plugin was installed successfully:
 
         # fuel plugins
         id | name              | version | package_version
         ---|-------------------|---------|----------------
-        1  | zabbix_monitoring | 1.0.0   | 2.0.0
+        1  | zabbix_monitoring | 2.0.0   | 3.0.0
 
 Zabbix plugin configuration
 ----------------------------
@@ -72,3 +72,4 @@ Piotr Misiak <pmisiak@mirantis.com> (developer)
 Szymon Bańka <sbanka@mirantis.com> (developer)
 Bartosz Kupidura <bkupidura@mirantis.com> (developer)
 Alexander Zatserklyany <azatserklyany@mirantis.com> (QA engineer)
+Maciej Relewicz <mrelewicz@mirantis.com> (developer)

deployment_tasks.yaml

@@ -0,0 +1 @@
+[]

doc/content/appendix.rst

@@ -0,0 +1,29 @@
+==================
+Appendix
+==================
+
+Links
+=========================
+
+- `Zabbix Official site <http://www.zabbix.com>`_
+- `Zabbix 2.4 documentation - SNMP traps <https://www.zabbix.com/documentation
+  /2.4/manual/config/items/itemtypes/snmptrap>`_
+- `Fuel Plugins CLI guide <https://docs.mirantis.com/openstack/fuel/fuel-7.0
+  /user-guide.html#fuel-plugins-cli>`_
+
+Components licenses
+=========================
+
+deb packages::
+
+  zabbix-frontend-php: GPL-2.0
+  zabbix-server-mysql: GPL-2.0
+  zabbix-agent: GPL-2.0
+
+rpm packages::
+
+  zabbix-agent: GPLv2+
+  zabbix-server: GPLv2+
+  zabbix-server-mysql: GPLv2+
+  zabbix-web: GPLv2+
+  zabbix-web-mysql: GPLv2+

doc/content/description.rst

@@ -0,0 +1,17 @@
+===================================================
+Guide to the Zabbix Plugin extension for Fuel
+===================================================
+
+This plugin extends Mirantis OpenStack functionality by adding Zabbix
+monitoring system. It installs Zabbix server, frontend and agent components.
+The plugin configures Zabbix by adding templates to monitor nodes and OpenStack
+services and APIs.
+
+Requirements
+============
+
+================================== ===============
+Requirement                        Version/Comment
+================================== ===============
+Fuel                               7.0 and higher
+================================== ===============

doc/content/guide.rst

@@ -0,0 +1,133 @@
+==========
+User Guide
+==========
+
+Environment configuration
+=========================
+
+#. Create an environment. For more information about environment creation, see
+   `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
+   /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
+
+#. Choose in *Environments* an evironment for which you want to run Zabbix
+   plugin.
+
+#. Open *Settings* tab and scroll the page down. On the left select
+   *Zabbix for Fuel*.
+
+#. Set credentials for *Zabbix for Fuel*:
+
+   .. image:: images/settings.png
+      :width: 50%
+
+   You could see default passwords by clicking on the eye icon. It is highly
+   recommended to change default passwords for Zabbix Administrator and
+   Zabbix Database.
+
+#. Adjust other environment settings to your requirements and deploy the
+   environment. For more information, see
+   `Mirantis OpenStack User Guide <http://docs.mirantis.com/openstack/fuel
+   /fuel-7.0/user-guide.html#create-a-new-openstack-environment>`_.
+
+Zabbix frontend UI
+=========================
+
+#. After successful deployment you will see a green notification: “Deployment
+   of environment 'test' is done. Access the OpenStack dashboard (Horizon) at
+   `http://172.16.0.2/ <http://172.16.0.2/>`_”.
+
+   In this example, 172.16.0.2 is a VIP address.
+
+   Zabbix UI will be available at `http://172.16.0.2/zabbix
+   <http://172.16.0.2/zabbix>`_ (at http://<VIP>/zabbix in general).
+   After opening this address in a browser, you should see Zabbix login page:
+
+   .. image:: images/login.png
+      :width: 50%
+
+#. Now log into Zabbix with the credentials set provided on the Settings tab of
+   the Fuel web UI (see step 2 in the Environment configuration section).
+   After logging into Zabbix, you will see the Zabbix Dashboard page:
+
+   .. image:: images/dashboard.png
+      :width: 50%
+
+#. The Zabbix Dashboard page provides information on running processes and
+   their state. If all processes are running successfully in the environment,
+   you should see only green colour. To demonstrate that monitoring is working
+   properly, the Nova Scheduler process had been turned off. You can notice
+   that Zabbix detected the halted process and provided the problem
+   description: Nova Scheduler process is not running on node-13.domain.tld.
+   When you go to Monitoring->Screens page, you will see the OpenStack Cluster
+   screen:
+
+   .. image:: images/openstackcluster1.png
+      :width: 50%
+
+   .. image:: images/openstackcluster2.png
+      :width: 50%
+
+   On this screen you have general statistics and graphs presenting resources
+   usage in OpenStack environment. There is also a list of last 10 events
+   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
+several pages placed under Configuration tab.
+
+#. Host groups page
+   This page has a list of host groups with their members. There are separate
+   groups for Controllers and Computes. These groups are used to join nodes
+   with the same role in OpenStack environment. There is also ManagedByPuppet
+   group which contains all OpenStack nodes. Remaining host groups are created
+   by default in Zabbix. For more information and instructions, see `6.1 Hosts
+   and host groups <https://www.zabbix.com/documentation/2.4/manual/config
+   /hosts>`_ chapter in the official Zabbix Documentation.
+
+
+   .. image:: images/hostgroupspage.png
+      :width: 50%
+
+#. Hosts page
+   This page contains a list of all monitored OpenStack nodes and, additionally
+   one OpenStackCluster virtual host which represents OpenStack API. There are
+   also lists of linked monitoring templates to particular hosts. During
+   installation, the plugin detects which services have been installed on a
+   particular node and links appropriate templates to the node to enable
+   monitoring for those services. There is an Zabbix agent availability report
+   in the last column. When ‘Z’ icon is green, the Zabbix agent on this node is
+   running and available.
+
+   .. image:: images/hostpage.png
+      :width: 50%
+
+   .. image:: images/hostpage2.png
+      :width: 50%
+
+#. Templates page
+   This page contains a list of all monitoring templates and list of hosts to
+   which they are linked. A monitoring template is a way to group items, graphs
+   and thresholds which monitor a particular resource type, for example an
+   OpenStack service like Nova Compute. For more information and instructions,
+   see `6.6 Templates chapter <https://www.zabbix.com/documentation/2.4/manual
+   /config/templates>`_ in the official Zabbix Documentation.
+
+   .. image:: images/templatespage.png
+      :width: 50%
+
+   .. image:: images/templatespage2.png
+      :width: 50%
+
+   You can add an additional items (checks), create triggers and events via
+   Zabbix UI. For more information and instructions, see `6.2 Items
+   <https://www.zabbix.com/documentation/2.4/manual/config/items>`_, `6.3
+   Triggers <https://www.zabbix.com/documentation/2.4/manual/config/triggers>`_
+   and `6.4 Events chapters <https://www.zabbix.com/documentation/2.4/manual
+   /config/events>`_ in the official Zabbix Documentation. By default, there
+   are no notifications configured, but you can add them into the Zabbix UI.
+   For more information and instructions, see `6.7 Notifications
+   <https://www.zabbix.com/documentation/2.4/manual/config/notifications>`_
+   upon events chapter in the official Zabbix Documentation.

doc/content/installation.rst

@@ -0,0 +1,30 @@
+==================
+Installation Guide
+==================
+
+Zabbix plugin installation
+============================================
+
+To install Zabbix plugin, follow these steps:
+
+#. Download the plugin from the
+   `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/>`_::
+
+   # scp zabbix_monitoring-2.0-2.0.0-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.0-2.0.0-1.noarch.rpm
+
+#. Check if the plugin was installed successfully::
+
+    # fuel plugins
+    id | name                      | version  | package_version
+    ---|---------------------------|----------|----------------
+    1  | zabbix_monitoring         | 2.0.0    | 3.0.0

doc/content/removal.rst

@@ -0,0 +1,19 @@
+==================
+Removal Guide
+==================
+
+Zabbix plugin removal
+============================================
+
+To uninstall Zabbix plugin, follow these steps:
+
+1. Delete all Environments in which Zabbix plugin has been enabled.
+2. Uninstall the plugin:
+
+   # fuel plugins --remove zabbix_monitoring==2.0.0
+
+3. Check if the plugin was uninstalled successfully:
+
+   # fuel plugins
+    id | name                      | version  | package_version
+    ---|---------------------------|----------|----------------

doc/content/terms.rst

@@ -0,0 +1,11 @@
+=====================================
+Key terms, acronyms and abbreviations
+=====================================
+
+Zabbix
+    An enterprise open source monitoring solution for networks and
+    applications. It is designed to monitor and track the status of various
+    network services, servers, and other network hardware.
+
+VIP
+    Virtual IP Adress.

doc/user_guide.rst

@@ -0,0 +1,13 @@
+****************************************************************
+Guide to the Zabbix Plugin extension for Fuel
+****************************************************************
+
+This document provides instructions for installing, configuring and using
+Zabbix plugin for Fuel.
+
+.. contents::
+.. include:: content/terms.rst
+.. include:: content/description.rst
+.. include:: content/installation.rst
+.. include:: content/guide.rst
+.. include:: content/appendix.rst