summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorOlena Logvinova <ologvinova@mirantis.com>2016-07-22 15:03:50 +0300
committerOlena Logvinova <ologvinova@mirantis.com>2016-07-22 15:03:50 +0300
commit605e0d8bbb8a79362e44a82e0a1fc144760ef934 (patch)
treef57874f135a43afe051df631594f9d09e0789d16
parentdc4b768a483b0df9c7afac84653c2f15889548fb (diff)
[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
Notes
Notes (review): Code-Review+2: Patrick Petit <ppetit@mirantis.com> Workflow+1: Patrick Petit <ppetit@mirantis.com> Verified+2: Jenkins Submitted-by: Jenkins Submitted-at: Fri, 22 Jul 2016 13:45:39 +0000 Reviewed-on: https://review.openstack.org/345996 Project: openstack/fuel-plugin-elasticsearch-kibana Branch: refs/heads/master
-rw-r--r--doc/source/advanced_operations.rst22
-rw-r--r--doc/source/configure.rst6
-rw-r--r--doc/source/deploy_with_network_templates.rst4
-rw-r--r--doc/source/install.rst5
-rw-r--r--doc/source/licenses.rst44
-rw-r--r--doc/source/limitations.rst2
-rw-r--r--doc/source/troubleshooting.rst5
-rw-r--r--doc/source/user.rst8
-rw-r--r--doc/source/verify.rst15
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:
24 installation to store the templates of the Kibana dashboards. 24 installation to store the templates of the Kibana dashboards.
25 25
26Adjusting the replication factor for the *kibana-int* index is performed 26Adjusting the replication factor for the *kibana-int* index is performed
27automatically by the plugin. Therefore, no manual operation is not required 27automatically by the plugin. Therefore, no manual operation is required
28for this index when the cluster is scaled up or down. But this is not the case 28for this index when the cluster is scaled up or down. But this is not the case
29for the replication factor of other two indices that you should manually 29for the replication factor of other two indices that you should manually
30update as described in the 30update as described in the
@@ -36,20 +36,20 @@ down from three nodes to one node are used as examples. Your mileage may vary,
36but the principal of (re)configuring the replication factor of the indices 36but the principal of (re)configuring the replication factor of the indices
37should remain the same. 37should remain the same.
38 38
39Scaling Up 39Scaling up
40~~~~~~~~~~ 40~~~~~~~~~~
41 41
42The problem that the manual operation aims to address is that the replication 42The problem that the manual operation aims to address is that the replication
43factor for the old indices is not updated automatically by the plugin when 43factor for the old indices is not updated automatically by the plugin when
44a new node is added in the cluster. If you want the old indices to be 44a new node is added in the cluster. If you want the old indices to be
45replicated on the new node(s), you need to adjust the *number_of_replicas* 45replicated on the new node(s), adjust the *number_of_replicas*
46parameter to the current size of the cluster for those indices as shown below. 46parameter to the current size of the cluster for those indices as shown below.
47 47
48The output below shows that the replication factor of the indices created 48The output below shows that the replication factor of the indices created
49before the scale-up is zero. Here, a scale-up was performed on the 3rd of 49before the scale-up is zero. In this example, a scale-up was performed on the
50February, so the indices created after that date (*log-2016.02.04* in this 503rd of February. Therefore, the indices created after that date
51example) are automatically updated with the correct number of replicas 51(*log-2016.02.04* in this example) are automatically updated with the correct
52(number of cluster nodes - 1). 52number of replicas (number of cluster nodes - 1).
53 53
54.. code-block:: console 54.. code-block:: console
55 55
@@ -59,7 +59,7 @@ example) are automatically updated with the correct number of replicas
59 green open log-2016.02.04 5 2 1934581 0 .... 59 green open log-2016.02.04 5 2 1934581 0 ....
60 60
61If you want the *log-2016.02.03* index to be replicated, update the 61If you want the *log-2016.02.03* index to be replicated, update the
62*number_of_replicas* parameter of that index as shown below: 62*number_of_replicas* parameter of that index:
63 63
64.. code-block:: console 64.. code-block:: console
65 65
@@ -78,9 +78,9 @@ If you want the *log-2016.02.03* index to be replicated, update the
78Scaling down 78Scaling down
79~~~~~~~~~~~~ 79~~~~~~~~~~~~
80 80
81Similarly, after a scale-down the *number_of_replicas* of all indices must be 81After a scale-down, align the *number_of_replicas* of all indices with the
82aligned with the new size of the cluster. Not doing so will be reported by LMA 82new size of the cluster. Otherwise, StackLight reports a critical status of
83as a critical status for the Elasticsearch cluster: 83the Elasticsearch cluster:
84 84
85.. code-block:: console 85.. code-block:: console
86 86
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
7deployment: 7deployment:
8 8
9#. Using the Fuel web UI, 9#. Using the Fuel web UI,
10 `Create a new environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_. 10 `create a new environment <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/create-environment/start-create-env.html>`_.
11 11
12#. In the Fuel web UI, click the :guilabel:`Settings` tab and select the 12#. In the Fuel web UI, click the :guilabel:`Settings` tab and select the
13 :guilabel:`Other` category. 13 :guilabel:`Other` category.
@@ -136,3 +136,7 @@ deployment:
136 136
13710. `Deploy your environment 13710. `Deploy your environment
138 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_. 138 <http://docs.openstack.org/developer/fuel-docs/userdocs/fuel-user-guide/deploy-environment.html>`_.
139
140.. raw:: latex
141
142 \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
7management network. If this default configuration does not meet your 7management network. If this default configuration does not meet your
8requirements, you can leverage the Fuel 8requirements, you can leverage the Fuel
9`networking templates' <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_ 9`networking templates' <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_
10capability to change that default configuration to use a dedicated network 10capability to change that default configuration and use a dedicated network
11instead. 11instead.
12 12
13Below is a networking template example to define a new network named 13Below is a networking template example to define a new network named
@@ -36,7 +36,7 @@ and adapt it to your requirements.
36 :width: 800 36 :width: 800
37 :align: center 37 :align: center
38 38
39#. Proceed to :ref:`Configure the plugin during an environment deployment <plugin_configuration>`. 39#. Proceed to :ref:`configure the plugin <plugin_configuration>`.
40 40
41For details on networking templates, see 41For details on networking templates, see
42`Mirantis Operations Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_. 42`Mirantis Operations Guide <https://docs.mirantis.com/openstack/fuel/fuel-9.0/operations.html#using-networking-templates>`_.
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
32from the Fuel plugins' catalog: 32from the Fuel plugins' catalog:
33 33
34#. Go to the 34#. Go to the
35 `Fuel plugins' Catalog <https://www.mirantis.com/validated-solution-integrations/fuel-plugins>`_. 35 `Fuel plugins' catalog <https://www.mirantis.com/validated-solution-integrations/fuel-plugins>`_.
36 36
37#. From the :guilabel:`Filter` drop-down menu, select the Mirantis OpenStack 37#. From the :guilabel:`Filter` drop-down menu, select the Mirantis OpenStack
38 version you are using and the :guilabel:`MONITORING` category. 38 version you are using and the :guilabel:`MONITORING` category.
@@ -73,7 +73,7 @@ customize the plugin.
73.. caution:: Running a Fuel plugin that you built from source is at your 73.. caution:: Running a Fuel plugin that you built from source is at your
74 own risk and is not supported. 74 own risk and is not supported.
75 75
76To install the StackLight Elasticsearch-Kibana plugin from source, at first 76Before you install the StackLight Elasticsearch-Kibana plugin from source,
77prepare an environment to build the RPM file. We recommend building the RPM 77prepare an environment to build the RPM file. We recommend building the RPM
78file directly on the Fuel Master node not to copy that file later on. 78file directly on the Fuel Master node not to copy that file later on.
79 79
@@ -101,7 +101,6 @@ file directly on the Fuel Master node not to copy that file later on.
101 package version of the plugin is higher than the package version supported 101 package version of the plugin is higher than the package version supported
102 by the Fuel Plugin Builder you get from ``pypi``. For instructions on how 102 by the Fuel Plugin Builder you get from ``pypi``. For instructions on how
103 to build the Fuel Plugin Builder, see the 103 to build the Fuel Plugin Builder, see the
104 *Install Fuel Plugin Builder* section of the
105 `Fuel Plugin SDK Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-plugin/install-plugin-builder.html>`_. 104 `Fuel Plugin SDK Guide <http://docs.openstack.org/developer/fuel-docs/plugindocs/fuel-plugin-sdk-guide/create-plugin/install-plugin-builder.html>`_.
106 105
107#. Clone the plugin repository: 106#. 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
6Third-party components 6Third-party components
7---------------------- 7----------------------
8 8
9+------------------------+-------------------------------------------------------------+------------+ 9+--------------+----------------------------------------------+------------+
10| Name | Project Web Site | License | 10| Name | Project web site | License |
11+========================+=============================================================+============+ 11+==============+==============================================+============+
12| Elasticsearch | https://www.elastic.co/products/elasticsearch | Apache v2 | 12| Elasticsearch| https://www.elastic.co/products/elasticsearch| Apache v2 |
13+------------------------+-------------------------------------------------------------+------------+ 13+--------------+----------------------------------------------+------------+
14| Kibana | https://www.elastic.co/products/kibana | Apache v2 | 14| Kibana | https://www.elastic.co/products/kibana | Apache v2 |
15+------------------------+-------------------------------------------------------------+------------+ 15+--------------+----------------------------------------------+------------+
16 16
17Puppet modules 17Puppet modules
18-------------- 18--------------
19 19
20+------------------------+-------------------------------------------------------------+------------+ 20+-------------+--------------------------------------------------------+---------+
21| Name | Project Web Site | License | 21|Name |Project web site |License |
22+========================+=============================================================+============+ 22+=============+========================================================+=========+
23| Elasticsearch | https://forge.puppetlabs.com/elasticsearch/elasticsearch | Apache v2 | 23|Elasticsearch|https://forge.puppetlabs.com/elasticsearch/elasticsearch|Apache v2|
24+------------------------+-------------------------------------------------------------+------------+ 24+-------------+--------------------------------------------------------+---------+
25| Concat | https://github.com/puppetlabs/puppetlabs-concat | Apache v2 | 25|Concat |https://github.com/puppetlabs/puppetlabs-concat |Apache v2|
26+------------------------+-------------------------------------------------------------+------------+ 26+-------------+--------------------------------------------------------+---------+
27| Stdlib | https://github.com/puppetlabs/puppetlabs-stdlib | Apache v2 | 27|Stdlib |https://github.com/puppetlabs/puppetlabs-stdlib |Apache v2|
28+------------------------+-------------------------------------------------------------+------------+ 28+-------------+--------------------------------------------------------+---------+
29| Apache | https://github.com/puppetlabs/puppetlabs-apache | Apache v2 | 29|Apache |https://github.com/puppetlabs/puppetlabs-apache |Apache v2|
30+------------------------+-------------------------------------------------------------+------------+ 30+-------------+--------------------------------------------------------+---------+
31| Firewall | https://github.com/puppetlabs/puppetlabs-firewall | Apache v2 | 31|Firewall |https://github.com/puppetlabs/puppetlabs-firewall |Apache v2|
32+------------------------+-------------------------------------------------------------+------------+ 32+-------------+--------------------------------------------------------+---------+
33| Datacat | https://github.com/richardc/puppet-datacat | Apache v2 | 33|Datacat |https://github.com/richardc/puppet-datacat |Apache v2|
34+------------------------+-------------------------------------------------------------+------------+ 34+-------------+--------------------------------------------------------+---------+
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:
9* Currently, the maximum size of an Elasticsearch cluster that can be 9* Currently, the maximum size of an Elasticsearch cluster that can be
10 installed by Fuel is limited to five nodes. But each node of an Elasticsearch 10 installed by Fuel is limited to five nodes. But each node of an Elasticsearch
11 cluster is configured as *master candidate* and a *storage node*. This means 11 cluster is configured as *master candidate* and a *storage node*. This means
12 that each node of the Elasticsearch cluster can be selected as master, and 12 that each node of an Elasticsearch cluster can be selected as master, and
13 all nodes will store data. 13 all nodes will store data.
14 14
15* The :ref:`cluster operations <cluster_operations>` may require manual 15* The :ref:`cluster operations <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:
37 37
38 [root@node-1 ~]# /etc/init.d/elasticsearch-es-01 status 38 [root@node-1 ~]# /etc/init.d/elasticsearch-es-01 status
39 39
40#. If Elasticsearch is down, restart it on both CentOS and Ubuntu: 40 If Elasticsearch is down, restart it on both CentOS and Ubuntu:
41 41
42 .. code-block:: console 42 .. code-block:: console
43 43
@@ -49,7 +49,7 @@ use the following troubleshooting tips:
49 49
50 [root@node-1 ~]# /etc/init.d/apache2 status 50 [root@node-1 ~]# /etc/init.d/apache2 status
51 51
52#. If Apache is down, restart it on both CentOS and Ubuntu: 52 If Apache is down, restart it on both CentOS and Ubuntu:
53 53
54 .. code-block:: console 54 .. code-block:: console
55 55
@@ -63,4 +63,3 @@ use the following troubleshooting tips:
63.. raw:: latex 63.. raw:: latex
64 64
65 \pagebreak 65 \pagebreak
66
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
8 8
9The StackLight Elasticsearch-Kibana plugin contains two built-in dashboards: 9The StackLight Elasticsearch-Kibana plugin contains two built-in dashboards:
10 10
11 * The :guilabel:`Logs` Analytics Dashboard is used to visualize and 11 * The :guilabel:`Logs` Analytics Dashboard that is used to visualize and
12 search the logs. 12 search the logs.
13 * The :guilabel:`Notifications` Analytics Dashboard is used to visualize 13 * The :guilabel:`Notifications` Analytics Dashboard that is used to visualize
14 and search the OpenStack notifications if you enabled the feature in the 14 and search the OpenStack notifications if you enabled the feature in the
15 Collector settings. 15 Collector settings.
16 16
@@ -61,7 +61,7 @@ Filters and queries
61Filters and queries have similar syntax but they are used for different 61Filters and queries have similar syntax but they are used for different
62purposes: 62purposes:
63 63
64* The filters are used to restrict what is displayed in the dashboard. 64* The filters are used to restrict what is displayed in the Dashboard.
65* The queries are used for free-text search. 65* The queries are used for free-text search.
66 66
67You can combine multiple queries and compare their results. 67You 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
86are in the Dashboard. 86are in the Dashboard.
87 87
88Filters and queries can also use wildcards that can be combined with the 88Filters and queries can also use wildcards that can be combined with the
89*field names* like in ``programname: <name>*`` 89*field names* like in ``programname: <name>*``.
90 90
91For example, to display only the Nova logs, enter ``programname:nova*`` in 91For example, to display only the Nova logs, enter ``programname:nova*`` in
92the query text box as shown below: 92the 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:
13 :align: center 13 :align: center
14 :width: 800 14 :width: 800
15 15
16.. note:: For technical reasons, it was necessary to create two different ports 16.. note::
17 to enforce the access authorization to Kibana: 17 Two different ports are created to enforce the access authorization
18 to Kibana:
18 19
19 * One port (80) for users with the *admin role* 20 * One port (80) for users with the *admin role*
20 * One port (81) for users with the *viewer role*. 21 * One port (81) for users with the *viewer role*.
21 22
22 If Kibana is installed on the *management network*, you may not have 23 If Kibana is installed on the *management network*, you may not have
23 direct access to the Kibana web UI. Some extra network configuration may 24 direct access to the Kibana web UI. Some extra network configuration may
@@ -29,10 +30,10 @@ Verifying Elasticsearch
29----------------------- 30-----------------------
30 31
31To verify that the Elasticsearch cluster is running properly, first retrieve 32To verify that the Elasticsearch cluster is running properly, first retrieve
32the Elasticsearch cluster VIP address: 33the Elasticsearch cluster virtual IP address:
33 34
34#. On the Fuel Master node, find the IP address of a node where the Elasticsearch 35#. On the Fuel Master node, find the IP address of a node where the
35 server is installed using the :command:`fuel nodes` command. For example: 36 Elasticsearch server is installed using the :command:`fuel nodes` command:
36 37
37 .. code-block:: console 38 .. code-block:: console
38 39