Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[7.16] [DOCS] Overhaul snapshot and restore docs (#79081) #80733

Merged
merged 2 commits into from
Nov 15, 2021
Merged

[7.16] [DOCS] Overhaul snapshot and restore docs (#79081) #80733

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
2 commits
Select commit Hold shift + click to select a range
3e3cb3a
[DOCS] Overhaul snapshot and restore docs (#79081)
jrodewig Nov 15, 2021
eeae100
update date math xref
jrodewig Nov 15, 2021
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
4 changes: 4 additions & 0 deletions docs/Versions.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -68,3 +68,7 @@ ifeval::["{source_branch}"=="7.x"]
:apm-server-ref-v: {apm-server-ref-m}
:apm-overview-ref-v: {apm-overview-ref-m}
endif::[]

// Max recommended snapshots in a snapshot repo.
// Used in the snapshot/restore docs.
:max-snapshot-count: 200
4 changes: 2 additions & 2 deletions docs/plugins/repository-s3.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -215,9 +215,9 @@ include a port. For example, the endpoint may be `172.17.0.2` or
`172.17.0.2:9000`. You may also need to set `s3.client.CLIENT_NAME.protocol` to
`http` if the endpoint does not support HTTPS.

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

Expand Down
6 changes: 2 additions & 4 deletions docs/reference/high-availability.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -21,12 +21,10 @@ to achieve high availability despite failures.
to serve searches from nearby clients.

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

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

include::high-availability/backup-cluster.asciidoc[]

include::ccr/index.asciidoc[]
163 changes: 0 additions & 163 deletions docs/reference/high-availability/backup-and-restore-security-config.asciidoc
View file
Open in desktop

This file was deleted.

60 changes: 0 additions & 60 deletions docs/reference/high-availability/backup-cluster-config.asciidoc
View file
Open in desktop

This file was deleted.

27 changes: 0 additions & 27 deletions docs/reference/high-availability/backup-cluster-data.asciidoc
View file
Open in desktop

This file was deleted.

18 changes: 0 additions & 18 deletions docs/reference/high-availability/backup-cluster.asciidoc
View file
Open in desktop

This file was deleted.

4 changes: 2 additions & 2 deletions docs/reference/ilm/index.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -20,8 +20,8 @@ default policies are configured automatically.
image:images/ilm/index-lifecycle-policies.png[]

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

* <<overview-index-lifecycle-management>>
* <<ilm-concepts>>
Expand Down
2 changes: 1 addition & 1 deletion docs/reference/ilm/start-stop.asciidoc
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -9,7 +9,7 @@ You can stop {ilm} to suspend management operations for all indices.
For example, you might stop {ilm} when performing scheduled maintenance or making
changes to the cluster that could impact the execution of {ilm-init} actions.

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