[docs] Edits the StackLight Infrastructure Alerting plugin docs
Adds minor changes for consistency with other guides Fixes links This is the final PDF build: https://drive.google.com/a/mirantis.com/file/d/0B30Lksc8WVCRTnpvLUdHYzZlS2M/view?usp=sharing Change-Id: I966a7a6c653f5a41c145112ba9c865a2dfb63d42
This commit is contained in:
parent
6e33c68cc7
commit
f0fc2b9508
@ -15,8 +15,8 @@ Plugin configuration
|
||||
#. In the Fuel web UI, click the :guilabel:`Settings` tab and select the
|
||||
:guilabel:`Other` category.
|
||||
|
||||
#. Scroll down through the settings until you find the StackLight
|
||||
Infrastructure Alerting Plugin section.
|
||||
#. Scroll down through the settings until you find
|
||||
:guilabel:`The StackLight Infrastructure Alerting Plugin` section.
|
||||
|
||||
#. Select :guilabel:`The StackLight Infrastructure Alerting Plugin` and fill
|
||||
in the required fields as indicated below.
|
||||
|
@ -21,7 +21,6 @@ Installing and configuring StackLight Infrastructure Alerting plugin for Fuel
|
||||
.. toctree::
|
||||
:maxdepth: 1
|
||||
|
||||
install_intro
|
||||
install
|
||||
configure
|
||||
verification
|
||||
|
@ -1,3 +1,25 @@
|
||||
.. _install:
|
||||
|
||||
Introduction
|
||||
------------
|
||||
|
||||
You can install the StackLight Infrastructure Alerting plugin using one of the
|
||||
following options:
|
||||
|
||||
* Install using the RPM file
|
||||
* Install from source
|
||||
|
||||
The following is a list of software components installed by the StackLight
|
||||
Infrastructure Alerting plugin:
|
||||
|
||||
+-----------+---------------------------------------------+
|
||||
| Component | Version |
|
||||
+===========+=============================================+
|
||||
| Nagios | v3.5.1 for Ubuntu (64-bit) |
|
||||
+-----------+---------------------------------------------+
|
||||
| Apache | Version coming with the Ubuntu distribution |
|
||||
+-----------+---------------------------------------------+
|
||||
|
||||
Install using the RPM file
|
||||
--------------------------
|
||||
|
||||
@ -41,15 +63,15 @@ Alternatively, you may want to build the plugin RPM file from source if, for
|
||||
example, you want to test the latest features of the master branch or
|
||||
customize the plugin.
|
||||
|
||||
.. note:: Running a Fuel plugin that you built yourself is at your
|
||||
own risk and will not be supported.
|
||||
.. note:: Running a Fuel plugin that you built yourself is at your own risk
|
||||
and will not be supported.
|
||||
|
||||
To install the StackLight Infrastructure Alerting Plugin from source, you
|
||||
first need to prepare an environment to build the RPM file. The recommended
|
||||
approach is to build the RPM file directly onto the Fuel Master node so that
|
||||
you will not have to copy that file later on.
|
||||
To install the StackLight Infrastructure Alerting Plugin from source, first
|
||||
prepare an environment to build the RPM file. The recommended approach is to
|
||||
build the RPM file directly onto the Fuel Master node, so that you will not
|
||||
have to copy that file later on.
|
||||
|
||||
**To prepare an environment:**
|
||||
**To prepare an environment and build the plugin:**
|
||||
|
||||
#. Install the standard Linux development tools:
|
||||
|
||||
@ -73,9 +95,8 @@ you will not have to copy that file later on.
|
||||
.. note:: You may also need to build the Fuel Plugin Builder if the package
|
||||
version of the plugin is higher than package version supported by the
|
||||
Fuel Plugin Builder you get from `pypi`. For instructions on how to
|
||||
build the Fuel Plugin Builder, see the *Preparing an environment for
|
||||
plugin development* section of the
|
||||
`Fuel plugins Wiki <https://wiki.openstack.org/wiki/Fuel/Plugins>`_.
|
||||
build the Fuel Plugin Builder, see the *Install Fuel Plugin Builder*
|
||||
section of the `Fuel Plugin SDK Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-plugin/install-plugin-builder.html>`_.
|
||||
|
||||
#. Clone the plugin repository:
|
||||
|
||||
|
@ -1,19 +0,0 @@
|
||||
Introduction
|
||||
------------
|
||||
|
||||
You can install the StackLight Infrastructure Alerting plugin using one of the
|
||||
following options:
|
||||
|
||||
* Install using the RPM file
|
||||
* Install from source
|
||||
|
||||
The following is a list of software components installed by the StackLight
|
||||
Infrastructure Alerting plugin:
|
||||
|
||||
+-----------+---------------------------------------------+
|
||||
| Component | Version |
|
||||
+===========+=============================================+
|
||||
| Nagios | v3.5.1 for Ubuntu (64-bit) |
|
||||
+-----------+---------------------------------------------+
|
||||
| Apache | Version coming with the Ubuntu distribution |
|
||||
+-----------+---------------------------------------------+
|
@ -3,7 +3,7 @@
|
||||
Introduction
|
||||
------------
|
||||
|
||||
The **StackLight Infrastructure Alerting Plugin** is used to install and
|
||||
The **StackLight Infrastructure Alerting plugin** is used to install and
|
||||
configure Nagios, which provides the alerting and escalation functionality of
|
||||
the so-called Logging, Monitoring, and Alerting Toolchain of Mirantis
|
||||
OpenStack.
|
||||
@ -13,4 +13,5 @@ Nagios is a key component of the `LMA Toolchain project
|
||||
the figure below.
|
||||
|
||||
.. image:: ../images/toolchain_map.*
|
||||
:width: 440pt
|
||||
:align: center
|
@ -3,8 +3,8 @@
|
||||
Release notes
|
||||
-------------
|
||||
|
||||
0.10.0
|
||||
++++++
|
||||
Version 0.10.0
|
||||
++++++++++++++
|
||||
|
||||
The StackLight Infrastructure Alerting plugin 0.10.0 contains the following
|
||||
updates:
|
||||
@ -23,8 +23,8 @@ updates:
|
||||
workload for large deployments. See
|
||||
`#1552772 <https://bugs.launchpad.net/lma-toolchain/+bug/1552772>`_.
|
||||
|
||||
0.9.0
|
||||
+++++
|
||||
Version 0.9.0
|
||||
+++++++++++++
|
||||
|
||||
The StackLight Infrastructure Alerting plugin 0.9.0 contains the following
|
||||
updates:
|
||||
@ -39,7 +39,7 @@ updates:
|
||||
* Specified contact_groups for SSH checks.
|
||||
See `#1559153 <https://bugs.launchpad.net/lma-toolchain/+bug/1559153>`_.
|
||||
|
||||
0.8.0
|
||||
+++++
|
||||
Version 0.8.0
|
||||
+++++++++++++
|
||||
|
||||
The initial release of the plugin.
|
||||
|
@ -29,6 +29,7 @@ requirements:
|
||||
| Collector Plugin | |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
| The StackLight InfluxDB| 0.10 |
|
||||
| Grafana Plugin | This is optional and only needed if you want to create alarms in Nagios for |
|
||||
| Grafana Plugin | |
|
||||
| | This is optional and only needed if you want to create alarms in Nagios for |
|
||||
| | time-series stored in InfluxDB. |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
@ -70,6 +70,6 @@ the StackLight Collector. This may be due to different issues, for example:
|
||||
* The 'collectd' and/or 'hekad' process have crashed
|
||||
* One or several alarm rules are misconfigured
|
||||
|
||||
For solutions, see the `Troubleshooting tips
|
||||
<http://fuel-plugin-lma-collector.readthedocs.io/en/latest/configuration.html#troubleshooting>`_
|
||||
of the *StackLight Collector Plugin User Guide*.
|
||||
For solutions, see the `Troubleshooting` section in the
|
||||
`StackLight Collector plugin documentation
|
||||
<http://fuel-plugin-lma-collector.readthedocs.io/en/latest/>`_.
|
@ -50,17 +50,18 @@ condition affecting the overall health status of the global cluster entities.
|
||||
:width: 450pt
|
||||
|
||||
There is a direct dependency between the configuration of the passive checks in
|
||||
Nagios and the `configuration of the alarms in the Collectors
|
||||
<http://fuel-plugin-lma-collector.readthedocs.io/en/latest/alarms.html>`_.
|
||||
Nagios and the configuration of the alarms in the Collectors. For details, see
|
||||
the `Configuring alarms` section in the
|
||||
`StackLight Collector documentation <http://fuel-plugin-lma-collector.readthedocs.org/en/latest/>`_.
|
||||
A change in ``/etc/hiera/override/alarming.yaml`` or
|
||||
``/etc/hiera/override/gse_filters.yaml`` on any of the nodes monitored by
|
||||
StackLight would require to reconfigure Nagios. It also implies that these two
|
||||
StackLight would require reconfiguring Nagios. It also implies that these two
|
||||
files should be maintained rigorously identical on all the nodes of the
|
||||
environment **including those where Nagios is installed**. StackLight provides
|
||||
Puppet artifacts to help you out with that task. To reconfigure the passive
|
||||
checks in Nagios when ``/etc/hiera/override/alarming.yaml`` or
|
||||
``/etc/hiera/override/gse_filters.yaml`` are modified,
|
||||
run the following command on all the nodes where Nagios is installed:
|
||||
``/etc/hiera/override/gse_filters.yaml`` are modified, run the following
|
||||
command on all the nodes where Nagios is installed:
|
||||
|
||||
.. code-block:: console
|
||||
|
||||
@ -164,9 +165,9 @@ Nagios configuration after the deployment of your environment.
|
||||
|
||||
#. Log in to the *LMA Infrastructure Alerting* node.
|
||||
|
||||
#. Edit the
|
||||
``/etc/nagios3/conf.d/cmd_notify-service-by-smtp-with-long-service-output.cfg``
|
||||
file to add the ``-S smtp-use-starttls`` option to the :command:`mail`
|
||||
#. Open the ``cmd_notify-service-by-smtp-with-long-service-output.cfg`` file
|
||||
in the ``/etc/nagios3/conf.d/`` directory for editing.
|
||||
#. Add the ``-S smtp-use-starttls`` option to the :command:`mail`
|
||||
command. For example::
|
||||
|
||||
define command{
|
||||
|
@ -8,7 +8,7 @@ Plugin verification
|
||||
-------------------
|
||||
|
||||
Depending on the number of nodes and deployment setup, deploying a Mirantis
|
||||
OpenStack environment may take between 20 minutes to several hours. Once your
|
||||
OpenStack environment may take 20 minutes to several hours. Once the
|
||||
deployment is complete, you should see a deployment success notification
|
||||
message with a link to the Nagios web UI as shown below.
|
||||
|
||||
|
Loading…
Reference in New Issue
Block a user