summaryrefslogtreecommitdiff
path: root/README.md
blob: f9f9cb93f1d563ce27c08917ef8c16b83570afe3 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
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>