93 lines
2.9 KiB
Markdown
93 lines
2.9 KiB
Markdown
The StackLight Elasticsearch-Kibana Plugin for Fuel
|
|
===================================================
|
|
|
|
The StackLight Elasticsearch-Kibana Plugin for Fuel is used
|
|
to install and configure [Elasticsearch](
|
|
https://www.elastic.co/products/elasticsearch) and
|
|
[Kibana](https://www.elastic.co/products/kibana) which collectively
|
|
provide access to the logs and notifications analytics of
|
|
Mirantis OpenStack. The logs and the notifications of Mirantis
|
|
OpenStack are collected and processed by the [StackLight Collector](
|
|
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/index.html).
|
|
|
|
Please go to the [Elasticsearch-Kibana Plugin Overview](
|
|
http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/overview.html#overview)
|
|
to getting started.
|
|
|
|
Release Notes
|
|
-------------
|
|
|
|
A summary description of the new features are provided in the
|
|
[Release Notes](
|
|
http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/releases.html)
|
|
section of the plugin documentation.
|
|
|
|
Requirements
|
|
------------
|
|
|
|
The requirements are defined in the [Requirements](
|
|
http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/overview.html#requirements)
|
|
section of the plugin 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-elasticsearch-kibana.readthedocs.org/en/latest/overview.html#limitations)
|
|
section of the plugin documentation.
|
|
|
|
Installation
|
|
------------
|
|
|
|
The installation instructions are provided in the [Installation](
|
|
http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/installation.html)
|
|
section of the plugin documentation.
|
|
|
|
User Guide
|
|
----------
|
|
|
|
Instructions for how to configure and use the Elasticsearch-Kibana Plugin
|
|
are provided in the [User Guide](
|
|
http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/user.html)
|
|
section of the plugin 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 within [OpenStack Gerrit](
|
|
https://review.openstack.org/#/q/status:open+project:openstack/fuel-plugin-elasticsearch-kibana,n,z)
|
|
system.
|
|
|
|
Contributors
|
|
------------
|
|
|
|
* Guillaume Thouvenin <gthouvenin@mirantis.com>
|
|
* Patrick Petit <ppetit@mirantis.com>
|
|
* Simon Pasquier <spasquier@mirantis.com>
|
|
* Swann Croiset <scroiset@mirantis.com>
|