Skip to content

Commit

Permalink
[DOCS] Deprecates migration assistance and upgrade APIs (#247)
Browse files Browse the repository at this point in the history
  • Loading branch information
lcawl authored Mar 15, 2019
1 parent 2950129 commit c89e112
Showing 1 changed file with 15 additions and 20 deletions.
35 changes: 15 additions & 20 deletions docs/en/install-upgrade/upgrading-stack.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,15 @@ need to be migrated or deleted, and upgrade the internal indices to the
+
You can also call the Elasticsearch migration APIs directly:
+
`/_xpack/migration/assistance`:: Runs a series of checks on your cluster,
nodes, and indices and returns a list of issues that need to be
fixed before you can upgrade to {version}.
`/_xpack/migration/deprecations`:: Retrieves information about cluster-, node-,
and index-level settings that use deprecated features.
+
`/_xpack/migration/upgrade`:: Upgrades the indices for the {watcher} and
{security-features} to a single-type format compatible with Elasticsearch 6.x.
`/_xpack/migration/assistance`:: deprecated[6.7.0] Returns a list of indices
that need to be reindexed before you can upgrade to {version}.
+
`/_xpack/migration/upgrade`:: deprecated[6.7.0] Upgrades the indices for the
{watcher} and {security-features} to a single-type format compatible with
Elasticsearch 6.x.

. Once you've resolved all of the migration issues, perform
a {ref}/rolling-upgrades.html[rolling upgrade] from Elasticsearch 5.6 to {version}.
Expand Down Expand Up @@ -239,34 +242,26 @@ 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]:
To get a list of the indices that need to be upgraded, use the
{ref}/migration-api-deprecation.html[deprecation info API]:

[source,json]
----------------------------------------------------------
GET /_xpack/migration/assistance
GET /_xpack/migration/deprecations
----------------------------------------------------------
// CONSOLE

To upgrade the `.security` index:

. On a single node, add a temporary superuser account to the `file` realm.
. Use the {ref}/migration-api-upgrade.html[`_xpack/migration/upgrade`]
API to upgrade the security index, submitting the request with the credentials
for the temporary superuser:
+
--
[source,json]
----------------------------------------------------------
POST /_xpack/migration/upgrade/.security
----------------------------------------------------------
// CONSOLE
--
. Use the {kib} Upgrade Assistant to upgrade the security index, submitting the
request with the credentials for the temporary superuser. Alternatively, you can
{ref}/reindex-upgrade.html[reindex manually].

. Delete the temporary superuser account from the file realm.

You can use your regular administration credentials to upgrade the other
internal indices using the `_xpack/migration/upgrade` API.
internal indices.

TIP: Once you upgrade the `.kibana` index, you can run Kibana and use the
{xpack} Reindex Helper UI to upgrade the other indices.
Expand Down

0 comments on commit c89e112

Please sign in to comment.