Skip to content

Commit

Permalink
Update searchable snapshot reliability docs (#108750)
Browse files Browse the repository at this point in the history
Relates #108451

Co-authored-by: David Turner <david.turner@elastic.co>
  • Loading branch information
kunisen and DaveCTurner committed May 17, 2024
1 parent 1419302 commit d053e25
Showing 1 changed file with 21 additions and 18 deletions.
39 changes: 21 additions & 18 deletions docs/reference/searchable-snapshots/index.asciidoc
Original file line number Diff line number Diff line change
Expand Up @@ -303,30 +303,33 @@ Because {search-snap} indices are not regular indices, it is not possible to use
a <<snapshots-source-only-repository,source-only repository>> to take snapshots
of {search-snap} indices.

[discrete]
[[searchable-snapshots-reliability]]
=== Reliability of {search-snaps}

[WARNING]
.Reliability of {search-snaps}
====
The sole copy of the data in a {search-snap} index is the underlying snapshot,
stored in the repository. For example:
stored in the repository. If you remove this snapshot, the data will be
permanently lost. Although {es} may have cached some of the data onto local
storage for faster searches, this cached data is incomplete and cannot be used
for recovery if you remove the underlying snapshot. For example:
* You must not unregister a repository while any of the {search-snaps} it
contains are mounted in {es}.
* You must not unregister a repository while any of the searchable snapshots it
contains are mounted in {es}. You also must not delete a snapshot if any of its
indices are mounted as searchable snapshots.
* You must not delete a snapshot if any of its indices are mounted as
{search-snap} indices. The snapshot contains the sole full copy of your data. If
you delete it then the data cannot be recovered from elsewhere.
* If you mount indices from snapshots held in a repository to which a different
cluster has write access then you must make sure that the other cluster does not
delete these snapshots.

* If you delete a snapshot while it is mounted as a searchable snapshot then the
data is lost. Similarly, if the repository fails or corrupts the contents of the
snapshot then the data is lost.

* Although {es} may have cached the data onto local storage, these caches may be
incomplete and cannot be used to recover any data after a repository failure.
You must make sure that your repository is reliable and protects against
corruption of your data while it is at rest in the repository.
delete these snapshots. The snapshot contains the sole full copy of your data.
If you delete it then the data cannot be recovered from elsewhere.
* If the repository fails or corrupts the contents of the snapshot and you
cannot restore it to its previous healthy state then the data is permanently
lost.
+
The blob storage offered by all major public cloud providers typically offers
very good protection against data loss or corruption. If you manage your own
very good protection against failure or corruption. If you manage your own
repository storage then you are responsible for its reliability.
====

0 comments on commit d053e25

Please sign in to comment.