96 lines
3.0 KiB
Markdown
96 lines
3.0 KiB
Markdown
The StackLight Collector Plugin for Fuel
|
|
========================================
|
|
|
|
The StackLight Collector Plugin is used to install and
|
|
configure several software components that are used to
|
|
collect and process all the data that we think is relevant
|
|
to provide deep operational insights about your OpenStack environment.
|
|
These finely integrated components are collectively referred to as
|
|
the StackLight Collector (or just the Collector).
|
|
|
|
The Collecor is a key component of the so-called Logging,
|
|
Monitoring and Alerting (LMA) toolchain of Mirantis OpenStack.
|
|
|
|
Please start with the [StackLight Collector Plugin Overview](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/overview.html)
|
|
to getting started.
|
|
|
|
Release Notes
|
|
-------------
|
|
|
|
A summary description of the features are provided in the [Release Notes](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/releases.html)
|
|
section of the plugin's documentation.
|
|
|
|
Requirements
|
|
------------
|
|
|
|
The requirements are provided in the [Requirements](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/overview.html#requirements)
|
|
section of the plugin's documentation.
|
|
|
|
Known issues
|
|
------------
|
|
|
|
All known issues are listed on [Launchpad](
|
|
https://bugs.launchpad.net/lma-toolchain).
|
|
|
|
Limitations
|
|
-----------
|
|
|
|
All known limitations are described in the [Limitations](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/overview.html#limitations)
|
|
section of the plugin's documentation.
|
|
|
|
Installation
|
|
------------
|
|
|
|
The installation instructions of the StackLight Collector are provided
|
|
in the [Installation](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/installation.html#installation)
|
|
section of the plugin's documentation.
|
|
|
|
User Guide
|
|
----------
|
|
|
|
Instructions for how to configure the StackLight Collector
|
|
are provided in the [Configuration Guide](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/configuration.html)
|
|
and [Alarms Configuration Guide](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/alarms.html)
|
|
sections of the plugin's documentation.
|
|
|
|
Communication
|
|
-------------
|
|
|
|
The *OpenStack Development Mailing List* is the preferred way to communicate
|
|
with the members of the project.
|
|
Emails should be sent to `openstack-dev@lists.openstack.org` with the subject
|
|
prefixed by `[fuel][plugins][lma]`.
|
|
|
|
Reporting Bugs
|
|
--------------
|
|
|
|
Bugs should be filed against the [LMA toolchain project](
|
|
https://launchpad.net/lma-toolchain) on Launchpad (not Github!).
|
|
|
|
Contributing
|
|
------------
|
|
|
|
If you would like to contribute to the development of this plugin,
|
|
you must follow the [OpenStack development workflow](
|
|
http://docs.openstack.org/infra/manual/developers.html#development-workflow)
|
|
instructions.
|
|
|
|
Patch reviews take place on the [OpenStack Gerrit](
|
|
https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-lma-collector,n,z)
|
|
system.
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* Guillaume Thouvenin <gthouvenin@mirantis.com>
|
|
* Patrick Petit <ppetit@mirantis.com>
|
|
* Simon Pasquier <spasquier@mirantis.com>
|
|
* Swann Croiset <scroiset@mirantis.com>
|