Skip to content

Commit 32ed1ce

Browse files
author
LeeDr
committed
Added 'Upgrading Kibana' section
1 parent ebb9cd2 commit 32ed1ce

1 file changed

Lines changed: 29 additions & 6 deletions

File tree

docs/setup.asciidoc

Lines changed: 29 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,33 +1,56 @@
11
[[setup]]
2-
== Getting Kibana Up and Running
2+
== Installing Kibana
33
You can set up Kibana and start exploring your Elasticsearch indices in minutes.
44
All you need is:
55

66
* Elasticsearch {esversion}
7-
* A modern web browser - http://www.elastic.co/subscriptions/matrix#matrix_browsers[Supported Browsers].
7+
* A modern web browser - https://www.elastic.co/support/matrix#show_browsers[Supported Browsers].
88
* Information about your Elasticsearch installation:
99
** URL of the Elasticsearch instance you want to connect to.
1010
** Which Elasticsearch indices you want to search.
1111

1212
NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[{scyld}], see
1313
{shield}/kibana.html#using-kibana4-with-shield[{scyld} with Kibana] for additional setup instructions.
1414

15+
=== Upgrading Kibana
16+
17+
Your existing Kibana version is generally compatible with the next minor version release of Elasticsearch.
18+
This means you should upgrade your Elasticsearch cluster(s) before or at the same time as Kibana.
19+
We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and Kibana must be upgraded together.
20+
21+
. https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] existing `.kibana` index in Elasticsearch
22+
. save a backup copy of the existing `config/kibana.yml`
23+
. take note of the Kibana plugins that are installed;
24+
.. `/opt/kibana/bin/kibana plugin --list` on 4.x versions of Kibana.
25+
.. `/usr/share/kibana/bin/kibana-plugin --list` on 5.x versions of Kibana.
26+
. For Kibana installations using an extracted **archive file**;
27+
.. extract the new version of Kibana into a different directory. See steps below.
28+
.. migrate any custom configuration from your old kibana.yml to your new one
29+
.. follow other steps below to complete the new installation
30+
.. once the new version is fully configured and working with required plugins, remove the previous version of Kibana
31+
. For Kibana installations using a Linux **package manager**;
32+
.. uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana`
33+
.. install the new Kibana package. See steps below. (There have been some installer issues between various version of Kibana so the uninstall and install process is safer than an upgrade.)
34+
35+
1536
[float]
1637
[[install]]
17-
=== Install and Start Kibana
38+
=== Install and Start Kibana from archive file
1839

1940
To get Kibana up and running:
2041

2142
. Download the https://www.elastic.co/downloads/kibana[Kibana {version} binary package] for your platform.
2243
. Extract the `.zip` or `tar.gz` archive file.
23-
. After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).
44+
. If upgrading, copy configuration changes from the previous kibana.yml to the new version.
45+
. Optionally install Kibana plugins.
46+
. Run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).
2447

2548
On Unix, you can instead run the package manager suited for your distribution.
2649

27-
////
50+
2851
[float]
2952
include::kibana-repositories.asciidoc[]
30-
////
53+
3154

3255
That's it! Kibana is now running on port 5601.
3356

0 commit comments

Comments
 (0)