x
/
fuel-plugin-elasticsearch-kibana
Code Issues Proposed changes

[doc] Final edits in Kibana Guide 

Final PDF build version:
https://drive.google.com/a/mirantis.com/file/d/0B2pEhXPCoNIINlVTNU5kZmU5YUU/view?usp=sharing

Change-Id: Ib8229131d0c511fb2805e8b9a66de87c1a7c150e
This commit is contained in:
Olena Logvinova 2016-07-22 15:03:50 +03:00
parent dc4b768a48
commit 605e0d8bbb
9 changed files with 57 additions and 54 deletions
Show Stats Download Patch File Download Diff File Expand all files Collapse all files

22
doc/source/advanced_operations.rst
View File

@ -24,7 +24,7 @@ The plugin uses three types of indices:
installation to store the templates of the Kibana dashboards. installation to store the templates of the Kibana dashboards.
Adjusting the replication factor for the *kibana-int* index is performed Adjusting the replication factor for the *kibana-int* index is performed
automatically by the plugin. Therefore, no manual operation is not required automatically by the plugin. Therefore, no manual operation is required
for this index when the cluster is scaled up or down. But this is not the case for this index when the cluster is scaled up or down. But this is not the case
for the replication factor of other two indices that you should manually for the replication factor of other two indices that you should manually
update as described in the update as described in the
@ -36,20 +36,20 @@ down from three nodes to one node are used as examples. Your mileage may vary,
but the principal of (re)configuring the replication factor of the indices but the principal of (re)configuring the replication factor of the indices
should remain the same. should remain the same.
Scaling Up Scaling up
~~~~~~~~~~ ~~~~~~~~~~
The problem that the manual operation aims to address is that the replication The problem that the manual operation aims to address is that the replication
factor for the old indices is not updated automatically by the plugin when factor for the old indices is not updated automatically by the plugin when
a new node is added in the cluster. If you want the old indices to be a new node is added in the cluster. If you want the old indices to be
replicated on the new node(s), you need to adjust the *number_of_replicas* replicated on the new node(s), adjust the *number_of_replicas*
parameter to the current size of the cluster for those indices as shown below. parameter to the current size of the cluster for those indices as shown below.
The output below shows that the replication factor of the indices created The output below shows that the replication factor of the indices created
before the scale-up is zero. Here, a scale-up was performed on the 3rd of before the scale-up is zero. In this example, a scale-up was performed on the
February, so the indices created after that date (*log-2016.02.04* in this 3rd of February. Therefore, the indices created after that date
example) are automatically updated with the correct number of replicas (*log-2016.02.04* in this example) are automatically updated with the correct
(number of cluster nodes - 1). number of replicas (number of cluster nodes - 1).
.. code-block:: console .. code-block:: console
@ -59,7 +59,7 @@ example) are automatically updated with the correct number of replicas
green open log-2016.02.04 5 2 1934581 0 .... green open log-2016.02.04 5 2 1934581 0 ....
If you want the *log-2016.02.03* index to be replicated, update the If you want the *log-2016.02.03* index to be replicated, update the
*number_of_replicas* parameter of that index as shown below: *number_of_replicas* parameter of that index:
.. code-block:: console .. code-block:: console
@ -78,9 +78,9 @@ If you want the *log-2016.02.03* index to be replicated, update the
Scaling down Scaling down
~~~~~~~~~~~~ ~~~~~~~~~~~~
Similarly, after a scale-down the *number_of_replicas* of all indices must be After a scale-down, align the *number_of_replicas* of all indices with the
aligned with the new size of the cluster. Not doing so will be reported by LMA new size of the cluster. Otherwise, StackLight reports a critical status of
as a critical status for the Elasticsearch cluster: the Elasticsearch cluster:
.. code-block:: console .. code-block:: console

6
doc/source/configure.rst
View File

@ -7,7 +7,7 @@ To configure the StackLight Elasticsearch-Kibana plugin during an environment
deployment: deployment:
#. Using the Fuel web UI, #. Using the Fuel web UI,
`Create a new environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_. `create a new environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_.
#. In the Fuel web UI, click the :guilabel:`Settings` tab and select the #. In the Fuel web UI, click the :guilabel:`Settings` tab and select the
:guilabel:`Other` category. :guilabel:`Other` category.
@ -136,3 +136,7 @@ deployment:
10. `Deploy your environment 10. `Deploy your environment
<http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_. <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
.. raw:: latex
\pagebreak

4
doc/source/deploy_with_network_templates.rst
View File

@ -7,7 +7,7 @@ By default, the Elasticsearch-Kibana cluster will be deployed on the Fuel
management network. If this default configuration does not meet your management network. If this default configuration does not meet your
requirements, you can leverage the Fuel requirements, you can leverage the Fuel
`networking templates' <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_ `networking templates' <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_
capability to change that default configuration to use a dedicated network capability to change that default configuration and use a dedicated network
instead. instead.
Below is a networking template example to define a new network named Below is a networking template example to define a new network named
@ -36,7 +36,7 @@ and adapt it to your requirements.
:width: 800 :width: 800
:align: center :align: center
#. Proceed to :ref:`Configure the plugin during an environment deployment <plugin_configuration>`. #. Proceed to :ref:`configure the plugin <plugin_configuration>`.
For details on networking templates, see For details on networking templates, see
`Mirantis Operations Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_. `Mirantis Operations Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_.

5
doc/source/install.rst
View File

@ -32,7 +32,7 @@ To install the StackLight Elasticsearch-Kibana Fuel plugin using the RPM file
from the Fuel plugins' catalog: from the Fuel plugins' catalog:
#. Go to the #. Go to the
`Fuel plugins' Catalog <https://www.mirantis.com/validated-solution-integrations/fuel-plugins>`_. `Fuel plugins' catalog <https://www.mirantis.com/validated-solution-integrations/fuel-plugins>`_.
#. From the :guilabel:`Filter` drop-down menu, select the Mirantis OpenStack #. From the :guilabel:`Filter` drop-down menu, select the Mirantis OpenStack
version you are using and the :guilabel:`MONITORING` category. version you are using and the :guilabel:`MONITORING` category.
@ -73,7 +73,7 @@ customize the plugin.
.. caution:: Running a Fuel plugin that you built from source is at your .. caution:: Running a Fuel plugin that you built from source is at your
own risk and is not supported. own risk and is not supported.
To install the StackLight Elasticsearch-Kibana plugin from source, at first Before you install the StackLight Elasticsearch-Kibana plugin from source,
prepare an environment to build the RPM file. We recommend building the RPM prepare an environment to build the RPM file. We recommend building the RPM
file directly on the Fuel Master node not to copy that file later on. file directly on the Fuel Master node not to copy that file later on.
@ -101,7 +101,6 @@ file directly on the Fuel Master node not to copy that file later on.
package version of the plugin is higher than the package version supported package version of the plugin is higher than the package version supported
by the Fuel Plugin Builder you get from ``pypi``. For instructions on how by the Fuel Plugin Builder you get from ``pypi``. For instructions on how
to build the Fuel Plugin Builder, see the to build the Fuel Plugin Builder, see the
*Install Fuel Plugin Builder* section of the
`Fuel Plugin SDK Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-plugin/install-plugin-builder.html>`_. `Fuel Plugin SDK Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-plugin/install-plugin-builder.html>`_.
#. Clone the plugin repository: #. Clone the plugin repository:

44
doc/source/licenses.rst
View File

@ -6,29 +6,29 @@ Licenses
Third-party components Third-party components
---------------------- ----------------------
+------------------------+-------------------------------------------------------------+------------+ +--------------+----------------------------------------------+------------+
| Name | Project Web Site | License | | Name | Project web site | License |
+========================+=============================================================+============+ +==============+==============================================+============+
| Elasticsearch | https://www.elastic.co/products/elasticsearch | Apache v2 | | Elasticsearch| https://www.elastic.co/products/elasticsearch| Apache v2 |
+------------------------+-------------------------------------------------------------+------------+ +--------------+----------------------------------------------+------------+
| Kibana | https://www.elastic.co/products/kibana | Apache v2 | | Kibana | https://www.elastic.co/products/kibana | Apache v2 |
+------------------------+-------------------------------------------------------------+------------+ +--------------+----------------------------------------------+------------+
Puppet modules Puppet modules
-------------- --------------
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+
| Name | Project Web Site | License | |Name |Project web site |License |
+========================+=============================================================+============+ +=============+========================================================+=========+
| Elasticsearch | https://forge.puppetlabs.com/elasticsearch/elasticsearch | Apache v2 | |Elasticsearch|https://forge.puppetlabs.com/elasticsearch/elasticsearch|Apache v2|
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+
| Concat | https://github.com/puppetlabs/puppetlabs-concat | Apache v2 | |Concat |https://github.com/puppetlabs/puppetlabs-concat |Apache v2|
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+
| Stdlib | https://github.com/puppetlabs/puppetlabs-stdlib | Apache v2 | |Stdlib |https://github.com/puppetlabs/puppetlabs-stdlib |Apache v2|
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+
| Apache | https://github.com/puppetlabs/puppetlabs-apache | Apache v2 | |Apache |https://github.com/puppetlabs/puppetlabs-apache |Apache v2|
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+
| Firewall | https://github.com/puppetlabs/puppetlabs-firewall | Apache v2 | |Firewall |https://github.com/puppetlabs/puppetlabs-firewall |Apache v2|
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+
| Datacat | https://github.com/richardc/puppet-datacat | Apache v2 | |Datacat |https://github.com/richardc/puppet-datacat |Apache v2|
+------------------------+-------------------------------------------------------------+------------+ +-------------+--------------------------------------------------------+---------+

2
doc/source/limitations.rst
View File

@ -9,7 +9,7 @@ limitations:
* Currently, the maximum size of an Elasticsearch cluster that can be * Currently, the maximum size of an Elasticsearch cluster that can be
installed by Fuel is limited to five nodes. But each node of an Elasticsearch installed by Fuel is limited to five nodes. But each node of an Elasticsearch
cluster is configured as *master candidate* and a *storage node*. This means cluster is configured as *master candidate* and a *storage node*. This means
that each node of the Elasticsearch cluster can be selected as master, and that each node of an Elasticsearch cluster can be selected as master, and
all nodes will store data. all nodes will store data.
* The :ref:`cluster operations <cluster_operations>` may require manual * The :ref:`cluster operations <cluster_operations>` may require manual

5
doc/source/troubleshooting.rst
View File

@ -37,7 +37,7 @@ use the following troubleshooting tips:
[root@node-1 ~]# /etc/init.d/elasticsearch-es-01 status [root@node-1 ~]# /etc/init.d/elasticsearch-es-01 status
#. If Elasticsearch is down, restart it on both CentOS and Ubuntu: If Elasticsearch is down, restart it on both CentOS and Ubuntu:
.. code-block:: console .. code-block:: console
@ -49,7 +49,7 @@ use the following troubleshooting tips:
[root@node-1 ~]# /etc/init.d/apache2 status [root@node-1 ~]# /etc/init.d/apache2 status
#. If Apache is down, restart it on both CentOS and Ubuntu: If Apache is down, restart it on both CentOS and Ubuntu:
.. code-block:: console .. code-block:: console
@ -63,4 +63,3 @@ use the following troubleshooting tips:
.. raw:: latex .. raw:: latex
\pagebreak \pagebreak

8
doc/source/user.rst
View File

@ -8,9 +8,9 @@ Dashboards management
The StackLight Elasticsearch-Kibana plugin contains two built-in dashboards: The StackLight Elasticsearch-Kibana plugin contains two built-in dashboards:
* The :guilabel:`Logs` Analytics Dashboard is used to visualize and * The :guilabel:`Logs` Analytics Dashboard that is used to visualize and
search the logs. search the logs.
* The :guilabel:`Notifications` Analytics Dashboard is used to visualize * The :guilabel:`Notifications` Analytics Dashboard that is used to visualize
and search the OpenStack notifications if you enabled the feature in the and search the OpenStack notifications if you enabled the feature in the
Collector settings. Collector settings.
@ -61,7 +61,7 @@ Filters and queries
Filters and queries have similar syntax but they are used for different Filters and queries have similar syntax but they are used for different
purposes: purposes:
* The filters are used to restrict what is displayed in the dashboard. * The filters are used to restrict what is displayed in the Dashboard.
* The queries are used for free-text search. * The queries are used for free-text search.
You can combine multiple queries and compare their results. You can combine multiple queries and compare their results.
@ -86,7 +86,7 @@ Filtering works for any field that has been indexed for the log entries that
are in the Dashboard. are in the Dashboard.
Filters and queries can also use wildcards that can be combined with the Filters and queries can also use wildcards that can be combined with the
*field names* like in ``programname: <name>*`` *field names* like in ``programname: <name>*``.
For example, to display only the Nova logs, enter ``programname:nova*`` in For example, to display only the Nova logs, enter ``programname:nova*`` in
the query text box as shown below: the query text box as shown below:

15
doc/source/verify.rst
View File

@ -13,11 +13,12 @@ in the picture below:
:align: center :align: center
:width: 800 :width: 800
.. note:: For technical reasons, it was necessary to create two different ports .. note::
to enforce the access authorization to Kibana: Two different ports are created to enforce the access authorization
to Kibana:
* One port (80) for users with the *admin role* * One port (80) for users with the *admin role*
* One port (81) for users with the *viewer role*. * One port (81) for users with the *viewer role*.
If Kibana is installed on the *management network*, you may not have If Kibana is installed on the *management network*, you may not have
direct access to the Kibana web UI. Some extra network configuration may direct access to the Kibana web UI. Some extra network configuration may
@ -29,10 +30,10 @@ Verifying Elasticsearch
----------------------- -----------------------
To verify that the Elasticsearch cluster is running properly, first retrieve To verify that the Elasticsearch cluster is running properly, first retrieve
the Elasticsearch cluster VIP address: the Elasticsearch cluster virtual IP address:
#. On the Fuel Master node, find the IP address of a node where the Elasticsearch #. On the Fuel Master node, find the IP address of a node where the
server is installed using the :command:`fuel nodes` command. For example: Elasticsearch server is installed using the :command:`fuel nodes` command:
.. code-block:: console .. code-block:: console