StackLight 0.10.0 documentation updates
Change-Id: I7c4f3a8970618d887198315e8e3f05e06ad087d6
This commit is contained in:
Patrick Petit
parent
fd448620de
commit
c2df7ef45a
32
README.md
32
README.md
|
|
@ -1,22 +1,23 @@
|
|||
The Elasticsearch-Kibana Plugin for Fuel
|
||||
========================================
|
||||
The StackLight Elasticsearch-Kibana Plugin for Fuel
|
||||
===================================================
|
||||
|
||||
The Elasticsearch-Kibana Plugin for Fuel is used to install and configure
|
||||
[Elasticsearch](https://www.elastic.co/products/elasticsearch) and
|
||||
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 OpenStack analytics for the logs and the notifications collected
|
||||
and processed by the [LMA Collector](
|
||||
http://fuel-plugin-lma-collector.readthedocs.org/en/latest/index.html)
|
||||
Plugin.
|
||||
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 check the [Elasticsearch-Kibana Plugin Overview](
|
||||
Please go to the [Elasticsearch-Kibana Plugin Overview](
|
||||
http://fuel-plugin-elasticsearch-kibana.readthedocs.org/en/latest/overview.html#overview)
|
||||
section of the plugin documentation for additional details.
|
||||
to getting started.
|
||||
|
||||
Release Notes
|
||||
-------------
|
||||
|
||||
The release notes of the Elasticsearch-Kibana Plugin are provided in the
|
||||
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.
|
||||
|
|
@ -24,28 +25,27 @@ section of the plugin documentation.
|
|||
Requirements
|
||||
------------
|
||||
|
||||
The Elasticsearch-Kibana Plugin requirements are defined in the [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
|
||||
------------
|
||||
|
||||
The LMA Toolchain's related issues are available on [Launchpad](
|
||||
All known issues are listed on [Launchpad](
|
||||
https://bugs.launchpad.net/lma-toolchain).
|
||||
|
||||
Limitations
|
||||
-----------
|
||||
|
||||
The Elasticsearch-Kibana Plugin limitations are described in the [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 of the Elasticsearch-Kibana Plugin are provided
|
||||
in the [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.
|
||||
|
||||
|
|
|
|||
Binary file not shown.
|
Before Width: | Height: | Size: 54 KiB After Width: | Height: | Size: 304 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 69 KiB After Width: | Height: | Size: 151 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 26 KiB After Width: | Height: | Size: 132 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 126 KiB After Width: | Height: | Size: 53 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 199 KiB After Width: | Height: | Size: 587 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 287 KiB After Width: | Height: | Size: 384 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 97 KiB After Width: | Height: | Size: 66 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 89 KiB After Width: | Height: | Size: 382 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 807 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 202 KiB |
Binary file not shown.
|
Before Width: | Height: | Size: 111 KiB After Width: | Height: | Size: 1.1 MiB |
|
|
@ -94,20 +94,20 @@ status for the Elasticsearch cluster::
|
|||
Deployment using network templates
|
||||
----------------------------------
|
||||
|
||||
By default, the Elasticsearch-Kibana cluster is deployed on the Fuel management
|
||||
network. If this behavior doesn't meet your needs, you can leverage the
|
||||
By default, the Elasticsearch-Kibana cluster will be deployed on the Fuel management
|
||||
network. If this default configuration doesn't meet your requirements, you can leverage the
|
||||
Fuel `network templates
|
||||
<https://docs.mirantis.com/openstack/fuel/fuel-8.0/operations.html#using-networking-templates>`_
|
||||
to use a different network instead.
|
||||
capability to change that default configuration to use a dedicated network instead.
|
||||
|
||||
Here is a network template example that defines a new network named `monitoring`.
|
||||
Below is a network template example to define a new network named `monitoring`.
|
||||
|
||||
.. literalinclude:: ./network_template.yaml
|
||||
|
||||
You can use this configuration as a starting point and adapt it to your setup.
|
||||
You can use this configuration example as a starting point and adapt it to your requirements.
|
||||
|
||||
The deployment of the environment happens as described in the :ref:`User Guide
|
||||
<user_guide>` except that before deploying the environment, you have to:
|
||||
The deployment of the environment should work as described in the :ref:`User Guide
|
||||
<user_guide>` excepted that before deploying the environment, you will have to:
|
||||
|
||||
* Upload the network template::
|
||||
|
||||
|
|
|
|||
|
|
@ -5,7 +5,7 @@ source_suffix = '.rst'
|
|||
|
||||
master_doc = 'index'
|
||||
|
||||
project = u'The Elasticsearch-Kibana plugin for Fuel'
|
||||
project = u'The StackLight Elasticsearch-Kibana Plugin for Fuel'
|
||||
copyright = u'2015, Mirantis Inc.'
|
||||
|
||||
version = '0.10'
|
||||
|
|
@ -19,7 +19,7 @@ html_theme = 'default'
|
|||
html_static_path = ['_static']
|
||||
|
||||
latex_documents = [
|
||||
('index', 'ElasticsearchKibana.tex', u'The Elasticsearch-Kibana plugin for Fuel Documentation',
|
||||
('index', 'ElasticsearchKibana.tex', u'The StackLight Elasticsearch-Kibana Plugin for Fuel Documentation',
|
||||
u'Mirantis Inc.', 'manual'),
|
||||
]
|
||||
|
||||
|
|
|
|||
|
|
@ -1,6 +1,6 @@
|
|||
============================================================================
|
||||
Welcome to the Mirantis OpenStack Elasticsearch-Kibana Plugin Documentation!
|
||||
============================================================================
|
||||
====================================================================
|
||||
Welcome to the StackLight Elasticsearch-Kibana Plugin Documentation!
|
||||
====================================================================
|
||||
|
||||
User documentation
|
||||
==================
|
||||
|
|
|
|||
|
|
@ -3,20 +3,24 @@
|
|||
Installation Guide
|
||||
==================
|
||||
|
||||
Elasticsearch-Kibana Fuel Plugin Installation using the RPM file of the Fuel Plugins Catalog
|
||||
StackLight Elasticsearch-Kibana Plugin installation using the RPM file of the Fuel Plugins Catalog
|
||||
--------------------------------------------------------------------------------------------
|
||||
|
||||
To install the Elasticsearch-Kibana Fuel Plugin using the RPM file of the Fuel Plugins
|
||||
To install the StackLight Elasticsearch-Kibana Fuel Plugin using the RPM file of the Fuel Plugins
|
||||
Catalog, you need to follow these steps:
|
||||
|
||||
1. Download the RPM file from the `Fuel Plugins Catalog <https://software.mirantis.com/download-mirantis-openstack-fuel-plug-ins/>`_.
|
||||
|
||||
1. Select, using the MONITORING category and Mirantis OpenStack version you are using,
|
||||
the RPM file you want to download from the `Fuel Plugins Catalog
|
||||
<https://www.mirantis.com/validated-solution-integrations/fuel-plugins>`_.
|
||||
|
||||
2. Copy the RPM file to the Fuel Master node::
|
||||
|
||||
[root@home ~]# scp elasticsearch_kibana-0.10-0.10.0-0.noarch.rpm \
|
||||
root@<Fuel Master node IP address>:
|
||||
|
||||
3. Install the plugin using the `Fuel CLI <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#using-fuel-cli>`_::
|
||||
3. Install the plugin using the `Fuel CLI
|
||||
<http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#using-fuel-cli>`_::
|
||||
|
||||
[root@fuel ~]# fuel plugins --install elasticsearch_kibana-0.10-0.10.0-0.noarch.rpm
|
||||
|
||||
|
|
@ -27,16 +31,17 @@ Catalog, you need to follow these steps:
|
|||
---|----------------------|----------|----------------
|
||||
1 | elasticsearch_kibana | 0.10.0 | 4.0.0
|
||||
|
||||
Elasticsearch-Kibana Fuel Plugin installation from source
|
||||
---------------------------------------------------------
|
||||
StackLight Elasticsearch-Kibana Fuel Plugin installation from source
|
||||
--------------------------------------------------------------------
|
||||
|
||||
Alternatively, you may want to build the RPM file of the plugin from source
|
||||
if, for example, you want to test the latest features, modify some built-in
|
||||
configuration or implement your own customization.
|
||||
But note that running a Fuel plugin that you have built yourself is at your own risk.
|
||||
Alternatively, you may want to build the RPM file of the plugin from source if,
|
||||
for example, you want to test the latest features of the master branch or customize the plugin.
|
||||
|
||||
To install Elasticsearch-Kibana Plugin from source, you first need to prepare an
|
||||
environment to build the RPM file.
|
||||
.. note:: Be aware that running a Fuel plugin that you built yourself is at your
|
||||
own risk and will not be supported.
|
||||
|
||||
To install StacLight Elasticsearch-Kibana 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 won't have to copy that file later on.
|
||||
|
||||
|
|
@ -54,11 +59,11 @@ node so that you won't have to copy that file later on.
|
|||
|
||||
[root@home ~] pip install fuel-plugin-builder
|
||||
|
||||
**Note**: You may also need to build the Fuel Plugin Builder if the package version of the
|
||||
plugin is higher than the package version supported by the Fuel Plugin Builder you get from `pypi`.
|
||||
In this case, please refer to the section "Preparing an environment for plugin development"
|
||||
of the `Fuel Plugins wiki <https://wiki.openstack.org/wiki/Fuel/Plugins>`_,
|
||||
if you need further instructions about how to build the Fuel Plugin Builder.
|
||||
.. note:: You may also need to build the Fuel Plugin Builder if the package version of the
|
||||
plugin is higher than the package version supported by the Fuel Plugin Builder you get from `pypi`.
|
||||
In this case, please refer to the section "Preparing an environment for plugin development"
|
||||
of the `Fuel Plugins wiki <https://wiki.openstack.org/wiki/Fuel/Plugins>`_,
|
||||
if you need further instructions about how to build the Fuel Plugin Builder.
|
||||
|
||||
4. Clone the plugin git repository::
|
||||
|
||||
|
|
@ -79,17 +84,17 @@ if you need further instructions about how to build the Fuel Plugin Builder.
|
|||
./fuel-plugin-elasticsearch-kibana/*.noarch.rpm
|
||||
|
||||
|
||||
Elasticsearch-Kibana Fuel Plugin software components
|
||||
----------------------------------------------------
|
||||
StackLight Elasticsearch-Kibana Fuel Plugin software components
|
||||
---------------------------------------------------------------
|
||||
|
||||
List of software components installed by the plugin
|
||||
|
||||
+---------------+--------------------------------------------------------+
|
||||
| Components | Version |
|
||||
+===============+========================================================+
|
||||
| Elasticsearch | v1.7.4 for Ubuntu (64-bit) |
|
||||
| Elasticsearch | v2.3.3 for Ubuntu (64-bit) |
|
||||
+---------------+--------------------------------------------------------+
|
||||
| Kibana | v3.1.3 |
|
||||
| Kibana | v4.5 |
|
||||
+---------------+--------------------------------------------------------+
|
||||
| Nginx | Version coming by default with the Ubuntu distribution |
|
||||
| Apache | Version coming by default with the Ubuntu distribution |
|
||||
+---------------+--------------------------------------------------------+
|
||||
|
|
|
|||
|
|
@ -26,7 +26,7 @@ Puppet modules
|
|||
+------------------------+-------------------------------------------------------------+------------+
|
||||
| Stdlib | https://github.com/puppetlabs/puppetlabs-stdlib | Apache V2 |
|
||||
+------------------------+-------------------------------------------------------------+------------+
|
||||
| Nginx | https://github.com/jfryman/puppet-nginx | MIT license|
|
||||
| Apache | https://github.com/puppetlabs/puppetlabs-apache | Apache V2 |
|
||||
+------------------------+-------------------------------------------------------------+------------+
|
||||
| Firewall | https://github.com/puppetlabs/puppetlabs-firewall | Apache V2 |
|
||||
+------------------------+-------------------------------------------------------------+------------+
|
||||
|
|
|
|||
|
|
@ -3,10 +3,11 @@
|
|||
Overview
|
||||
========
|
||||
|
||||
The **Elasticsearch-Kibana Fuel Plugin** is used to install and configure
|
||||
Elasticsearch and Kibana which collectively provide access to the OpenStack
|
||||
logs and notifications analytics.
|
||||
Those analytics can be used to search and correlate service-affecting
|
||||
The **StackLight Elasticsearch-Kibana Plugin** is used to install and configure
|
||||
Elasticsearch and Kibana which collectively provide access to the logs and
|
||||
notifications analytics of the so-called Logging, Monitoring and Alerting (LMA)
|
||||
Toolchain of Mirantis OpenStack.
|
||||
These analytics can be used to search and correlate service-affecting
|
||||
events which occurred in your OpenStack environment. It is an indispensable
|
||||
tool to troubleshooting problems.
|
||||
|
||||
|
|
@ -29,7 +30,7 @@ Requirements
|
|||
| | system, 10GB for the logs and 30GB for the database. As a result, the installation |
|
||||
| | of the plugin will fail if there is less than 55GB of disk space available on the node. |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
| Mirantis OpenStack | 8.0 |
|
||||
| Mirantis OpenStack | 8.0, 9.0 |
|
||||
+------------------------+------------------------------------------------------------------------------------------+
|
||||
| Hardware configuration | The hardware configuration (RAM, CPU, disk) required by this plugin depends on the size |
|
||||
| | of your cloud environment and other parameters like the retention period and log level. |
|
||||
|
|
@ -57,8 +58,8 @@ Key terms, acronyms and abbreviations
|
|||
+----------------------------+--------------------------------------------------------------------------------------+
|
||||
| **Terms & acronyms** | **Definition** |
|
||||
+============================+======================================================================================+
|
||||
| LMA Collector | Logging, Monitoring and Alerting (LMA) Collector. A service running on each node |
|
||||
| | which collects all the logs and the OpenStak notifications. |
|
||||
| The Collector | The StackLight Collector is a smart monitoring agent running on every node which |
|
||||
| | collects and processes the logs and the notifications of your OpenStack environment. |
|
||||
+----------------------------+--------------------------------------------------------------------------------------+
|
||||
| Elasticsearch | An open source (Apache Licensed) application based on the Lucene™ search engine |
|
||||
| | that makes data like log messages easy to explore and correlate. |
|
||||
|
|
|
|||
|
|
@ -6,6 +6,20 @@ Release Notes
|
|||
Version 0.10.0
|
||||
--------------
|
||||
|
||||
* Changes
|
||||
|
||||
* Add support for LDAP(S) authentication to access the Kibana UI.
|
||||
* Add support for TLS encryption to access the Kibana UI.
|
||||
A PEM file (obtained by concatenating the SSL certificate with the private key)
|
||||
must be provided in the settings of the plugin to configure the TLS termination.
|
||||
* Upgrade to Elasticsearch v2.3.3.
|
||||
* Upgrade to Kibana v4.5.
|
||||
|
||||
* Bug Fixes
|
||||
|
||||
* Logs and notifications are dropped during a "long" Elasticsearch outage (`#1566748
|
||||
<https://bugs.launchpad.net/lma-toolchain/+bug/1566748>`_).
|
||||
|
||||
Version 0.9.0
|
||||
-------------
|
||||
|
||||
|
|
|
|||
|
|
@ -8,73 +8,131 @@ User Guide
|
|||
Plugin configuration
|
||||
--------------------
|
||||
|
||||
To configure your plugin, you need to follow these steps:
|
||||
To configure the **StackLight Elasticsearch-Kibana Plugin**, you need to follow these steps:
|
||||
|
||||
1. `Create a new environment <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#launch-wizard-to-create-new-environment>`_
|
||||
from the Fuel web user interface.
|
||||
1. `Create a new environment
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_.
|
||||
|
||||
#. Click the **Settings** tab and select the **Other** category.
|
||||
2. Click on the *Settings* tab of the Fuel web UI and select the *Other* category.
|
||||
|
||||
#. Scroll down through the settings until you find the **Elasticsearch-Kibana Server
|
||||
Plugin** section. You should see a page like this.
|
||||
3. Scroll down through the settings until you find the *StackLight Elasticsearch-Kibana
|
||||
Plugin* section.
|
||||
|
||||
4. Tick the *StackLight Infrastructure Alerting Plugin* box and fill-in the required
|
||||
fields as indicated below.
|
||||
|
||||
.. image:: ../images/elastic_kibana_settings.png
|
||||
:width: 800
|
||||
:align: center
|
||||
|
||||
#. Check the *Elasticsearch-Kibana Server Plugin* box and fill-in the required fields
|
||||
as indicated below.
|
||||
|
||||
a. Specify the number of days of retention for your data.
|
||||
b. Specify the JVM heap size for Elastisearch. See configuration recommendations below.
|
||||
#. Specify the JVM heap size for Elastisearch. See the configuration recommendations below.
|
||||
|
||||
.. note:: By default, 1GB of heap memory is allocated to the Elasticsearch process.
|
||||
This value is too small to run Elasticsearch for anything else than local testing.
|
||||
To run Elasticsearch in production you need to allocate at least 4 GB of memory
|
||||
but it is recommended to allocate 50% of the available memory up to 32 GB maximum.
|
||||
If you set a value that is greater than the memory size, Elasticsearch won't start.
|
||||
Keep in mind also to reserve enough memory for the operating system and the other services.
|
||||
.. note:: By default, 1GB of heap memory is allocated to the Elasticsearch process.
|
||||
This value is too small to run Elasticsearch for anything else than local testing.
|
||||
To run Elasticsearch in production you need to allocate at least 4 GB of memory
|
||||
but it is recommended to allocate 50% of the available memory up to 32 GB maximum.
|
||||
If you set a value that is greater than the memory size, Elasticsearch won't start.
|
||||
Keep in mind also to reserve enough memory for the operating system and the other services.
|
||||
|
||||
At this point, you can choose to edit advanced settings or let the plugin
|
||||
apply sane defaults for you. The advanced settings are used to specify the clustering
|
||||
parameters when the *Elasticsearch-Kibana Server Plugin* is installed on more than one node.
|
||||
To manually configure those advanced settings, check the *Advanced settings* box and fill-in
|
||||
the required parameters.
|
||||
#. At this point, you can choose to either edit the *Advanced settings* or let the plugin
|
||||
decide the defaults for you. The advanced settings are used to specify advanced settings
|
||||
when Elasticsearch and Kibana are installed on a cluster of nodes.
|
||||
To manually configure those advanced settings, check the *Advanced settings* box and fill-in
|
||||
the required parameters.
|
||||
|
||||
#. When you are done with the settings, scroll down to the bottom of the page and click
|
||||
the **Save Settings** button.
|
||||
5. Tick the *Enable TLS for Kibana* box if you want to encrypt your
|
||||
Kibana 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 Kibana server. This parameter is used
|
||||
to create a link in the Fuel dashboard to the Kibana server.
|
||||
#. Specify the location of a PEM file that contains the certificate
|
||||
and the private key of the Kibana server that will be used in TLS handchecks
|
||||
with the client.
|
||||
|
||||
6. Tick the *Use LDAP for Kibana Authentication* box if you want to authenticate
|
||||
via LDAP to Kibana. 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 Kibana 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 the *Bind DN* above.
|
||||
#. Specify the *Base DN* in the Directory Information Tree (DIT) from where
|
||||
to search for users.
|
||||
#. Specify a valid attribute (ex. 'uid') to search for users. The search should
|
||||
return a unique user entry.
|
||||
#. Specify a valid search filter (ex. '(objectClass=*') to search for users.
|
||||
|
||||
You can further restrict access to Kibana to those users who
|
||||
are member of a specific LDAP group.
|
||||
|
||||
a. Tick the *Enable group-based authorization*.
|
||||
#. Specify the LDAP attribute (ex. memberUid) in the user entry
|
||||
that identifies the LDAP group membership.
|
||||
#. Specify the DN of the LDAP group that will be mapped to the *admin role*
|
||||
#. Specify the DN of the LDAP group that will be mapped to the *viewer role*
|
||||
|
||||
Users who have the *admin role* can modify the Kibana dashboards
|
||||
or create new ones. Users who have the *Viewer role* can only
|
||||
visualise the Kibana dashboards.
|
||||
|
||||
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*,
|
||||
of the so-called `Default Node Network Group
|
||||
<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. 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 Kibana UI after deployment.
|
||||
|
||||
8. Click the *Nodes* tab and assign the *Elasticsearch_Kibana* role
|
||||
to the node(s) where you want to install the plugin.
|
||||
|
||||
You can see in the example below that the *Elasticsearch_Kibana*
|
||||
role is assigned to three nodes along side with the
|
||||
*Alerting_Infrastructure* and the *InfluxDB_Grafana* roles.
|
||||
Here, the three plugins of the LMA toolchain backend servers are
|
||||
installed on the same nodes.
|
||||
|
||||
#. Click the *Nodes* tab and assign the *Elasticsearch_Kibana* role to nodes as shown
|
||||
in the figure below. You can see in this example that the *Elasticsearch_Kibana* role
|
||||
is assigned to three different nodes along with the *Infrastructure_Alerting* role
|
||||
and the *InfluxDB_Grafana* role. This means that the three plugins of the LMA toolchain
|
||||
can be installed on the same nodes.
|
||||
|
||||
.. image:: ../images/elastic_kibana_role.png
|
||||
:width: 800
|
||||
:align: center
|
||||
|
||||
.. note:: You can assign the *Elasticsearch_Kibana* role up to five nodes.
|
||||
The Elasticsearch clustering for high availability requires that you assign
|
||||
the *Elasticsearch_Kibana* role to at least three nodes. Note also that
|
||||
is possible to add or remove a node with the *Elasticsearch_Kibana* role after deployment.
|
||||
.. note:: The Elasticsearch clustering for high availability requires
|
||||
that you assign the *Elasticsearch_Kibana* role to at least three nodes,
|
||||
but you can assign the *Elasticsearch_Kibana* role up to five nodes.
|
||||
Note also that is possible to add or remove a node with the *Elasticsearch_Kibana*
|
||||
role after deployment.
|
||||
|
||||
#. Click on **Apply Changes**
|
||||
9. `Adjust the disk partitioning if necessary
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/configure-environment/customize-partitions.html>`_.
|
||||
|
||||
#. Adjust the disk configuration if necessary (see the `Fuel User Guide
|
||||
<http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#disk-partitioning>`_
|
||||
for details). By default, the Elasticsearch-Kibana Plugin allocates:
|
||||
By default, the Elasticsearch-Kibana Plugin allocates:
|
||||
|
||||
- 20% of the first available disk for the operating system by honoring a range of 15GB minimum and 50GB maximum.
|
||||
- 10GB for */var/log*.
|
||||
- At least 30 GB for the Elasticsearch database in */opt/es-data*.
|
||||
* 20% of the first available disk for the operating system by honoring a range of 15GB minimum and 50GB maximum.
|
||||
* 10GB for */var/log*.
|
||||
* At least 30 GB for the Elasticsearch database in */opt/es-data*.
|
||||
|
||||
#. `Configure your environment <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#configure-your-environment>`_
|
||||
as needed.
|
||||
|
||||
#. `Verify the networks <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#verify-networks>`_ on the Networks tab of the Fuel web UI.
|
||||
|
||||
#. And finally, `Deploy <http://docs.mirantis.com/openstack/fuel/fuel-8.0/user-guide.html#deploy-changes>`_ your changes.
|
||||
10. `Deploy your environment
|
||||
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
|
||||
|
||||
.. _plugin_install_verification:
|
||||
|
||||
|
|
@ -83,17 +141,20 @@ Plugin verification
|
|||
|
||||
Be aware, that depending on the number of nodes and deployment setup,
|
||||
deploying a Mirantis OpenStack environment can typically take anything
|
||||
from 30 minutes to several hours. But once your deployment is complete,
|
||||
you should see a deployment success notification message with
|
||||
a link to the Kibana dashboard as shown in the figure below:
|
||||
from 20 minutes to several hours. But once your deployment is complete,
|
||||
you should see a deployment success notification message with two
|
||||
links to Kibana as shown in the figure below:
|
||||
|
||||
.. image:: ../images/deploy_notif.png
|
||||
:align: center
|
||||
:width: 800
|
||||
|
||||
.. note:: Be aware that Kibana is attached to the *management network*.
|
||||
Your desktop machine must have access to the OpenStack environment's
|
||||
*management network* you just created, to get access to the Kibana dashboard
|
||||
.. note:: For technical reasons, it was necessary to create two different ports
|
||||
to enforce the access authorization to Kibana. One port (80) for users with the
|
||||
*admin role* and one port (81) for users with the *viewer role*.
|
||||
Be also aware that if Kibana is installed on the *management network*,
|
||||
you may not have direct access to the UI. Some extra network
|
||||
configuration may be required to create an SSH tunnel to the *management network*.
|
||||
|
||||
Verifying Elasticsearch
|
||||
~~~~~~~~~~~~~~~~~~~~~~~
|
||||
|
|
@ -143,8 +204,10 @@ Here is how to proceed.
|
|||
Verifying Kibana
|
||||
~~~~~~~~~~~~~~~~
|
||||
|
||||
From the Fuel web UI **Dashboard** view, click on the **Kibana** link,
|
||||
you should be directed to the *Logs Dashboard* as shown in the figure below.
|
||||
From the Fuel dashboard, click on the *Kibana (Admin role)* link
|
||||
(or enter the IP address and port number if your DNS is not setup),
|
||||
then enter your credentials. You should be redirected to a Kibana 4
|
||||
**Logs Anaytics Dashboard** as shown in the figure below.
|
||||
|
||||
.. image:: ../images/kibana_logs_dash.png
|
||||
:align: center
|
||||
|
|
@ -153,11 +216,12 @@ you should be directed to the *Logs Dashboard* as shown in the figure below.
|
|||
Dashboards management
|
||||
---------------------
|
||||
|
||||
The *Elasticsearch-Kibana Server Plugin* comes with two predefined dashboards:
|
||||
The StackLight Elasticsearch-Kibana Plugin comes with two built-in dashboards:
|
||||
|
||||
- The *Logs Dashboard* which is the Kibana Home Dashboard for viewing the log messages.
|
||||
- The *Notifications Dashboard* for viewing the OpenStack notifications if you enabled
|
||||
this option in the LMA Collector settings.
|
||||
* The Logs Analytics Dashboard that is used to visualize and search the logs.
|
||||
* The Notifications Analytics Dashboard that is used to visualize and
|
||||
search the OpenStack notifications if you enabled the feature in the
|
||||
Collector settings.
|
||||
|
||||
You can switch from one dashboard to another by clicking on the top-right *Load*
|
||||
icon in the toolbar to select the requested dashboard from the list, as shown below.
|
||||
|
|
@ -167,45 +231,45 @@ icon in the toolbar to select the requested dashboard from the list, as shown be
|
|||
:width: 800
|
||||
|
||||
Each dashboard provides a single pane of glass for visualizing and searching
|
||||
all the logs and notifications of your OpenStack environment.
|
||||
Note that in the LMA Collector settings, it is possible to tag the logs by
|
||||
all the logs and the notifications of your OpenStack environment.
|
||||
Note that in the Collector settings it is possible to tag the logs by
|
||||
environment name so that you can distinguish which logs (and notifications)
|
||||
belong to which environment.
|
||||
belong to what environment.
|
||||
|
||||
As you can see, the Kibana dashboard for logs is divided into four main sections:
|
||||
As you can see, the Kibana dashboard for logs is divided in several sections:
|
||||
|
||||
.. image:: ../images/kibana_logs_sections.png
|
||||
.. image:: ../images/kibana_logs_sections_1.png
|
||||
:align: center
|
||||
:width: 800
|
||||
|
||||
1. A time-picker control that lets you choose the time period you want
|
||||
to select and refresh frequency.
|
||||
|
||||
2. A query and filter section where all the filters are displayed.
|
||||
2. A text-box to enter search queries.
|
||||
|
||||
3. A log analytics row which contains six panels to visualize:
|
||||
3. Various logs analytics with six different panels:
|
||||
|
||||
a. The number of log messages for the chosen time period.
|
||||
|
||||
b. The top 10 hosts filter.
|
||||
|
||||
c. The top 10 log sources.
|
||||
|
||||
d. The number of log messages grouped by severity.
|
||||
|
||||
e. The top 10 programs.
|
||||
|
||||
f. The number of log messages grouped by role.
|
||||
a. A stack graph showing all the logs per source.
|
||||
b. A stack graph showing all the logs per severity.
|
||||
c. A stack graph showing all logs top 10 sources.
|
||||
d. A stack graph showing all the logs top 10 programs.
|
||||
e. A stack graph showing all logs top 10 hosts.
|
||||
f. A graph showing the number of logs per severity.
|
||||
g. A graph showing the number of logs per role.
|
||||
|
||||
4. A table of log messages sorted in reverse chronological order.
|
||||
|
||||
.. image:: ../images/kibana_logs_sections_2.png
|
||||
:align: center
|
||||
:width: 800
|
||||
|
||||
Filters and queries
|
||||
-------------------
|
||||
|
||||
Filters and queries have similar syntax but they are used for different purposes.
|
||||
|
||||
- The filters are used to restrict what is displayed in the dashboard.
|
||||
- The queries are used for free-text search.
|
||||
* The filters are used to restrict what is displayed in the dashboard.
|
||||
* The queries are used for free-text search.
|
||||
|
||||
You can also combine multiple queries and compare their results.
|
||||
To further filter the log messages to, for example, select the *deployment_id*,
|
||||
|
|
@ -225,7 +289,7 @@ This will apply a new filter in the dashboard.
|
|||
Filtering will work for any field that has been indexed for the log entries that
|
||||
are in the dashboard.
|
||||
|
||||
Filters and queries can also use wildcards which can be combined with *field names* like in::
|
||||
Filters and queries can also use wildcards that can be combined with *field names* like in::
|
||||
|
||||
programname: <name>*
|
||||
|
||||
|
|
@ -239,32 +303,20 @@ in the query textbox as shown below.
|
|||
:align: center
|
||||
:width: 800
|
||||
|
||||
You can also specify multiple queries to compare different data sets.
|
||||
|
||||
To add a new query, click on the **+** sign at the right-end of the query
|
||||
textbox and enter a new search query.
|
||||
|
||||
The resulting filtering should appear comparing those logs that are
|
||||
in *ERROR* versus those that are not as shown below.
|
||||
|
||||
.. image:: ../images/kibana_logs_query2.png
|
||||
:align: center
|
||||
:width: 800
|
||||
|
||||
Troubleshooting
|
||||
---------------
|
||||
|
||||
If you cannot access the Kibana dashboard or you get no data in the dashboard,
|
||||
follow these troubleshooting tips.
|
||||
|
||||
1. First, check that the LMA Collector is running properly by following the
|
||||
LMA Collector troubleshooting instructions in the
|
||||
`LMA Collector Fuel Plugin User Guide <http://fuel-plugin-lma-collector.readthedocs.io/>`_.
|
||||
1. First, check that the StackLight Collector is running properly by following the
|
||||
`StackLight Collector troubleshooting instructions
|
||||
<http://fuel-plugin-lma-collector.readthedocs.io/>`_.
|
||||
|
||||
#. Check that the nodes are able to connect to the Elasticsearch cluster via the VIP address
|
||||
on port *9200* as explained in the `Verifying Elasticsearch` section above.
|
||||
|
||||
#. On anyone of the *Elasticsearch_Kibana* role nodes, check the status of the VIP address
|
||||
#. On any of the *Elasticsearch_Kibana* role nodes, check the status of the VIP address
|
||||
and HAProxy resources in the Pacemaker cluster::
|
||||
|
||||
root@node-1:~# crm resource status vip__es_vip_mgmt
|
||||
|
|
@ -288,16 +340,16 @@ follow these troubleshooting tips.
|
|||
# On both CentOS and Ubuntu
|
||||
[root@node-1 ~]# /etc/init.d/elasticsearch-es-01 start
|
||||
|
||||
#. Check if nginx is up and running::
|
||||
#. Check the apache is up and running::
|
||||
|
||||
# On both CentOS and Ubuntu
|
||||
[root@node-1 ~]# /etc/init.d/nginx status
|
||||
[root@node-1 ~]# /etc/init.d/apache2 status
|
||||
|
||||
#. If nginx is down, restart it::
|
||||
#. If apache is down, restart it::
|
||||
|
||||
# On both CentOS and Ubuntu
|
||||
[root@node-1 ~]# /etc/init.d/nginx start
|
||||
[root@node-1 ~]# /etc/init.d/apache2 start
|
||||
|
||||
#. Look for errors in the Elasticsearch log files (located at /var/log/elasticsearch/es-01/).
|
||||
|
||||
#. Look for errors in the nginx log files (located at /var/log/nginx/).
|
||||
#. Look for errors in the apache log files (located at /var/log/apache2/).
|
||||
|
|
|
|||
|
|
@ -262,7 +262,7 @@ attributes:
|
|||
ldap_authorization_enabled:
|
||||
value: false
|
||||
label: 'Enable group-based authorization'
|
||||
description: 'It allows to associate the users with the Admin or Viewer role. Otherwise all users are assigned to admin role.'
|
||||
description: 'It allows to associate users with the Admin or Viewer role. Otherwise all users are assigned to Admin role by default.'
|
||||
weight: 200
|
||||
type: "checkbox"
|
||||
restrictions:
|
||||
|
|
@ -286,7 +286,7 @@ attributes:
|
|||
|
||||
ldap_admin_group_dn:
|
||||
value: ''
|
||||
label: 'Group DN mapping to the Admins role'
|
||||
label: 'Group DN mapping to the Admin role'
|
||||
description: ''
|
||||
weight: 210
|
||||
type: "text"
|
||||
|
|
@ -301,7 +301,7 @@ attributes:
|
|||
|
||||
ldap_viewer_group_dn:
|
||||
value: ''
|
||||
label: 'Group DN mapping to the Viewers role'
|
||||
label: 'Group DN mapping to the Viewer role'
|
||||
description: ''
|
||||
weight: 220
|
||||
type: "text"
|
||||
|
|
|
|||
|
|
@ -1,7 +1,7 @@
|
|||
# Plugin name
|
||||
name: elasticsearch_kibana
|
||||
# Human-readable name for your plugin
|
||||
title: The Elasticsearch-Kibana Server Plugin
|
||||
title: The StackLight Elasticsearch-Kibana Server Plugin
|
||||
# Plugin version
|
||||
version: '0.10.0'
|
||||
# Description
|
||||
|
|
|
|||
Loading…
Reference in New Issue