OpenSearch/docs/reference
Martijn van Groningen a3030c51e2 [ILM] Add unfollow action (#36970)
This change adds the unfollow action for CCR follower indices.

This is needed for the shrink action in case an index is a follower index.
This will give the follower index the opportunity to fully catch up with
the leader index, pause index following and unfollow the leader index.
After this the shrink action can safely perform the ilm shrink.

The unfollow action needs to be added to the hot phase and acts as
barrier for going to the next phase (warm or delete phases), so that
follower indices are being unfollowed properly before indices are expected
to go in read-only mode. This allows the force merge action to execute
its steps safely.

The unfollow action has three steps:
* `wait-for-indexing-complete` step: waits for the index in question
  to get the `index.lifecycle.indexing_complete` setting be set to `true`
* `wait-for-follow-shard-tasks` step: waits for all the shard follow tasks
  for the index being handled to report that the leader shard global checkpoint
  is equal to the follower shard global checkpoint.
* `pause-follower-index` step: Pauses index following, necessary to unfollow
* `close-follower-index` step: Closes the index, necessary to unfollow
* `unfollow-follower-index` step: Actually unfollows the index using 
  the CCR Unfollow API
* `open-follower-index` step: Reopens the index now that it is a normal index
* `wait-for-yellow` step: Waits for primary shards to be allocated after
  reopening the index to ensure the index is ready for the next step

In the case of the last two steps, if the index in being handled is
a regular index then the steps acts as a no-op.

Relates to #34648

Co-authored-by: Martijn van Groningen <martijn.v.groningen@gmail.com>
Co-authored-by: Gordon Brown <gordon.brown@elastic.co>
2019-01-18 13:05:03 -07:00
..
aggregations Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
analysis Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
cat Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
ccr Add ccr follow info api (#37408) 2019-01-18 16:37:21 +01:00
cluster [DOCS] Adds overview and API ref for cluster voting configurations (#36954) 2019-01-07 09:11:14 -08:00
commands [DOCS] Update X-Pack terminology in security docs (#36564) 2018-12-19 14:53:37 -08:00
docs Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
graph Remove X-Pack centric graph endpoints (#36010) 2018-11-29 07:09:37 -05:00
how-to Update the default for include_type_name to false. (#37285) 2019-01-14 13:08:01 -08:00
ilm [ILM] Add unfollow action (#36970) 2019-01-18 13:05:03 -07:00
images Move ODBC documentation to `elasticsearch` repository (#36955) 2018-12-27 11:55:20 +02:00
index-modules Remove `include_type_name` in asciidoc where possible (#37568) 2019-01-18 09:34:11 +01:00
indices Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
ingest Update the default for include_type_name to false. (#37285) 2019-01-14 13:08:01 -08:00
licensing [DOCS] Synchs titles of X-Pack APIs 2018-12-20 10:27:24 -08:00
mapping Remove `include_type_name` in asciidoc where possible (#37568) 2019-01-18 09:34:11 +01:00
migration Remove the AbstracLifecycleComponent constructor with Settings (#37523) 2019-01-17 09:10:09 +01:00
ml [DOCS] Adds size limitation to the get datafeeds APIs (#37578) 2019-01-17 10:47:15 -08:00
modules Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
monitoring remove `+` references for xpack.monitoring.collection.indices (#37282) 2019-01-10 17:06:44 -06:00
query-dsl Remove `include_type_name` in asciidoc where possible (#37568) 2019-01-18 09:34:11 +01:00
release-notes [DOCS] Various spelling corrections (#37046) 2019-01-07 14:44:12 +01:00
rest-api [DOCS] Update X-Pack terminology in security docs (#36564) 2018-12-19 14:53:37 -08:00
rollup [DOCS] Edits rollup API description (#37444) 2019-01-15 08:46:36 -08:00
search Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
security Security: remove SSL settings fallback (#36846) 2019-01-14 14:06:22 -07:00
settings Security: remove SSL settings fallback (#36846) 2019-01-14 14:06:22 -07:00
setup Change file descriptor limit to 65535 (#37537) 2019-01-16 17:19:12 -05:00
sql SQL: Rename SQL type DATE to DATETIME (#37395) 2019-01-17 10:17:58 +02:00
testing [Docs] Remove repeating words (#33087) 2018-08-28 13:16:43 +02:00
upgrade [DOCS] Rolling upgrade with old internal indices (#37184) 2019-01-09 18:14:22 +02:00
aggregations.asciidoc [Docs] Update aggregations.asciidoc (#29265) 2018-03-28 15:01:45 +02:00
analysis.asciidoc Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
api-conventions.asciidoc [DOCS] Synchronizes captialization in top-level titles (#33605) 2018-09-27 08:36:18 -07:00
cat.asciidoc Minor docs cleanup (#37595) 2019-01-18 09:28:48 +01:00
cluster.asciidoc [DOCS] Adds overview and API ref for cluster voting configurations (#36954) 2019-01-07 09:11:14 -08:00
docs.asciidoc Document Seq No powered optimistic concurrency control (#37284) 2019-01-11 07:59:15 -08:00
frozen-indices.asciidoc Expose `search.throttled` on `_cat/indices` (#37073) 2019-01-04 13:49:40 +01:00
getting-started.asciidoc Change file descriptor limit to 65535 (#37537) 2019-01-16 17:19:12 -05:00
glossary.asciidoc Default to one shard (#30539) 2018-05-14 12:22:35 -04:00
gs-index.asciidoc
how-to.asciidoc
index-modules.asciidoc ingest: document index.default_pipeline (#34500) 2018-10-23 13:49:25 -05:00
index.asciidoc Add a `_freeze` / `_unfreeze` API (#35592) 2018-11-20 08:03:24 +01:00
index.x.asciidoc [DOCS] Removes redundant index.asciidoc files (#30707) 2018-05-18 11:05:40 -07:00
indices.asciidoc
ingest.asciidoc ingest: document index.default_pipeline (#34500) 2018-10-23 13:49:25 -05:00
mapping.asciidoc Remove more include_type_name and types from docs (#37601) 2019-01-18 14:11:18 +01:00
modules.asciidoc [Zen2] Update documentation for Zen2 (#34714) 2018-12-20 13:02:44 +00:00
query-dsl.asciidoc
redirects.asciidoc [Zen2] Update documentation for Zen2 (#34714) 2018-12-20 13:02:44 +00:00
release-notes.asciidoc [DOCS] Adds placeholder for alpha2 release notes 2018-12-11 14:26:41 -08:00
search.asciidoc Make sure to use the type _doc in the REST documentation. (#34662) 2018-10-22 11:54:04 -07:00
setup.asciidoc [DOCS] Intro for adding nodes (#37202) 2019-01-15 11:11:01 -08:00
testing.asciidoc
upgrade.asciidoc Revert "[DOCS] Added 6.3 info & updated the upgrade table. (#30940)" 2018-06-11 22:04:36 -04:00