mirror of
https://github.com/elastic/elasticsearch.git
synced 2025-04-25 07:37:19 -04:00
33a71e3289
* Remove `es-test-dir` book-scoped variable * Remove `plugins-examples-dir` book-scoped variable * Remove `:dependencies-dir:` and `:xes-repo-dir:` book-scoped variables - In `index.asciidoc`, two variables (`:dependencies-dir:` and `:xes-repo-dir:`) were removed. - In `sql/index.asciidoc`, the `:sql-tests:` path was updated to fuller path - In `esql/index.asciidoc`, the `:esql-tests:` path was updated idem * Replace `es-repo-dir` with `es-ref-dir` * Move `:include-xpack: true` to few files that use it, remove from index.asciidoc
173 lines
4.8 KiB
Text
173 lines
4.8 KiB
Text
[role="xpack"]
|
|
[[feature-migration-api]]
|
|
=== Feature migration APIs
|
|
++++
|
|
<titleabbrev>Feature migration</titleabbrev>
|
|
++++
|
|
|
|
include::{es-ref-dir}/migration/apis/shared-migration-apis-tip.asciidoc[]
|
|
|
|
Version upgrades sometimes require changes to how features store configuration
|
|
information and data in system indices. The feature migration APIs enable you to
|
|
see what features require changes, initiate the automatic migration process, and
|
|
check migration status.
|
|
|
|
Some functionality might be temporarily unavailable during the migration
|
|
process.
|
|
|
|
[[feature-migration-api-request]]
|
|
==== {api-request-title}
|
|
|
|
`GET /_migration/system_features`
|
|
|
|
`POST /_migration/system_features`
|
|
|
|
[[feature-migration-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.
|
|
|
|
[[feature-migration-api-desc]]
|
|
==== {api-description-title}
|
|
|
|
Submit a GET request to the `_migration/system_features` endpoint to see what
|
|
features need to be migrated and the status of any migrations that are in
|
|
progress.
|
|
|
|
Submit a POST request to the endpoint to start the migration process.
|
|
|
|
[[feature-migration-api-example]]
|
|
==== {api-examples-title}
|
|
|
|
When you submit a GET request to the `_migration/system_features` endpoint, the
|
|
response indicates the status of any features that need to be migrated.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
GET /_migration/system_features
|
|
--------------------------------------------------
|
|
|
|
Example response:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"features" : [
|
|
{
|
|
"feature_name" : "async_search",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "enrich",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "ent_search",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "fleet",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "geoip",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "kibana",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "logstash_management",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "machine_learning",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "searchable_snapshots",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "security",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "synonyms",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "tasks",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "transform",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
},
|
|
{
|
|
"feature_name" : "watcher",
|
|
"minimum_index_version" : "8100099",
|
|
"migration_status" : "NO_MIGRATION_NEEDED",
|
|
"indices" : [ ]
|
|
}
|
|
],
|
|
"migration_status" : "NO_MIGRATION_NEEDED"
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[skip:"AwaitsFix https://github.com/elastic/elasticsearch/issues/97780]
|
|
|
|
When you submit a POST request to the `_migration/system_features` endpoint to
|
|
start the migration process, the response indicates what features will be
|
|
migrated.
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
POST /_migration/system_features
|
|
--------------------------------------------------
|
|
|
|
Example response:
|
|
|
|
[source,console-result]
|
|
--------------------------------------------------
|
|
{
|
|
"accepted" : true,
|
|
"features" : [
|
|
{
|
|
"feature_name" : "security" <1>
|
|
}
|
|
]
|
|
}
|
|
--------------------------------------------------
|
|
// TESTRESPONSE[skip: can't actually upgrade system indices in these tests]
|
|
|
|
<1> {es} security will be migrated before the cluster is upgraded.
|
|
|
|
Subsequent GET requests will return the status of the migration process.
|