From 605e0d8bbb8a79362e44a82e0a1fc144760ef934 Mon Sep 17 00:00:00 2001 From: Olena Logvinova Date: Fri, 22 Jul 2016 15:03:50 +0300 Subject: [PATCH] [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 --- doc/source/advanced_operations.rst | 22 +++++----- doc/source/configure.rst | 6 ++- doc/source/deploy_with_network_templates.rst | 4 +- doc/source/install.rst | 5 +-- doc/source/licenses.rst | 44 ++++++++++---------- doc/source/limitations.rst | 2 +- doc/source/troubleshooting.rst | 5 +-- doc/source/user.rst | 8 ++-- doc/source/verify.rst | 15 +++---- 9 files changed, 57 insertions(+), 54 deletions(-) diff --git a/doc/source/advanced_operations.rst b/doc/source/advanced_operations.rst index 6e5ff30..de4e015 100644 --- a/doc/source/advanced_operations.rst +++ b/doc/source/advanced_operations.rst @@ -24,7 +24,7 @@ The plugin uses three types of indices: installation to store the templates of the Kibana dashboards. 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 the replication factor of other two indices that you should manually 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 should remain the same. -Scaling Up +Scaling up ~~~~~~~~~~ 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 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. 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 -February, so the indices created after that date (*log-2016.02.04* in this -example) are automatically updated with the correct number of replicas -(number of cluster nodes - 1). +before the scale-up is zero. In this example, a scale-up was performed on the +3rd of February. Therefore, the indices created after that date +(*log-2016.02.04* in this example) are automatically updated with the correct +number of replicas (number of cluster nodes - 1). .. 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 .... 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 @@ -78,9 +78,9 @@ If you want the *log-2016.02.03* index to be replicated, update the Scaling down ~~~~~~~~~~~~ -Similarly, after a scale-down the *number_of_replicas* of all indices must be -aligned with the new size of the cluster. Not doing so will be reported by LMA -as a critical status for the Elasticsearch cluster: +After a scale-down, align the *number_of_replicas* of all indices with the +new size of the cluster. Otherwise, StackLight reports a critical status of +the Elasticsearch cluster: .. code-block:: console diff --git a/doc/source/configure.rst b/doc/source/configure.rst index ef7776b..38827d6 100644 --- a/doc/source/configure.rst +++ b/doc/source/configure.rst @@ -7,7 +7,7 @@ To configure the StackLight Elasticsearch-Kibana plugin during an environment deployment: #. Using the Fuel web UI, - `Create a new environment `_. + `create a new environment `_. #. In the Fuel web UI, click the :guilabel:`Settings` tab and select the :guilabel:`Other` category. @@ -136,3 +136,7 @@ deployment: 10. `Deploy your environment `_. + +.. raw:: latex + + \pagebreak diff --git a/doc/source/deploy_with_network_templates.rst b/doc/source/deploy_with_network_templates.rst index 7c059ed..ae47ac6 100644 --- a/doc/source/deploy_with_network_templates.rst +++ b/doc/source/deploy_with_network_templates.rst @@ -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 requirements, you can leverage the Fuel `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. Below is a networking template example to define a new network named @@ -36,7 +36,7 @@ and adapt it to your requirements. :width: 800 :align: center -#. Proceed to :ref:`Configure the plugin during an environment deployment `. +#. Proceed to :ref:`configure the plugin `. For details on networking templates, see `Mirantis Operations Guide `_. diff --git a/doc/source/install.rst b/doc/source/install.rst index 3aa5294..b8227bc 100644 --- a/doc/source/install.rst +++ b/doc/source/install.rst @@ -32,7 +32,7 @@ To install the StackLight Elasticsearch-Kibana Fuel plugin using the RPM file from the Fuel plugins' catalog: #. Go to the - `Fuel plugins' Catalog `_. + `Fuel plugins' catalog `_. #. From the :guilabel:`Filter` drop-down menu, select the Mirantis OpenStack 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 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 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 by the Fuel Plugin Builder you get from ``pypi``. For instructions on how to build the Fuel Plugin Builder, see the - *Install Fuel Plugin Builder* section of the `Fuel Plugin SDK Guide `_. #. Clone the plugin repository: diff --git a/doc/source/licenses.rst b/doc/source/licenses.rst index 3870c3c..932c0f6 100644 --- a/doc/source/licenses.rst +++ b/doc/source/licenses.rst @@ -6,29 +6,29 @@ Licenses Third-party components ---------------------- -+------------------------+-------------------------------------------------------------+------------+ -| Name | Project Web Site | License | -+========================+=============================================================+============+ -| Elasticsearch | https://www.elastic.co/products/elasticsearch | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ -| Kibana | https://www.elastic.co/products/kibana | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ ++--------------+----------------------------------------------+------------+ +| Name | Project web site | License | ++==============+==============================================+============+ +| Elasticsearch| https://www.elastic.co/products/elasticsearch| Apache v2 | ++--------------+----------------------------------------------+------------+ +| Kibana | https://www.elastic.co/products/kibana | Apache v2 | ++--------------+----------------------------------------------+------------+ Puppet modules -------------- -+------------------------+-------------------------------------------------------------+------------+ -| Name | Project Web Site | License | -+========================+=============================================================+============+ -| Elasticsearch | https://forge.puppetlabs.com/elasticsearch/elasticsearch | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ -| Concat | https://github.com/puppetlabs/puppetlabs-concat | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ -| Stdlib | https://github.com/puppetlabs/puppetlabs-stdlib | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ -| Apache | https://github.com/puppetlabs/puppetlabs-apache | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ -| Firewall | https://github.com/puppetlabs/puppetlabs-firewall | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ -| Datacat | https://github.com/richardc/puppet-datacat | Apache v2 | -+------------------------+-------------------------------------------------------------+------------+ ++-------------+--------------------------------------------------------+---------+ +|Name |Project web site |License | ++=============+========================================================+=========+ +|Elasticsearch|https://forge.puppetlabs.com/elasticsearch/elasticsearch|Apache v2| ++-------------+--------------------------------------------------------+---------+ +|Concat |https://github.com/puppetlabs/puppetlabs-concat |Apache v2| ++-------------+--------------------------------------------------------+---------+ +|Stdlib |https://github.com/puppetlabs/puppetlabs-stdlib |Apache v2| ++-------------+--------------------------------------------------------+---------+ +|Apache |https://github.com/puppetlabs/puppetlabs-apache |Apache v2| ++-------------+--------------------------------------------------------+---------+ +|Firewall |https://github.com/puppetlabs/puppetlabs-firewall |Apache v2| ++-------------+--------------------------------------------------------+---------+ +|Datacat |https://github.com/richardc/puppet-datacat |Apache v2| ++-------------+--------------------------------------------------------+---------+ diff --git a/doc/source/limitations.rst b/doc/source/limitations.rst index 8d94a4c..2953b68 100644 --- a/doc/source/limitations.rst +++ b/doc/source/limitations.rst @@ -9,7 +9,7 @@ limitations: * 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 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. * The :ref:`cluster operations ` may require manual diff --git a/doc/source/troubleshooting.rst b/doc/source/troubleshooting.rst index cf00109..2bb3e24 100644 --- a/doc/source/troubleshooting.rst +++ b/doc/source/troubleshooting.rst @@ -37,7 +37,7 @@ use the following troubleshooting tips: [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 @@ -49,7 +49,7 @@ use the following troubleshooting tips: [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 @@ -63,4 +63,3 @@ use the following troubleshooting tips: .. raw:: latex \pagebreak - diff --git a/doc/source/user.rst b/doc/source/user.rst index 9fbd198..7721daf 100644 --- a/doc/source/user.rst +++ b/doc/source/user.rst @@ -8,9 +8,9 @@ Dashboards management 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. - * 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 Collector settings. @@ -61,7 +61,7 @@ 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 filters are used to restrict what is displayed in the Dashboard. * The queries are used for free-text search. 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. Filters and queries can also use wildcards that can be combined with the -*field names* like in ``programname: *`` +*field names* like in ``programname: *``. For example, to display only the Nova logs, enter ``programname:nova*`` in the query text box as shown below: diff --git a/doc/source/verify.rst b/doc/source/verify.rst index e91fb18..f15316f 100644 --- a/doc/source/verify.rst +++ b/doc/source/verify.rst @@ -13,11 +13,12 @@ in the picture below: :align: center :width: 800 -.. note:: For technical reasons, it was necessary to create two different ports - to enforce the access authorization to Kibana: +.. note:: + Two different ports are created to enforce the access authorization + to Kibana: - * One port (80) for users with the *admin role* - * One port (81) for users with the *viewer role*. + * One port (80) for users with the *admin role* + * One port (81) for users with the *viewer role*. If Kibana is installed on the *management network*, you may not have 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 -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 - server is installed using the :command:`fuel nodes` command. For example: +#. On the Fuel Master node, find the IP address of a node where the + Elasticsearch server is installed using the :command:`fuel nodes` command: .. code-block:: console