x
/
fuel-plugin-lma-infrastructure-alerting
Code Issues Proposed changes

StackLight 0.10.0 documentation updates 

Added LDAP and TLS settings
Added README updates
Added new images
Fixed couple typos and ambiguities

Change-Id: Ief45d8684bf5f56f96f62178c2f68bb77eebc83d
This commit is contained in:
Patrick Petit 2016-07-11 17:21:38 +02:00
parent 6e3df57123
commit d51c369057
9 changed files with 76 additions and 34 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

31
README.md
View File

@ -1,22 +1,22 @@
Logging, Monitoring and Alerting (LMA) Infrastructure Alerting Plugin for Fuel
==============================================================================
The StackLight Infrastructure Alerting Plugin for Fuel
======================================================
Overview
--------
The `LMA Infrastructure Alerting Plugin` for Fuel is used to install and
configure Nagios™ which provides the alerting and escalation capabilities
of the LMA Toolchain. The LMA Infrastructure Alerting Plugin is
deployed by [Fuel](https://wiki.openstack.org/wiki/Fuel).
The StackLight Infrastructure Alerting Plugin for Fuel is used
to install and configure Nagios, which provide the alerting and
escalation capability of the Logging, Monitoring and Alerting (LMA)
toolchain of Mirantis OpenStack.
Please check the [LMA Infrastructure Alerting Plugin Overview](
Please start with the [StackLight Infrastructure Alerting Plugin Overview](
http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/en/latest/overview.html)
section of the plugin's documentation for additional details.
to getting started.
Release Notes
-------------
The release notes for this plugin are provided in the
A summary description of the new features are provided in the
[Release Notes](
http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/en/latest/releases.html)
section of the plugin's documentation.
@ -24,30 +24,27 @@ section of the plugin's documentation.
Requirements
------------
The requirements for this plugin are provided in the
[Requirements](
The requirements are provided in the [Requirements](
http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/en/latest/overview.html#requirements)
section of the plugin's documentation.
Known issues
------------
The known issues for this plugin are listed on [Launchpad](
https://bugs.launchpad.net/lma-toolchain/+bugs?field.tag=nagios)
All known issues are listed on [Launchpad](
https://bugs.launchpad.net/lma-toolchain/+bugs?field.tag=nagios).
Limitations
-----------
The known limitations for this plugin are listed in the
[Limitations](
All known limitations are described in the [Limitations](
http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/en/latest/overview.html#limitations)
section of the plugin's documentation.
Installation
------------
The installation instructions for this plugin are provided in the
[Installation](
The installation instructions are provided in the [Installation](
http://fuel-plugin-lma-infrastructure-alerting.readthedocs.org/en/latest/installation.html)
section of the plugin's documentation.

BIN
doc/images/deployment_notification.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 40 KiB

After

Width:  |  Height:  |  Size: 304 KiB

BIN
doc/images/ldap_auth.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 248 KiB

BIN
doc/images/lma_infrastructure_alerting_role.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 69 KiB

After

Width:  |  Height:  |  Size: 151 KiB

BIN
doc/images/lma_infrastructure_alerting_settings.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 98 KiB

After

Width:  |  Height:  |  Size: 226 KiB

BIN
doc/images/tls_settings.png Normal file
View File

Binary file not shown.
Side by Side

After

Width:  |  Height:  |  Size: 64 KiB

BIN
doc/images/toolchain_map.png
View File

Binary file not shown.
Side by Side Swipe Overlay

Before

Width:  |  Height:  |  Size: 106 KiB

After

Width:  |  Height:  |  Size: 1.1 MiB

2
doc/source/overview.rst
View File

@ -4,7 +4,7 @@ Overview
========
The **StackLight Infrastructure Alerting Plugin** is used to install and configure
Nagios which provides the alerting and escalation functionalities of the so-called
Nagios which provides the alerting and escalation functionality of the so-called
Logging, Monitoring and Alerting Toolchain of Mirantis OpenStack.
Nagios is a key component of the `LMA Toolchain project

77
doc/source/user.rst
View File

@ -16,15 +16,15 @@ To configure the **StackLight Intrastructure Alerting Plugin**, you need to foll
2. Click on the *Settings* tab of the Fuel web UI and select the *Other* category.
3. Scroll down through the settings until you find the *StackLight Infrastructure
Alerting Plugin* section. You should see a page like this.
Alerting Plugin* section.
4. Tick the *StackLight Infrastructure Alerting Plugin* box and fill-in the required
fields as indicated below.
.. image:: ../images/lma_infrastructure_alerting_settings.png
:width: 800
:align: center
4. Tick the *StackLight Infrastructure Alerting Plugin* box and fill-in the required
fields as indicated below.
a. Override the Nagios web interface self-generated password if you choose to do so.
#. Check the boxes corresponding to the type of notification you would
like to be alerted for by email (*CRITICAL*, *WARNING*, *UNKNOWN*, *RECOVERY*).
@ -32,9 +32,55 @@ To configure the **StackLight Intrastructure Alerting Plugin**, you need to foll
#. Specify the sender email address for the alerts.
#. Specify the SMTP server address and port.
#. Specify the SMTP authentication method.
#. Specify the SMTP username and password (required if the authentication method isn't *None*).
#. Specify the SMTP username and password (required if the authentication
method isn't *None*).
5. `Configure your environment
5. Tick the *Enable TLS for Nagios* box if you want to encrypt your
Nagios web UI credentials (username, password). Then, fill-in the required
fields as indicated below.
.. image:: ../images/tls_settings.png
:width: 800
:align: center
a. Specify the DNS name of the Nagios web UI. This parameter is used
to create a link from within the Fuel dashboard to the Nagios web UI.
#. Specify the location of a PEM file, which contains the certificate
and the private key of the server, that will be used in TLS handchecks
with the client.
6. Tick the *Use LDAP for Nagios Authentication* box if you want to authenticate
via LDAP to the Nagios Web UI. Then, fill-in the required fields as indicated below.
.. image:: ../images/ldap_auth.png
:width: 800
:align: center
a. Select the *LDAPS* button if you want to enable LDAP authentication
over SSL.
#. Specify one or several LDAP server addresses separated by a space. Those
addresses must be accessible from the node where Nagios is installed.
Note that addresses external to the *management network* are not routable
by default (see the note below).
#. Specify the LDAP server port number or leave it empty to use the defaults.
#. Specify the *Bind DN* of a user who has search priviliges on the LDAP server.
#. Specify the password of the user identified by *Bind DN* above.
#. Specify the *Base DN* in the Directory Information Tree (DIT) from where
to search for users.
#. Specify a valid *search filter* to search for users. The search should
return a unique user entry.
You can further restrict access to the Nagios web UI to those users who
are member of a specific LDAP group. Note however that with the Nagios
web UI there is no notion of privileged (admin) access.
a. Tick the *Enable group-based authorization* to restrict the access to
a group of users.
#. Specify the LDAP attribute in the user entry to identify the
the group of users.
#. Specify the DN of the LDAP group that has access to the Nagios web UI.
7. `Configure your environment
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment.html>`_.
.. note:: By default, StackLight is configured to use the *management network*,
@ -42,14 +88,13 @@ To configure the **StackLight Intrastructure Alerting Plugin**, you need to foll
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/network-settings.html>`_.
While this default setup may be appropriate for small deployments or
evaluation purposes, it is recommended not to use this network
for StackLight in production. Instead it is recommended to create a network
dedicated to StackLight. Using a dedicated network for monitoring should
improve the performance of StackLight and minimize the monitoring footprint
on the control-plane. It will also facilitate access to the Nagios web UI
after deployment. Please refer to the *StackLight Deployment Guide*
for further information about that subject.
for StackLight in production. It is instead recommended to create a network
dedicated to StackLight. Using a dedicated network for StackLight should
improve performances and reduce the monitoring footprint.
It will also facilitate access to the Nagios web UI
after deployment.
6. Click the *Nodes* tab and assign the *Infrastructure_Alerting* role
8. Click the *Nodes* tab and assign the *Infrastructure_Alerting* role
to the node(s) where you want to install the plugin.
You can see in the example below that the *Infrastructure_Alerting*
@ -67,7 +112,7 @@ To configure the **StackLight Intrastructure Alerting Plugin**, you need to foll
Note also that it is possible to add or remove nodes with the
*Infrastructure_Alerting* role after deployment.
7. `Adjust the disk partitioning if necessary
9. `Adjust the disk partitioning if necessary
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/customize-partitions.html>`_.
By default, the StackLight Infrastructure Alerting Plugin allocates:
@ -79,8 +124,8 @@ To configure the **StackLight Intrastructure Alerting Plugin**, you need to foll
The deployment will fail if the above requirements are not met.
8. `Deploy your environment
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
10. `Deploy your environment
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
.. _plugin_install_verification: