Skip to content

Commit

Permalink
[DOCS] Fix system index refs in restore tutorial (#78582)
Browse files Browse the repository at this point in the history
Fixes a couple of erroneous references related to system indices in the snapshot restore tutorial:

* Calling the delete index API on `*` will only delete
  some system indices, such as the `.security`. It won't delete others, such as
  `.geoip_databases`.

* Not all dot indices are system indices. Some are just hidden indices.

Relates to #76929
  • Loading branch information
jrodewig authored Oct 6, 2021
1 parent 548bd30 commit 7e5e055
Showing 1 changed file with 9 additions and 8 deletions.
17 changes: 9 additions & 8 deletions docs/reference/snapshot-restore/restore-snapshot.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -100,9 +100,10 @@ operation is complete.
WARNING: If the
<<action-destructive-requires-name,`action.destructive_requires_name`>> cluster
setting is `false`, don't use the <<indices-delete-index,delete index API>> to
target the `*` or `.*` wildcard expression. If you use {es}'s security features,
this will delete system indices required for authentication. To delete all
regular indices, use `*,-.*` instead.
target the `*` or `.*` wildcard pattern. If you use {es}'s security features,
this will delete system indices required for authentication. Instead, target the
`*,-.*` wildcard pattern to exclude these system indices and other index names
that begin with a dot (`.`).

[source,console]
----
Expand All @@ -118,9 +119,10 @@ By default, a restore request attempts to restore all indices and data
streams in the snapshot, including system indices. If your cluster already
contains one or more of these system indices, the request will return an error.

To avoid this error, specify the indices and data streams to restore. To
exclude system indices, append the `-.*` wildcard pattern. To restore all
indices and data streams except system indices, use `*,-.*`.
To avoid this error, specify the indices and data streams to restore. To exclude
system indices and other index names that begin with a dot (`.`), append the
`-.*` wildcard pattern. To restore all indices and data streams except dot
indices, use `*,-.*`.

[source,console]
----
Expand Down Expand Up @@ -323,8 +325,7 @@ PUT _cluster/settings
----
// TEST[setup:setup-snapshots]

. Delete all existing indices and data streams on the cluster, including all
system indices.
. Delete existing indices and data streams on the cluster.
+
[source,console]
----
Expand Down

0 comments on commit 7e5e055

Please sign in to comment.