Skip to content

Commit 32fbdad

Browse files
authored
[DOCS] Update migration APIs docs (#83901) (#83966)
* Adds a shared note that the migration APIs are mainly intended for internal use by Kibana's Upgrade Assistant. * Updates the feature migration API docs to use updated "migration" terminology. * Removes some references to major versions from the deprecation API docs. (cherry picked from commit e117812)
1 parent ca44649 commit 32fbdad

File tree

5 files changed

+50
-29
lines changed

5 files changed

+50
-29
lines changed

docs/reference/migration/apis/deprecation.asciidoc

Lines changed: 3 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -5,14 +5,11 @@
55
<titleabbrev>Deprecation info</titleabbrev>
66
++++
77

8-
IMPORTANT: Use this API to check for deprecated configuration before performing
9-
a major version upgrade. You should run it on the last minor version of the
10-
major version you are upgrading from, as earlier minor versions may not include
11-
all deprecations.
8+
include::{es-repo-dir}/migration/apis/shared-migration-apis-tip.asciidoc[]
129

1310
The deprecation API is to be used to retrieve information about different
1411
cluster, node, and index level settings that use deprecated features that will
15-
be removed or changed in the next major version.
12+
be removed or changed in a future version.
1613

1714
[[migration-api-request]]
1815
==== {api-request-title}
@@ -118,7 +115,7 @@ issue.
118115

119116
|=======
120117
|warning | You can upgrade directly, but you are using deprecated functionality
121-
which will not be available or behave differently in the next major version.
118+
which will not be available or behave differently in a future version.
122119
|critical | You cannot upgrade without fixing this problem.
123120
|=======
124121

docs/reference/migration/apis/feature_upgrade.asciidoc renamed to docs/reference/migration/apis/feature-migration.asciidoc

Lines changed: 33 additions & 21 deletions
Original file line numberDiff line numberDiff line change
@@ -1,35 +1,47 @@
11
[role="xpack"]
2-
[[migration-api-feature-upgrade]]
3-
=== Feature Upgrade APIs
2+
[[feature-migration-api]]
3+
=== Feature migration APIs
44
++++
5-
<titleabbrev>Feature upgrade APIs</titleabbrev>
5+
<titleabbrev>Feature migration</titleabbrev>
66
++++
77

8-
IMPORTANT: Use this API to check for system features that need to be upgraded before
9-
a major version upgrade. You should run it on the last minor version of the
10-
major version you are upgrading from.
8+
include::{es-repo-dir}/migration/apis/shared-migration-apis-tip.asciidoc[]
119

12-
The feature upgrade APIs are to be used to retrieve information about system features
13-
that have to be upgraded before a cluster can be migrated to the next major version number,
14-
and to trigger an automated system upgrade that might potentially involve downtime for
15-
{es} system features.
10+
Version upgrades sometimes require changes to how features store configuration
11+
information and data in system indices. The feature migration APIs enable you to
12+
see what features require changes, initiate the automatic migration process, and
13+
check migration status.
1614

17-
[[feature-upgrade-api-request]]
15+
Some functionality might be temporarily unavailable during the migration
16+
process.
17+
18+
[[feature-migration-api-request]]
1819
==== {api-request-title}
1920

2021
`GET /migration/system_features`
2122

22-
[[feature-upgrade-api-prereqs]]
23+
`POST /migration/system_features`
24+
25+
[[feature-migration-api-prereqs]]
2326
==== {api-prereq-title}
2427

2528
* If the {es} {security-features} are enabled, you must have the `manage`
2629
<<privileges-list-cluster,cluster privilege>> to use this API.
2730

28-
[[feature-upgrade-api-example]]
31+
[[feature-migration-api-desc]]
32+
==== {api-description-title}
33+
34+
Submit a GET request to the `_migration/system_features` endpoint to see what
35+
features need to be migrated and the status of any migrations that are in
36+
progress.
37+
38+
Submit a POST request to the endpoint to start the migration process.
39+
40+
[[feature-migration-api-example]]
2941
==== {api-examples-title}
3042

31-
To see the list of system features needing upgrades, submit a GET request to the
32-
`_migration/system_features` endpoint:
43+
When you submit a GET request to the `_migration/system_features` endpoint, the
44+
response indicates the status of any features that need to be migrated.
3345

3446
[source,console]
3547
--------------------------------------------------
@@ -120,10 +132,10 @@ Example response:
120132
--------------------------------------------------
121133
// TESTRESPONSE[s/"minimum_index_version" : "8.0.0"/"minimum_index_version" : $body.$_path/]
122134

123-
This response tells us that Elasticsearch security needs its internal
124-
indices upgraded before we can upgrade the cluster to 8.0.
125135

126-
To perform the required upgrade, submit a POST request to the same endpoint.
136+
When you submit a POST request to the `_migration/system_features` endpoint to
137+
start the migration process, the response indicates what features will be
138+
migrated.
127139

128140
[source,console]
129141
--------------------------------------------------
@@ -138,13 +150,13 @@ Example response:
138150
"accepted" : true,
139151
"features" : [
140152
{
141-
"feature_name" : "security"
153+
"feature_name" : "security" <1>
142154
}
143155
]
144156
}
145157
--------------------------------------------------
146158
// TESTRESPONSE[skip: can't actually upgrade system indices in these tests]
147159

148-
This tells us that the security index is being upgraded. To check the
149-
overall status of the upgrade, call the endpoint with GET.
160+
<1> {es} security will be migrated before the cluster is upgraded.
150161

162+
Subsequent GET requests will return the status of the migration process.
Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,4 @@
1+
TIP: These APIs are designed for indirect use by {kib}'s **Upgrade Assistant**.
2+
We strongly recommend you use the **Upgrade Assistant** to upgrade from
3+
{prev-major-last} to {version}. For upgrade instructions, refer to
4+
{stack-ref}/upgrading-elastic-stack.html[Upgrading to Elastic {version}].

docs/reference/migration/migration.asciidoc

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -2,9 +2,12 @@
22
[[migration-api]]
33
== Migration APIs
44

5-
The migration APIs simplify upgrading {xpack} indices from one version to another.
5+
The migration APIs power {kib}'s **Upgrade Assistant** feature.
6+
7+
include::apis/shared-migration-apis-tip.asciidoc[]
68

79
* <<migration-api-deprecation>>
10+
* <<feature-migration-api>>
811

912
include::apis/deprecation.asciidoc[]
10-
include::apis/feature_upgrade.asciidoc[]
13+
include::apis/feature-migration.asciidoc[]

docs/reference/redirects.asciidoc

Lines changed: 5 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -3,6 +3,11 @@
33

44
The following pages have moved or been deleted.
55

6+
[role="exclude",id="migration-api-feature-upgrade"]
7+
=== Feature upgrade APIs
8+
9+
Refer to <<feature-migration-api,Feature migration APIs>>.
10+
611
[role="exclude",id="java-clients"]
712
=== Java transport client and security
813

0 commit comments

Comments
 (0)