Skip to content

Commit 0885cda

Browse files
authored
[DOCS] Overhaul snapshot and restore docs (#79081) (#80732)
Makes several changes to consolidate snapshot and backup-related docs. Highlights: * Adds info about supported ESS snapshot repository types * Adds docs for Kibana's Snapshot and Restore feature * Combines tutorial pages related to taking and managing snapshots * Consolidates explanations of the snapshot process * Incorporates SLM into the snapshot tutorial * Removes duplicate "back up a cluster" pages
1 parent 049da6c commit 0885cda

37 files changed

+1209
-1463
lines changed

docs/Versions.asciidoc

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -68,3 +68,7 @@ ifeval::["{source_branch}"=="7.x"]
6868
:apm-server-ref-v: {apm-server-ref-m}
6969
:apm-overview-ref-v: {apm-overview-ref-m}
7070
endif::[]
71+
72+
// Max recommended snapshots in a snapshot repo.
73+
// Used in the snapshot/restore docs.
74+
:max-snapshot-count: 200

docs/plugins/repository-s3.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -215,9 +215,9 @@ include a port. For example, the endpoint may be `172.17.0.2` or
215215
`172.17.0.2:9000`. You may also need to set `s3.client.CLIENT_NAME.protocol` to
216216
`http` if the endpoint does not support HTTPS.
217217

218-
https://minio.io[Minio] is an example of a storage system that provides an
218+
https://minio.io[MinIO] is an example of a storage system that provides an
219219
S3-compatible API. The `repository-s3` plugin allows {es} to work with
220-
Minio-backed repositories as well as repositories stored on AWS S3. Other
220+
MinIO-backed repositories as well as repositories stored on AWS S3. Other
221221
S3-compatible storage systems may also work with {es}, but these are not
222222
covered by the {es} test suite.
223223

docs/reference/high-availability.asciidoc

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -21,12 +21,10 @@ to achieve high availability despite failures.
2121
to serve searches from nearby clients.
2222

2323
* The last line of defence against data loss is to take
24-
<<backup-cluster,regular snapshots>> of your cluster so that you can restore
25-
a completely fresh copy of it elsewhere if needed.
24+
<<snapshots-take-snapshot,regular snapshots>> of your cluster so that you can
25+
restore a completely fresh copy of it elsewhere if needed.
2626
--
2727

2828
include::high-availability/cluster-design.asciidoc[]
2929

30-
include::high-availability/backup-cluster.asciidoc[]
31-
3230
include::ccr/index.asciidoc[]

docs/reference/high-availability/backup-and-restore-security-config.asciidoc

Lines changed: 0 additions & 163 deletions
This file was deleted.

docs/reference/high-availability/backup-cluster-config.asciidoc

Lines changed: 0 additions & 60 deletions
This file was deleted.

docs/reference/high-availability/backup-cluster-data.asciidoc

Lines changed: 0 additions & 27 deletions
This file was deleted.

docs/reference/high-availability/backup-cluster.asciidoc

Lines changed: 0 additions & 18 deletions
This file was deleted.

docs/reference/ilm/index.asciidoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -20,8 +20,8 @@ default policies are configured automatically.
2020
image:images/ilm/index-lifecycle-policies.png[]
2121

2222
[TIP]
23-
To automatically back up your indices and manage snapshots,
24-
use <<getting-started-snapshot-lifecycle-management,snapshot lifecycle policies>>.
23+
To automatically back up your indices and manage snapshots, use
24+
<<automate-snapshots-slm,snapshot lifecycle policies>>.
2525

2626
* <<overview-index-lifecycle-management>>
2727
* <<ilm-concepts>>

docs/reference/ilm/start-stop.asciidoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -9,7 +9,7 @@ You can stop {ilm} to suspend management operations for all indices.
99
For example, you might stop {ilm} when performing scheduled maintenance or making
1010
changes to the cluster that could impact the execution of {ilm-init} actions.
1111

12-
IMPORTANT: When you stop {ilm-init}, <<snapshot-lifecycle-management, {slm-init}>>
12+
IMPORTANT: When you stop {ilm-init}, <<automate-snapshots-slm,{slm-init}>>
1313
operations are also suspended.
1414
No snapshots will be taken as scheduled until you restart {ilm-init}.
1515
In-progress snapshots are not affected.

0 commit comments

Comments
 (0)