Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[DOCS] Update snapshot/restore for data stream aliases #73438

Merged
merged 1 commit into from
May 27, 2021
Merged

[DOCS] Update snapshot/restore for data stream aliases #73438

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
7 changes: 5 additions & 2 deletions docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -79,7 +79,7 @@ you are restoring. Existing indices can only be restored if they are
the snapshot. The restore operation automatically opens restored indices if
they were closed and creates new indices if they do not exist in the cluster.

If a data stream is restored, its backing indices are also restored.
If a data stream is restored, its aliases and backing indices are also restored.
Alternatively, you can restore individual backing indices without restoring an
entire data stream. If you restore individual backing indices, they are not
automatically added to any existing data stream. For example, if only the
Expand Down Expand Up @@ -128,8 +128,11 @@ A comma-separated list of index settings that should not be restored from a snap
If `true`, index aliases from the original snapshot are restored.
Defaults to `true`.
+
If `false`, prevents aliases from being restored together with associated
If `false`, prevents index aliases from being restored together with associated
indices.
+
This option doesn't affect data stream aliases. Restoring a data stream
restores its aliases.

[[restore-snapshot-api-include-global-state]]
`include_global_state`::
Expand Down
5 changes: 3 additions & 2 deletions docs/reference/snapshot-restore/restore-snapshot.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -73,8 +73,9 @@ name. If no index template matches the stream, it cannot
====
// end::rename-restored-data-stream-tag[]

Set `include_aliases` to `false` to prevent aliases from being restored together
with associated indices.
To prevent index aliases from being restored together with associated indices,
set `include_aliases` to `false`. This option doesn't affect data stream
aliases. Restoring a data stream restores its aliases.

[source,console]
-----------------------------------
Expand Down