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

[7.1] [DOCS] Improvements to the upgrade docs (#48126) #48155

Merged
merged 1 commit into from
Oct 14, 2019
Merged

[7.1] [DOCS] Improvements to the upgrade docs (#48126) #48155

Changes from all commits
Commits
Show all changes
1 commit
Select commit
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
76 changes: 40 additions & 36 deletions docs/setup/upgrade.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,59 +1,63 @@
[[upgrade]]
== Upgrading {kib}

Depending on the {kib} version you're upgrading from, the upgrade process to 7.0
varies.

[IMPORTANT]
===========================================
Before upgrading {kib}:
[float]
[[upgrade-before-you-begin]]
=== Before you begin

* Consult the <<breaking-changes,breaking changes>> docs.
* Test upgrades in a dev environment before upgrading your production servers.
* Backup your data using the {es} {ref}/modules-snapshots.html[snapshots] feature.
You **cannot roll back** to an earlier version unless you have a backup of
your data.
* If you are using custom plugins, check that a compatible version is
available.
===========================================
Before you upgrade {kib}:

Depending on which version of {kib} you're upgrading from, the upgrade process to 7.0
will vary.
* Consult the <<breaking-changes,breaking changes>>.
* Before you upgrade production servers, test the upgrades in a dev environment.
* Backup your data with {es} {ref}/modules-snapshots.html[snapshots].
To roll back to an earlier version, you **must** have a backup of your data.
* If you are using custom plugins, check that a compatible version is
available.
* Shut down all {kib} nodes. Running more than one {kib} version against the
same Elasticseach index is unsupported. If you upgrade while older {kib} nodes are
running, the upgrade can fail.

The recommended path is to upgrade to 6.7 before upgrading to 7.0.
This makes it easier to identify the changes you need to make to upgrade and enables
you to perform a rolling upgrade with no downtime.
To identify the changes you need to make to upgrade, and to enable you to
perform an Elasticsearch rolling upgrade with no downtime, you must upgrade to
6.7 before you upgrade to 7.0.

Please see
*{stack-ref}/upgrading-elastic-stack.html[Upgrading the Elastic Stack]* for a
comprehensive overview of the upgrade process.
For a comprehensive overview of the upgrade process, refer to
*{stack-ref}/upgrading-elastic-stack.html[Upgrading the Elastic Stack]*.


[float]
==== Upgrading from 5.x or earlier
{es} can read indices created in the previous major version. If you have indices
created in 5.x or before, you must reindex or delete them before upgrading to 7.0.0.
See {stack-ref}/upgrading-elastic-stack.html#oss-stack-upgrade[Upgrading the Elastic Stack]
for more information.

Once your reindex is complete, you can follow the <<upgrade-standard, Standard upgrade>>
[[upgrade-5x-earlier]]
=== Upgrading from 5.x or earlier
{es} can read indices created in the previous major version. Before you upgrade
to 7.0.0, you must reindex or delete any indices created in 5.x or earlier.
For more information, refer to
{stack-ref}/upgrading-elastic-stack.html#oss-stack-upgrade[Upgrading the Elastic Stack].

When your reindex is complete, follow the <<upgrade-standard, Standard upgrade>>
instructions.

[float]
==== Upgrading from 6.x
[[upgrade-6x]]
=== Upgrading from 6.x

The recommended path is to upgrade to 6.7 before upgrading to 7.0. This makes it
easier to identify the required changes, and enables you to use the Upgrade Assistant
to prepare for your upgrade to 7.0 (see below).
easier to identify the required changes, and enables you to use the Upgrade
Assistant to prepare for your upgrade to 7.0.

*Note:* Saved searches, visualizations, and dashboards created in {kib} 6.x
can be generally imported into 7.x.
TIP: The ability to import {kib} 6.x saved searches, visualizations, and
dashboards is supported.

[float]
==== Upgrading from 6.7
6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
to help you prepare for your upgrade to 7.0. To access the assistant, go to *Management > 7.0 Upgrade Assistant*.
[[upgrade-67]]
=== Upgrading from 6.7
To help you prepare for your upgrade to 7.0, 6.7 includes an https://www.elastic.co/guide/en/kibana/6.7/upgrade-assistant.html[Upgrade Assistant]
To access the assistant, go to *Management > 7.0 Upgrade Assistant*.

After you have addressed any issues that were identified by the Upgrade Assistant,
<<upgrade-standard,upgrade to 7.0>>.
After you have addressed any issues that were identified by the Upgrade
Assistant, <<upgrade-standard,upgrade to 7.0>>.

[float]
=== Known issues
Expand Down