mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-24 23:27:25 -04:00
1b5827da3e
* Implement GET API for System Feature Upgrades (#78642) * Implement and test get feature upgrade status API * Add integration test for feature upgrade endpoint * Use constant enum for statuses * Add unit tests for transport class methods * Fix bwc tests for 7.x
150 lines
4.1 KiB
Text
150 lines
4.1 KiB
Text
[role="xpack"]
|
|
[testenv="basic"]
|
|
[[migration-api-feature-upgrade]]
|
|
=== Feature Upgrade APIs
|
|
++++
|
|
<titleabbrev>Feature upgrade APIs</titleabbrev>
|
|
++++
|
|
|
|
IMPORTANT: Use this API to check for system features that need to be upgraded before
|
|
a major version upgrade. You should run it on the last minor version of the
|
|
major version you are upgrading from.
|
|
|
|
The feature upgrade APIs are to be used to retrieve information about system features
|
|
that have to be upgraded before a cluster can be migrated to the next major version number,
|
|
and to trigger an automated system upgrade that might potentially involve downtime for
|
|
{es} system features.
|
|
|
|
[[feature-upgrade-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /migration/system_features`
|
|
|
|
[[feature-upgrade-api-prereqs]]
|
|
==== {api-prereq-title}
|
|
|
|
* If the {es} {security-features} are enabled, you must have the `manage`
|
|
<<privileges-list-cluster,cluster privilege>> to use this API. (TODO: true?)
|
|
|
|
[[feature-upgrade-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
To see the list of system features needing upgrades, submit a GET request to the
|
|
`_migration/system_features` endpoint:
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_migration/system_features
|
|
--------------------------------------------------
|
|
|
|
Example response:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"features" : [
|
|
{
|
|
"feature_name" : "async_search",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "enrich",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "fleet",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "geoip",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "kibana",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "logstash_management",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "machine_learning",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "searchable_snapshots",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "security",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "tasks",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "transform",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "watcher",
|
|
"minimum_index_version" : "7.0.0",
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED",
|
|
"indices" : [ ]
|
|
}
|
|
],
|
|
"upgrade_status" : "NO_UPGRADE_NEEDED"
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[s/"minimum_index_version" : "7.0.0"/"minimum_index_version" : $body.$_path/]
|
|
|
|
This response tells us that Elasticsearch security needs its internal
|
|
indices upgraded before we can upgrade the cluster to 8.0.
|
|
|
|
To perform the required upgrade, submit a POST request to the same endpoint.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_migration/system_features
|
|
--------------------------------------------------
|
|
|
|
Example response:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"accepted" : true,
|
|
"features" : [
|
|
{
|
|
"feature_name" : "security"
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
|
|
This tells us that the security index is being upgraded. To check the
|
|
overall status of the upgrade, call the endpoint with GET.
|
|
|