Skip to content

Commit a3b851e

Browse files
authored
[DOCS] Move snapshot-restore out of modules. (elastic#49618)
* [DOCS] Move snapshot-restore docs out of modules. * [DOCS] Incorporates comments from @jrodewig. * [DOCS] Fix snippet tests
1 parent 561216b commit a3b851e

15 files changed

+906
-814
lines changed

docs/reference/glossary.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -223,7 +223,7 @@ during the following processes:
223223
This type of recovery is called a *local store recovery*.
224224
* <<glossary-replica-shard,Primary shard replication>>.
225225
* Relocation of a shard to a different node in the same cluster.
226-
* {ref}/modules-snapshots.html#restore-snapshot[Snapshot restoration].
226+
* {ref}/snapshots-restore-snapshot.html[Snapshot restoration].
227227
// end::recovery-triggers[]
228228
// end::recovery-def[]
229229
--

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@
66

77
To back up your cluster's data, you can use the <<modules-snapshots,snapshot API>>.
88

9-
include::{es-repo-dir}/modules/snapshots.asciidoc[tag=snapshot-intro]
9+
include::../snapshot-restore/index.asciidoc[tag=snapshot-intro]
1010

1111
[TIP]
1212
====

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,7 @@
11
[[backup-cluster]]
22
== Back up a cluster
33

4-
include::{es-repo-dir}/modules/snapshots.asciidoc[tag=backup-warning]
4+
include::../snapshot-restore/index.asciidoc[tag=backup-warning]
55

66
To have a complete backup for your cluster:
77

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

+1-1
Original file line numberDiff line numberDiff line change
@@ -4,7 +4,7 @@
44
<titleabbrev>Restore the data</titleabbrev>
55
++++
66

7-
include::{es-repo-dir}/modules/snapshots.asciidoc[tag=restore-intro]
7+
include::../snapshot-restore/index.asciidoc[tag=restore-intro]
88

99
[TIP]
1010
====

docs/reference/ilm/getting-started-slm.asciidoc

+2-2
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@
55

66
Let's get started with snapshot lifecycle management (SLM) by working through a
77
hands-on scenario. The goal of this example is to automatically back up {es}
8-
indices using the <<modules-snapshots,snapshots>> every day at a particular
8+
indices using the <<snapshot-restore,snapshots>> every day at a particular
99
time. Once these snapshots have been created, they are kept for a configured
1010
amount of time and then deleted per a configured retention policy.
1111

@@ -59,7 +59,7 @@ POST /_security/role/slm-read-only
5959
=== Setting up a repository
6060

6161
Before we can set up an SLM policy, we'll need to set up a
62-
<<snapshots-repositories,snapshot repository>> where the snapshots will be
62+
snapshot repository where the snapshots will be
6363
stored. Repositories can use {plugins}/repository.html[many different backends],
6464
including cloud storage providers. You'll probably want to use one of these in
6565
production, but for this example we'll use a shared file system repository:

docs/reference/index.asciidoc

+2
Original file line numberDiff line numberDiff line change
@@ -50,6 +50,8 @@ include::data-rollup-transform.asciidoc[]
5050

5151
include::high-availability.asciidoc[]
5252

53+
include::snapshot-restore/index.asciidoc[]
54+
5355
include::{xes-repo-dir}/security/index.asciidoc[]
5456

5557
include::{xes-repo-dir}/watcher/index.asciidoc[]

docs/reference/indices/recovery.asciidoc

+1-1
Original file line numberDiff line numberDiff line change
@@ -77,7 +77,7 @@ This type of recovery is called a local store recovery.
7777

7878
`SNAPSHOT`::
7979
The recovery is related to
80-
a <<restore-snapshot,snapshot restoration>>.
80+
a <<snapshots-restore-snapshot,snapshot restoration>>.
8181

8282
`REPLICA`::
8383
The recovery is related to

docs/reference/modules.asciidoc

-2
Original file line numberDiff line numberDiff line change
@@ -91,8 +91,6 @@ include::modules/node.asciidoc[]
9191

9292
include::modules/plugins.asciidoc[]
9393

94-
include::modules/snapshots.asciidoc[]
95-
9694
include::modules/threadpool.asciidoc[]
9795

9896
include::modules/transport.asciidoc[]

0 commit comments

Comments
 (0)