From 63d4b1d44b4b0d792daca61eb319147fa765e760 Mon Sep 17 00:00:00 2001 From: James Rodewig <40268737+jrodewig@users.noreply.github.com> Date: Tue, 24 Nov 2020 19:23:58 -0500 Subject: [PATCH] [DOCS] Fix redirects and anchors (#65472) --- docs/reference/datatiers.asciidoc | 4 ++-- .../how-to/size-your-shards.asciidoc | 2 +- .../reference/ilm/actions/ilm-delete.asciidoc | 2 +- .../ilm/actions/ilm-rollover.asciidoc | 2 +- .../actions/ilm-searchable-snapshot.asciidoc | 2 +- .../reference/ilm/actions/ilm-shrink.asciidoc | 2 +- .../ilm/actions/ilm-unfollow.asciidoc | 8 +++---- docs/reference/ilm/ilm-actions.asciidoc | 23 +++++++++---------- .../ilm/ilm-index-lifecycle.asciidoc | 6 ++--- docs/reference/redirects.asciidoc | 7 +++++- .../restore-snapshot.asciidoc | 1 + 11 files changed, 32 insertions(+), 27 deletions(-) diff --git a/docs/reference/datatiers.asciidoc b/docs/reference/datatiers.asciidoc index 69d4990c3bf..818b5499515 100644 --- a/docs/reference/datatiers.asciidoc +++ b/docs/reference/datatiers.asciidoc @@ -106,7 +106,7 @@ If you set the tier preference to `null`, {es} ignores the data tier roles durin === Automatic data tier migration {ilm-init} automatically transitions managed -indices through the available data tiers using the <> action. +indices through the available data tiers using the <> action. By default, this action is automatically injected in every phase. You can explicitly specify the migrate action to override the default behavior, -or use the <> to manually specify allocation rules. +or use the <> to manually specify allocation rules. diff --git a/docs/reference/how-to/size-your-shards.asciidoc b/docs/reference/how-to/size-your-shards.asciidoc index 18496d2eafd..574e713f61f 100644 --- a/docs/reference/how-to/size-your-shards.asciidoc +++ b/docs/reference/how-to/size-your-shards.asciidoc @@ -260,7 +260,7 @@ POST /my-index-000001/_shrink/my-shrunken-index-000001 ---- // TEST[s/^/PUT my-index-000001\n{"settings":{"index.number_of_shards":2,"blocks.write":true}}\n/] -{ilm-init} also has a <> for indices in the +{ilm-init} also has a <> for indices in the warm phase. [discrete] diff --git a/docs/reference/ilm/actions/ilm-delete.asciidoc b/docs/reference/ilm/actions/ilm-delete.asciidoc index fe66b72fa72..f6e4c6323c9 100644 --- a/docs/reference/ilm/actions/ilm-delete.asciidoc +++ b/docs/reference/ilm/actions/ilm-delete.asciidoc @@ -14,7 +14,7 @@ beta:[] (Optional, Boolean) Deletes the searchable snapshot created in the cold phase. Defaults to `true`. -This option is applicable when the <> action is used in the cold phase. [[ilm-delete-action-ex]] diff --git a/docs/reference/ilm/actions/ilm-rollover.asciidoc b/docs/reference/ilm/actions/ilm-rollover.asciidoc index 42d4d47f67a..c0d5659ba03 100644 --- a/docs/reference/ilm/actions/ilm-rollover.asciidoc +++ b/docs/reference/ilm/actions/ilm-rollover.asciidoc @@ -10,7 +10,7 @@ IMPORTANT: If the rollover action is used on a <> policy execution waits until the leader index rolls over (or is <>), then converts the follower index into a regular index with the -<>. +<>. A rollover target can be a <> or an <>. When targeting a data stream, the new index becomes the data stream's diff --git a/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc b/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc index 667453e3a43..a355f10c3c1 100644 --- a/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc +++ b/docs/reference/ilm/actions/ilm-searchable-snapshot.asciidoc @@ -21,7 +21,7 @@ Using a policy that makes use of the <> action in the hot phase will avoid this situation and the need for a manual rollover for future managed indices. -By default, this snapshot is deleted by the <> in the delete phase. +By default, this snapshot is deleted by the <> in the delete phase. To keep the snapshot, set `delete_searchable_snapshot` to `false` in the delete action. [[ilm-searchable-snapshot-options]] diff --git a/docs/reference/ilm/actions/ilm-shrink.asciidoc b/docs/reference/ilm/actions/ilm-shrink.asciidoc index 8800136abf5..de59adacafc 100644 --- a/docs/reference/ilm/actions/ilm-shrink.asciidoc +++ b/docs/reference/ilm/actions/ilm-shrink.asciidoc @@ -19,7 +19,7 @@ If the shrink action is used on a <>, policy execution waits until the leader index rolls over (or is <>), then converts the follower index into a regular index with the -<> before performing the shrink operation. +<> before performing the shrink operation. If the managed index is part of a <>, the shrunken index replaces the original index in the data stream. diff --git a/docs/reference/ilm/actions/ilm-unfollow.asciidoc b/docs/reference/ilm/actions/ilm-unfollow.asciidoc index 06a988fd18d..0ad6173f827 100644 --- a/docs/reference/ilm/actions/ilm-unfollow.asciidoc +++ b/docs/reference/ilm/actions/ilm-unfollow.asciidoc @@ -11,9 +11,9 @@ You can also use unfollow directly when moving follower indices through the life Has no effect on indices that are not followers, phase execution just moves to the next action. [NOTE] -This action is triggered automatically by the <>, -<>, and -<> actions when they are +This action is triggered automatically by the <>, +<>, and +<> actions when they are applied to follower indices. This action waits until is it safe to convert a follower index into a regular index. @@ -21,7 +21,7 @@ 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 -<> action, and can be set manually using +<> action, and can be set manually using the <> 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. diff --git a/docs/reference/ilm/ilm-actions.asciidoc b/docs/reference/ilm/ilm-actions.asciidoc index 5da6bec5250..254592aa5fa 100644 --- a/docs/reference/ilm/ilm-actions.asciidoc +++ b/docs/reference/ilm/ilm-actions.asciidoc @@ -3,49 +3,48 @@ [[ilm-actions]] == Index lifecycle actions -[[ilm-allocate-action]] <>:: Move shards to nodes with different performance characteristics and reduce the number of replicas. -[[ilm-delete-action]]<>:: +<>:: Permanently remove the index. -[[ilm-forcemerge-action]]<>:: +<>:: Reduce the number of index segments and purge deleted documents. Makes the index read-only. -[[ilm-freeze-action]]<>:: +<>:: Freeze the index to minimize its memory footprint. -[[ilm-migrate-action]]<>:: +<>:: Move the index shards to the <> that corresponds to the current {ilm-init] phase. -[[ilm-readonly-action]]<>:: +<>:: Block write operations to the index. -[[ilm-rollover-action]]<>:: +<>:: Remove the index as the write index for the rollover alias and start indexing to a new index. -[[ilm-searchable-snapshot-action]]<>:: +<>:: beta:[] Take a snapshot of the managed index in the configured repository and mount it as a searchable snapshot. -[[ilm-set-priority-action]]<>:: +<>:: Lower the priority of an index as it moves through the lifecycle to ensure that hot indices are recovered first. -[[ilm-shrink-action]]<>:: +<>:: Reduce the number of primary shards by shrinking the index into a new index. -[[ilm-unfollow-action]]<>:: +<>:: Convert a follower index to a regular index. Performed automatically before a rollover, shrink, or searchable snapshot action. -[[ilm-wait-for-snapshot-action]]<>:: +<>:: Ensure that a snapshot exists before deleting the index. include::actions/ilm-allocate.asciidoc[] diff --git a/docs/reference/ilm/ilm-index-lifecycle.asciidoc b/docs/reference/ilm/ilm-index-lifecycle.asciidoc index 8392a30e48e..7bda84f6ed0 100644 --- a/docs/reference/ilm/ilm-index-lifecycle.asciidoc +++ b/docs/reference/ilm/ilm-index-lifecycle.asciidoc @@ -87,12 +87,12 @@ the rollover criteria, it could be 20 minutes before the rollover is complete. - <> - <> * Cold - - <> - - <> + - <> + - <> - <> - <> - <> * Delete - - <> + - <> - <> diff --git a/docs/reference/redirects.asciidoc b/docs/reference/redirects.asciidoc index 86318d51a99..b93593ec03b 100644 --- a/docs/reference/redirects.asciidoc +++ b/docs/reference/redirects.asciidoc @@ -611,6 +611,11 @@ See <>. See <>. +[role="exclude",id="_changing_index_settings_during_restore"] +==== Change index settings during restore + +See <>. + [role="exclude",id="restore-snapshot"] === Restore snapshot @@ -1249,7 +1254,7 @@ See <>. See <>. -[[fielddata]] +[role="exclude",id="fielddata"] === `fielddata` mapping parameter See <>. diff --git a/docs/reference/snapshot-restore/restore-snapshot.asciidoc b/docs/reference/snapshot-restore/restore-snapshot.asciidoc index a3c224b4634..63033641f5f 100644 --- a/docs/reference/snapshot-restore/restore-snapshot.asciidoc +++ b/docs/reference/snapshot-restore/restore-snapshot.asciidoc @@ -122,6 +122,7 @@ restored in this case and all missing shards will be recreated empty. [discrete] +[[change-index-settings-during-restore]] === Changing index settings during restore Use the <> parameter