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

Jump to bottom

Update stack upgrade docs re upgrade assistant #24

Merged
merged 1 commit into from
Sep 27, 2017
Merged

Update stack upgrade docs re upgrade assistant #24

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
30 changes: 22 additions & 8 deletions docs/upgrading-stack.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -42,8 +42,10 @@ IMPORTANT: If you're upgrading from 2.x, make sure you
check the breaking changes from 2.x to 5.x, as well as from 5.x to 6.x!
--

. {ref}/docs-reindex.html[Reindex] or delete all 2.x indices. We recommend
upgrading to 5.6 and using the {xpack} Reindex Helper to reindex 2.x indices.
. We recommend upgrading to 5.6 and using the
{xpack-ref}/xpack-upgrade-assistant.html[Upgrade Assistant]'s Reindex Helper to
reindex 2.x indices. Alternatively, you can manually {ref}/docs-reindex.html[reindex]
or delete all 2.x indices.
Copy link
Author

Choose a reason for hiding this comment

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

My reasoning here is that we really should be pushing our Upg Asst tool. Using the reindex API to manually upgrade is an option, but it shouldn't be the first thing we suggest.


. If Kibana and {xpack} are part of your stack, upgrade the internal Kibana
and {xpack} indices. We recommend using the {xpack} 5.6 Reindex Helper to
Expand All @@ -54,7 +56,7 @@ internal indices after you install Elasticsearch {version}.

. If you use {xpack} to secure your cluster:
.. Make sure TLS is enabled to encrypt communications between nodes. TLS must
be enabled to upgrade to {version}. For more information, see
be enabled to upgrade to {version}. For more information, see
{xpack-ref}/encrypting-communications.html[Encrypting Communications].
+
NOTE: Enabling TLS requires a full cluster restart. Nodes that have TLS
Expand Down Expand Up @@ -183,8 +185,18 @@ these indices must be upgraded to the new format. If you are upgrading from a
version prior to 5.6, you must upgrade them after after installing
Elasticsearch {version}.

To get a list of the indices that need to be upgraded, install {xpack} and use
the {ref}/migration-api-assistance.html[`_xpack/migration/assistance` API]:
Starting in 5.6, X-Pack Kibana provides an
{xpack-ref}/xpack-upgrade-assistant.html[Upgrade Assistant UI] to aid in the
upgrade process. Use this utility to upgrade the internal Kibana and X-Pack
indices.
Copy link
Author

Choose a reason for hiding this comment

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

The original text is misleading-- you don't get a list of all indices that need upgrading or reindexing from the assistance API because Kibana indices will not show up in the response.

In addition, the instructions for upgrading the internal indices only applies to x-pack indices--not to Kibana. So I created two sections under this header--one for manually upgrading x-pack internal indices, and one for manually upgrading kibana indices. At the top of both of these sections, I have highlighted the the Upgrade Assistant tool which does both/all from a UI.

I removed the TIP as well because that wording was actually incorrect.


If you would prefer to perform the upgrade of internal indices manually,
keep reading.

===== Manually upgrading X-Pack indices for {major-version}

To get a list of the X-Pack indices that need to be upgraded, install {xpack}
and use the {ref}/migration-api-assistance.html[`_xpack/migration/assistance` API]:

[source,json]
----------------------------------------------------------
Expand Down Expand Up @@ -212,8 +224,9 @@ POST /_xpack/migration/upgrade/.security
You can use your regular administration credentials to upgrade the other
internal indices using the `_xpack/migration/upgrade` API.

TIP: Once you upgrade the `.kibana` index, you can run Kibana and use the
X-Pack Reindex Helper UI to upgrade the other indices.
===== Manually upgrading Kibana indices for {major-version}

To upgrade your Kibana indices, follow {kibana-ref}/migrating-6.0-index.html[this guide].

[[upgrade-elastic-stack-for-elastic-cloud]]
=== Upgrading on Elastic Cloud
Expand Down Expand Up @@ -245,4 +258,5 @@ To learn more about the upgrade process on Elastic Cloud, see {cloudref}/upgradi
Upgrade Versions] and {cloudref}/cluster-config.html[Configuring Elastic Cloud].

NOTE: Elastic Cloud only supports upgrades to released versions. Preview
releases and master snapshots are not supported.
releases and master snapshots are not supported.