Skip to content

Commit aac6011

Browse files
authored
[DOCS] Update snapshot/restore for data stream aliases (#73438) (#73480)
In 7.14+, you can now create data stream aliases. This updates the related snapshot/restore documentation.
1 parent 32b3511 commit aac6011

File tree

2 files changed

+8
-4
lines changed

2 files changed

+8
-4
lines changed

docs/reference/snapshot-restore/apis/restore-snapshot-api.asciidoc

+5-2
Original file line numberDiff line numberDiff line change
@@ -79,7 +79,7 @@ you are restoring. Existing indices can only be restored if they are
7979
the snapshot. The restore operation automatically opens restored indices if
8080
they were closed and creates new indices if they do not exist in the cluster.
8181

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

134137
[[restore-snapshot-api-include-global-state]]
135138
`include_global_state`::

docs/reference/snapshot-restore/restore-snapshot.asciidoc

+3-2
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,9 @@ name. If no index template matches the stream, it cannot
7373
====
7474
// end::rename-restored-data-stream-tag[]
7575

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

7980
[source,console]
8081
-----------------------------------

0 commit comments

Comments
 (0)