From 32ed1ceb4daa4e82e70be738969360cfb95c61be Mon Sep 17 00:00:00 2001 From: LeeDr Date: Fri, 22 Jul 2016 13:25:11 -0500 Subject: [PATCH 1/5] Added 'Upgrading Kibana' section --- docs/setup.asciidoc | 35 +++++++++++++++++++++++++++++------ 1 file changed, 29 insertions(+), 6 deletions(-) diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index 9504aee0ba058..b06f8ece6cbeb 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -1,10 +1,10 @@ [[setup]] -== Getting Kibana Up and Running +== Installing Kibana You can set up Kibana and start exploring your Elasticsearch indices in minutes. All you need is: * Elasticsearch {esversion} -* A modern web browser - http://www.elastic.co/subscriptions/matrix#matrix_browsers[Supported Browsers]. +* A modern web browser - https://www.elastic.co/support/matrix#show_browsers[Supported Browsers]. * Information about your Elasticsearch installation: ** URL of the Elasticsearch instance you want to connect to. ** Which Elasticsearch indices you want to search. @@ -12,22 +12,45 @@ All you need is: NOTE: If your Elasticsearch installation is protected by http://www.elastic.co/overview/shield/[{scyld}], see {shield}/kibana.html#using-kibana4-with-shield[{scyld} with Kibana] for additional setup instructions. +=== Upgrading Kibana + +Your existing Kibana version is generally compatible with the next minor version release of Elasticsearch. +This means you should upgrade your Elasticsearch cluster(s) before or at the same time as Kibana. +We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and Kibana must be upgraded together. + +. https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] existing `.kibana` index in Elasticsearch +. save a backup copy of the existing `config/kibana.yml` +. take note of the Kibana plugins that are installed; +.. `/opt/kibana/bin/kibana plugin --list` on 4.x versions of Kibana. +.. `/usr/share/kibana/bin/kibana-plugin --list` on 5.x versions of Kibana. +. For Kibana installations using an extracted **archive file**; +.. extract the new version of Kibana into a different directory. See steps below. +.. migrate any custom configuration from your old kibana.yml to your new one +.. follow other steps below to complete the new installation +.. once the new version is fully configured and working with required plugins, remove the previous version of Kibana +. For Kibana installations using a Linux **package manager**; +.. uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` +.. 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.) + + [float] [[install]] -=== Install and Start Kibana +=== Install and Start Kibana from archive file To get Kibana up and running: . Download the https://www.elastic.co/downloads/kibana[Kibana {version} binary package] for your platform. . Extract the `.zip` or `tar.gz` archive file. -. After installing, run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows). +. If upgrading, copy configuration changes from the previous kibana.yml to the new version. +. Optionally install Kibana plugins. +. Run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows). On Unix, you can instead run the package manager suited for your distribution. -//// + [float] include::kibana-repositories.asciidoc[] -//// + That's it! Kibana is now running on port 5601. From 50d540df4c80ad4a069f4477df296c9015550d75 Mon Sep 17 00:00:00 2001 From: LeeDr Date: Mon, 25 Jul 2016 10:52:16 -0500 Subject: [PATCH 2/5] Updated from review comments, re-commented-out repository part for master --- docs/kibana-repositories.asciidoc | 2 +- docs/setup.asciidoc | 34 +++++++++++++++---------------- 2 files changed, 18 insertions(+), 18 deletions(-) diff --git a/docs/kibana-repositories.asciidoc b/docs/kibana-repositories.asciidoc index 8f2ee31bda0f3..0587adb69ee17 100644 --- a/docs/kibana-repositories.asciidoc +++ b/docs/kibana-repositories.asciidoc @@ -1,5 +1,5 @@ [[setup-repositories]] -=== Kibana Repositories +=== Install Kibana using a Linux Package Manager Binary packages for Kibana are available for Unix distributions that support the `apt` and `yum` tools. We also have repositories available for APT and YUM based distributions. diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index b06f8ece6cbeb..f49da6c80d139 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -18,39 +18,39 @@ Your existing Kibana version is generally compatible with the next minor version This means you should upgrade your Elasticsearch cluster(s) before or at the same time as Kibana. We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and Kibana must be upgraded together. -. https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] existing `.kibana` index in Elasticsearch -. save a backup copy of the existing `config/kibana.yml` -. take note of the Kibana plugins that are installed; -.. `/opt/kibana/bin/kibana plugin --list` on 4.x versions of Kibana. -.. `/usr/share/kibana/bin/kibana-plugin --list` on 5.x versions of Kibana. -. For Kibana installations using an extracted **archive file**; -.. extract the new version of Kibana into a different directory. See steps below. -.. migrate any custom configuration from your old kibana.yml to your new one -.. follow other steps below to complete the new installation -.. once the new version is fully configured and working with required plugins, remove the previous version of Kibana -. For Kibana installations using a Linux **package manager**; -.. uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` -.. 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.) +. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing .kibana index. +. Back up the `kibana.yml` configuration file. +. Take note of the Kibana plugins that are installed; +.. `bin/kibana plugin --list` on 4.x versions of Kibana. +.. `bin/kibana-plugin list` on 5.x versions of Kibana. +. To upgrade from an Archive File: +.. Extract the new version of Kibana into a different directory. See steps below. +.. Migrate any custom configuration from your old kibana.yml to your new one +.. Follow other steps below to complete the new installation +.. Once the new version is fully configured and working with required plugins, remove the previous version of Kibana +. To upgrade using a Linux Package Manager: +.. Uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` +.. 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.) [float] [[install]] -=== Install and Start Kibana from archive file +=== Install and Start Kibana from Archive File To get Kibana up and running: . Download the https://www.elastic.co/downloads/kibana[Kibana {version} binary package] for your platform. . Extract the `.zip` or `tar.gz` archive file. . If upgrading, copy configuration changes from the previous kibana.yml to the new version. -. Optionally install Kibana plugins. +. Install Kibana plugins (optional). . Run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows). On Unix, you can instead run the package manager suited for your distribution. - +//// [float] include::kibana-repositories.asciidoc[] - +//// That's it! Kibana is now running on port 5601. From ee42c473a926553849661ae421cc7140cceba1a3 Mon Sep 17 00:00:00 2001 From: Lee Drengenberg Date: Thu, 28 Jul 2016 16:44:16 -0500 Subject: [PATCH 3/5] Change some indented numbered items to bullets --- docs/setup.asciidoc | 16 ++++++++-------- 1 file changed, 8 insertions(+), 8 deletions(-) diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index f49da6c80d139..01378f766aa14 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -21,16 +21,16 @@ We cannot guarantee compatibility between major version releases so in those cas . Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing .kibana index. . Back up the `kibana.yml` configuration file. . Take note of the Kibana plugins that are installed; -.. `bin/kibana plugin --list` on 4.x versions of Kibana. -.. `bin/kibana-plugin list` on 5.x versions of Kibana. + * `bin/kibana plugin --list` on 4.x versions of Kibana. + * `bin/kibana-plugin list` on 5.x versions of Kibana. . To upgrade from an Archive File: -.. Extract the new version of Kibana into a different directory. See steps below. -.. Migrate any custom configuration from your old kibana.yml to your new one -.. Follow other steps below to complete the new installation -.. Once the new version is fully configured and working with required plugins, remove the previous version of Kibana + * Extract the new version of Kibana into a different directory. See steps below. + * Migrate any custom configuration from your old kibana.yml to your new one + * Follow other steps below to complete the new installation + * Once the new version is fully configured and working with required plugins, remove the previous version of Kibana . To upgrade using a Linux Package Manager: -.. Uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` -.. 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.) + * Uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` + * 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.) [float] From 9ccf1df7842a519154b9ebdb139ed90fccf63f7a Mon Sep 17 00:00:00 2001 From: Lee Drengenberg Date: Fri, 29 Jul 2016 08:40:39 -0500 Subject: [PATCH 4/5] Update setup.asciidoc --- docs/setup.asciidoc | 8 ++++---- 1 file changed, 4 insertions(+), 4 deletions(-) diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index 01378f766aa14..88db5a558aeee 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -18,9 +18,9 @@ Your existing Kibana version is generally compatible with the next minor version This means you should upgrade your Elasticsearch cluster(s) before or at the same time as Kibana. We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and Kibana must be upgraded together. -. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing .kibana index. +. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing `.kibana` index. . Back up the `kibana.yml` configuration file. -. Take note of the Kibana plugins that are installed; +. Take note of the Kibana plugins that are installed: * `bin/kibana plugin --list` on 4.x versions of Kibana. * `bin/kibana-plugin list` on 5.x versions of Kibana. . To upgrade from an Archive File: @@ -30,12 +30,12 @@ We cannot guarantee compatibility between major version releases so in those cas * Once the new version is fully configured and working with required plugins, remove the previous version of Kibana . To upgrade using a Linux Package Manager: * Uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` - * 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.) + * Install the new Kibana package. There have been some installer issues between various version of Kibana so the uninstall and install process is safer than an upgrade. [float] [[install]] -=== Install and Start Kibana from Archive File +=== Install and Start Kibana from an Archive File To get Kibana up and running: From 48371a432d185f7f44f7e962810dac518d7a9130 Mon Sep 17 00:00:00 2001 From: Lee Drengenberg Date: Wed, 3 Aug 2016 11:27:32 -0500 Subject: [PATCH 5/5] Update setup.asciidoc --- docs/setup.asciidoc | 16 +++++++++------- 1 file changed, 9 insertions(+), 7 deletions(-) diff --git a/docs/setup.asciidoc b/docs/setup.asciidoc index 88db5a558aeee..547f5b8729b31 100644 --- a/docs/setup.asciidoc +++ b/docs/setup.asciidoc @@ -18,19 +18,21 @@ Your existing Kibana version is generally compatible with the next minor version This means you should upgrade your Elasticsearch cluster(s) before or at the same time as Kibana. We cannot guarantee compatibility between major version releases so in those cases both Elasticsearch and Kibana must be upgraded together. +To upgrade Kibana: + . Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing `.kibana` index. . Back up the `kibana.yml` configuration file. . Take note of the Kibana plugins that are installed: * `bin/kibana plugin --list` on 4.x versions of Kibana. * `bin/kibana-plugin list` on 5.x versions of Kibana. . To upgrade from an Archive File: - * Extract the new version of Kibana into a different directory. See steps below. - * Migrate any custom configuration from your old kibana.yml to your new one - * Follow other steps below to complete the new installation - * Once the new version is fully configured and working with required plugins, remove the previous version of Kibana +.. Extract the new version of Kibana into a different directory. See steps below. +.. Migrate any custom configuration from your old kibana.yml to your new one +.. Follow other steps below to complete the new installation. +.. Once the new version is fully configured and working with required plugins, remove the previous version of Kibana . To upgrade using a Linux Package Manager: - * Uninstall the existing Kibana package `apt-get remove kibana` or `yum remove kibana` - * Install the new Kibana package. There have been some installer issues between various version of Kibana so the uninstall and install process is safer than an upgrade. +.. Uninstall the existing Kibana package: `apt-get remove kibana` or `yum remove kibana` +.. Install the new Kibana package. There have been some installer issues between various version of Kibana so the uninstall and install process is safer than an upgrade. [float] @@ -41,7 +43,7 @@ To get Kibana up and running: . Download the https://www.elastic.co/downloads/kibana[Kibana {version} binary package] for your platform. . Extract the `.zip` or `tar.gz` archive file. -. If upgrading, copy configuration changes from the previous kibana.yml to the new version. +. If you're upgrading, migrate any configuration changes from the previous `kibana.yml` to the new version. . Install Kibana plugins (optional). . Run Kibana from the install directory: `bin/kibana` (Linux/MacOSX) or `bin\kibana.bat` (Windows).