68 lines
2.1 KiB
Plaintext
68 lines
2.1 KiB
Plaintext
[role="xpack"]
|
|
[[ilm-unfollow]]
|
|
=== Unfollow
|
|
|
|
Phases allowed: hot, warm, cold.
|
|
|
|
Converts a {ref}/ccr-apis.html[{ccr-init}] follower index into a regular index.
|
|
This enables the shrink, rollover, and searchable snapshot actions
|
|
to be be performed safely on follower indices.
|
|
You can also use unfollow directly when moving follower indices through the lifecycle.
|
|
Has no effect on indices that are not followers, phase execution just moves to the next action.
|
|
|
|
ifdef::permanently-unreleased-branch[]
|
|
[NOTE]
|
|
This action is triggered automatically by the <<ilm-rollover-action, rollover>>,
|
|
<<ilm-shrink-action, shrink>>, and
|
|
<<ilm-searchable-snapshot-action, searchable snapshot>> actions when they are
|
|
applied to follower indices.
|
|
endif::[]
|
|
|
|
ifndef::permanently-unreleased-branch[]
|
|
[NOTE]
|
|
This action is triggered automatically by the <<ilm-rollover-action, rollover>>
|
|
and <<ilm-shrink-action, shrink>> actions when they are applied to follower
|
|
indices.
|
|
endif::[]
|
|
|
|
This action waits until is it safe to convert a follower index into a regular index.
|
|
The following conditions must be met:
|
|
|
|
* The leader index must have `index.lifecycle.indexing_complete` set to `true`.
|
|
This happens automatically if the leader index is rolled over using the
|
|
<<ilm-rollover-action, rollover>> action, and can be set manually using
|
|
the <<indices-update-settings,index settings>> API.
|
|
* All operations performed on the leader index have been replicated to the follower index.
|
|
This ensures that no operations are lost when the index is converted.
|
|
|
|
Once these conditions are met, unfollow performs the following operations:
|
|
|
|
* Pauses indexing following for the follower index.
|
|
* Closes the follower index.
|
|
* Unfollows the leader index.
|
|
* Opens the follower index (which is at this point is a regular index).
|
|
|
|
[[ilm-unfollow-options]]
|
|
==== Options
|
|
|
|
None.
|
|
|
|
[[ilm-unfollow-ex]]
|
|
==== Example
|
|
|
|
[source,console]
|
|
--------------------------------------------------
|
|
PUT _ilm/policy/my_policy
|
|
{
|
|
"policy": {
|
|
"phases": {
|
|
"hot": {
|
|
"actions": {
|
|
"unfollow" : {}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
}
|
|
--------------------------------------------------
|