Docs: Add Upgrade API documentation (elastic/x-pack-elasticsearch#2063)
Original commit: elastic/x-pack-elasticsearch@f5a7c9ee5d
This commit is contained in:
Igor Motov
GitHub
parent
2f7142ccc7
commit
66a723d134
|
|
@ -12,6 +12,7 @@ directly to configure and access {xpack} features.
|
|||
* <<ml-apis, Machine Learning APIs>>
|
||||
* <<security-api,Security APIs>>
|
||||
* <<watcher-api, Watcher APIs>>
|
||||
* <<migration-api, Migration APIs>>
|
||||
--
|
||||
|
||||
|
||||
|
|
@ -20,4 +21,5 @@ include::graph/explore.asciidoc[]
|
|||
include::ml-api.asciidoc[]
|
||||
include::security.asciidoc[]
|
||||
include::watcher.asciidoc[]
|
||||
include::migration.asciidoc[]
|
||||
include::defs.asciidoc[]
|
||||
|
|
|
|||
|
|
@ -0,0 +1,12 @@
|
|||
[role="xpack"]
|
||||
[[migration-api]]
|
||||
== Migration APIs
|
||||
|
||||
The migration APIs simplify upgrading {xpack} indices from one version to another.
|
||||
|
||||
* <<migration-api-assistance>>
|
||||
* <<migration-api-upgrade>>
|
||||
|
||||
include::migration/assistance.asciidoc[]
|
||||
include::migration/upgrade.asciidoc[]
|
||||
|
||||
|
|
@ -0,0 +1,67 @@
|
|||
[role="xpack"]
|
||||
[[migration-api-assistance]]
|
||||
=== Migration Assistance API
|
||||
|
||||
The Migration Assistance API analyzes existing indices in the cluster and returns the information
|
||||
about indices that require some changes before the cluster can be upgraded to the next major version.
|
||||
|
||||
To see a list of indices that needs to be upgraded or reindexed, submit a GET request to the
|
||||
`/_xpack/migration/assistance` endpoint:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /_xpack/migration/assistance
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:cannot create an old index in docs test]
|
||||
|
||||
A successful call returns a list of indices that need to updated or reindexed:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"indices" : {
|
||||
".watches" : {
|
||||
"action_required" : "upgrade"
|
||||
},
|
||||
".security" : {
|
||||
"action_required" : "upgrade"
|
||||
},
|
||||
"my_old_index": {
|
||||
"action_required" : "reindex"
|
||||
},
|
||||
"my_other_old_index": {
|
||||
"action_required" : "reindex"
|
||||
}
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
// NOTCONSOLE
|
||||
|
||||
To check a particular index or set of indices, specify this index name or mask as the last part of the
|
||||
`/_xpack/migration/assistance/index_name` endpoint:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET /_xpack/migration/assistance/my_*
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:cannot create an old index in docs test]
|
||||
|
||||
A successful call returns a list of indices that needs to updated or reindexed and match the index specified
|
||||
on the endpoint:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"indices" : {
|
||||
"my_old_index": {
|
||||
"action_required" : "reindex"
|
||||
},
|
||||
"my_other_old_index": {
|
||||
"action_required" : "reindex"
|
||||
}
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
// NOTCONSOLE
|
||||
|
|
@ -0,0 +1,108 @@
|
|||
[role="xpack"]
|
||||
[[migration-api-upgrade]]
|
||||
=== Migration Upgrade API
|
||||
|
||||
The Migration Upgrade API performs the upgrade of internal indices to make them compatible with the next major version.
|
||||
|
||||
Indices need to be upgraded one at a time by submitting a POST request to the
|
||||
`/_xpack/migration/upgrade/index_name` endpoint:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
POST /_xpack/migration/upgrade/.watches
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:cannot create an old index in docs test]
|
||||
|
||||
A successful call returns the statistics about the upgrade process:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"took" : 127,
|
||||
"timed_out" : false,
|
||||
"total" : 4,
|
||||
"updated" : 0,
|
||||
"created" : 4,
|
||||
"deleted" : 0,
|
||||
"batches" : 1,
|
||||
"version_conflicts" : 0,
|
||||
"noops" : 0,
|
||||
"retries" : {
|
||||
"bulk" : 0,
|
||||
"search" : 0
|
||||
},
|
||||
"throttled_millis" : 0,
|
||||
"failures" : [ ]
|
||||
}
|
||||
--------------------------------------------------
|
||||
// NOTCONSOLE
|
||||
|
||||
By default, the upgrade call blocks until the upgrade process is finished. For large indices the upgrade can be
|
||||
performed asynchronously by specifying `wait_for_completion=false` parameter:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
POST /_xpack/migration/upgrade/.watches?wait_for_completion=false
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:cannot create an old index in docs test]
|
||||
|
||||
This call should return the id of the upgrade process task:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"task" : "PFvgv7T6TGumRyFF3vqTFg:1137"
|
||||
}
|
||||
--------------------------------------------------
|
||||
// NOTCONSOLE
|
||||
|
||||
The status of the running or finished upgrade requests can be obtained using <<tasks,Task API>>:
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
GET _tasks/PFvgv7T6TGumRyFF3vqTFg:1137?detailed=true
|
||||
--------------------------------------------------
|
||||
// CONSOLE
|
||||
// TEST[skip:cannot create an old index in docs test]
|
||||
|
||||
[source,js]
|
||||
--------------------------------------------------
|
||||
{
|
||||
"completed" : true, <1>
|
||||
"task" : {
|
||||
"node" : "PFvgv7T6TGumRyFF3vqTFg",
|
||||
"id" : 1137,
|
||||
"type" : "transport",
|
||||
"action" : "cluster:admin/xpack/upgrade",
|
||||
"description" : "",
|
||||
"start_time_in_millis" : 1500650625413,
|
||||
"running_time_in_nanos" : 947456819,
|
||||
"cancellable" : true
|
||||
},
|
||||
"response" : { <2>
|
||||
"took" : 212,
|
||||
"timed_out" : false,
|
||||
"total" : 4,
|
||||
"updated" : 0,
|
||||
"created" : 4,
|
||||
"deleted" : 0,
|
||||
"batches" : 1,
|
||||
"version_conflicts" : 0,
|
||||
"noops" : 0,
|
||||
"retries" : {
|
||||
"bulk" : 0,
|
||||
"search" : 0
|
||||
},
|
||||
"throttled_millis" : 0,
|
||||
"failures" : [ ]
|
||||
}
|
||||
}
|
||||
--------------------------------------------------
|
||||
// NOTCONSOLE
|
||||
|
||||
<1> `true` in the `completed` field indicates that the upgrade request has finished, `false` means that
|
||||
request is still executing
|
||||
|
||||
<2> the `response` field contains the status of the upgrade request
|
||||
|
|
@ -1,5 +1,6 @@
|
|||
{
|
||||
"xpack.migration.get_assistance": {
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-assistance.html",
|
||||
"methods": [ "GET" ],
|
||||
"url": {
|
||||
"path": "/_xpack/migration/assistance",
|
||||
|
|
|
|||
|
|
@ -1,5 +1,6 @@
|
|||
{
|
||||
"xpack.migration.upgrade": {
|
||||
"documentation": "https://www.elastic.co/guide/en/elasticsearch/reference/current/migration-api-upgrade.html",
|
||||
"methods": [ "POST" ],
|
||||
"url": {
|
||||
"path": "/_xpack/migration/upgrade/{index}",
|
||||
|
|
|
|||
Loading…
Reference in New Issue