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

[DOCS] Deprecates migration assistance and upgrade APIs #247

Merged
merged 2 commits into from
Mar 15, 2019
Merged

[DOCS] Deprecates migration assistance and upgrade APIs #247

Changes from 1 commit
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
af9f29d
[DOCS] Deprecates migration assistance and upgrade APIs
lcawl Mar 15, 2019
1916efb
[DOCS] Addresses feedback
lcawl Mar 15, 2019
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
32 changes: 14 additions & 18 deletions docs/en/install-upgrade/upgrading-stack.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -199,12 +199,16 @@ 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
`/_xpack/migration/deprecations`:: Retrieves information about cluster-, node-,
and index-level settings that use deprecated features.
+
`/_xpack/migration/assistance`:: deprecated[6.7.0] 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}.
Copy link

Choose a reason for hiding this comment

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

This should probably say something like

`/_xpack/migration/assistance`:: deprecated[6.7.0] Returns a list of indices that need to 
be reindexed before you can upgrade to {version}.

As it doesn't actually check anything else - the description as written applies more to the migration/deprecations API.

+
`/_xpack/migration/upgrade`:: Upgrades the indices for the {watcher} and
{security-features} to a single-type format compatible with Elasticsearch 6.x.
`/_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 @@ -240,33 +244,25 @@ 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
Copy link

Choose a reason for hiding this comment

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

Do we still want to tell people to "install xpack"?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

Good point, I've removed that.

the {ref}/migration-api-assistance.html[`_xpack/migration/assistance` API]:
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