Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added 'Upgrading Kibana' section to install docs #7807

Merged
merged 5 commits into from
Aug 5, 2016
Merged

Added 'Upgrading Kibana' section to install docs #7807

Show file tree
Hide file tree
Changes from 3 commits
Commits
Show all changes
5 commits
Select commit Hold shift + click to select a range
32ed1ce
Added 'Upgrading Kibana' section
Jul 22, 2016
50d540d
Updated from review comments, re-commented-out repository part for ma…
Jul 25, 2016
ee42c47
Change some indented numbered items to bullets
Jul 28, 2016
9ccf1df
Update setup.asciidoc
Jul 29, 2016
48371a4
Update setup.asciidoc
Aug 3, 2016
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/kibana-repositories.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -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.
Expand Down
31 changes: 27 additions & 4 deletions docs/setup.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,26 +1,49 @@
[[setup]]
== Getting Kibana Up and Running
== Installing Kibana
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Thank you for changing this...it's bugged me ever since the getting started tutorial was added. :-)

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.

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.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add an intro, "To upgrade Kibana:"

. Create a https://www.elastic.co/guide/en/elasticsearch/reference/current/modules-snapshots.html[snapshot] of the existing .kibana index.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We typically use code font for index names, .kibana.

. Back up the `kibana.yml` configuration file.
. Take note of the Kibana plugins that are installed;
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Colon, instead of semicolon. :-)

* `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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd either remove "See steps below" or make it a real cross-reference. (I don't think it's really needed, I'd just take it out.)

Also, I'd put the upgrade instructions after the install instructions.

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Here I actually would use a nested numbered list. It was just the command examples above that don't really have any order to them.

* Migrate any custom configuration from your old kibana.yml to your new one
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

We typically use code font for the config files: kibana.yml

Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Add a period at the end of each step. (General rule is if any list items have ending punctuation, they all should.)

* 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`
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I'd add a colon after package.

* 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.)
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Same as above with the cross ref. I'd also remove the parentheses.



[float]
[[install]]
=== Install and Start Kibana
=== Install and Start Kibana from Archive File
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

"from an 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.
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

kibana.yml

I'd tweak this slightly: "If you're upgrading, copy your old kibana.yml configuration file into the config directory."

. 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.

Expand Down