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.

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

[DOCS] Overhaul snapshot and restore docs #79081

Merged
merged 45 commits into from
Nov 15, 2021
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
45 commits
Select commit Hold shift + click to select a range
c374747
[DOCS] Overhaul snapshot and restore docs
jrodewig Oct 11, 2021
33453b8
Edits
jrodewig Oct 13, 2021
bcf1c43
Better anchors. Fix typos. Fix ex policy.
jrodewig Oct 14, 2021
d3c234a
Clarify shard alloc. Remove dupe content from API docs.
jrodewig Oct 14, 2021
6b6c807
Clarify shard alloc
jrodewig Oct 14, 2021
5c0e47f
fix open index ref
jrodewig Oct 15, 2021
86b51bc
Note SLM UUID in snapshot name
jrodewig Oct 15, 2021
6361e6e
Re-add SLM security section
jrodewig Oct 16, 2021
2d57988
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Oct 21, 2021
f5a9b09
Move xref
jrodewig Oct 21, 2021
1c16f74
Add feature state info
jrodewig Oct 25, 2021
05a7a13
Document multiple SLM policies for longer term snapshots
jrodewig Oct 25, 2021
d2efebc
fix snippet test
jrodewig Oct 26, 2021
2761305
fix cron syntax + typo
jrodewig Oct 26, 2021
28728b0
tighten wording. fix typos.
jrodewig Oct 26, 2021
d5bdc22
edits
jrodewig Oct 26, 2021
9363d7b
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Oct 26, 2021
aa3c462
Address review feedback
jrodewig Oct 26, 2021
33d0241
reword
jrodewig Oct 26, 2021
2629a4f
reword
jrodewig Oct 26, 2021
1f70925
Fix typo
jrodewig Oct 26, 2021
f632bab
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Oct 26, 2021
d889217
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Oct 27, 2021
186ac7a
Add feature state xrefs
jrodewig Oct 27, 2021
5007ff7
Update docs/reference/snapshot-restore/index.asciidoc
jrodewig Oct 29, 2021
1528882
Apply suggestions from code review
jrodewig Oct 29, 2021
7cbce99
Tweak retention schedule
jrodewig Oct 29, 2021
127131f
Update docs/reference/snapshot-restore/register-repository.asciidoc
jrodewig Oct 29, 2021
178c3ec
Note snapshot index compatability
jrodewig Oct 29, 2021
d519579
minor wording tweaks
jrodewig Oct 29, 2021
52f5178
fix minio capitalization
jrodewig Oct 29, 2021
b5a7d5c
Merge branch 'master' into docs__snapshot-restore
elasticmachine Oct 29, 2021
e62342e
clarify
jrodewig Oct 29, 2021
93625c4
re-add word
jrodewig Oct 29, 2021
6bb69bf
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Nov 3, 2021
0cedf34
Improve index template prereq for data streams
jrodewig Nov 5, 2021
b4d745e
Add ESS trial link
jrodewig Nov 5, 2021
cdefa2a
Add more info about aliases to snapshot contents
jrodewig Nov 5, 2021
521eec9
Add more info about source-only repo
jrodewig Nov 5, 2021
76bdf8a
whitespace
jrodewig Nov 5, 2021
b0172d8
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Nov 5, 2021
a69b492
Fix up get slm policy tests to prevent test failures
jrodewig Nov 5, 2021
e74cab8
reword
jrodewig Nov 6, 2021
5c55b68
Merge remote-tracking branch 'upstream/master' into docs__snapshot-re…
jrodewig Nov 6, 2021
9f9a0c3
Merge branch 'master' into docs__snapshot-restore
elasticmachine 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
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
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
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[]

This file was deleted.

60 changes: 0 additions & 60 deletions docs/reference/high-availability/backup-cluster-config.asciidoc

This file was deleted.

27 changes: 0 additions & 27 deletions docs/reference/high-availability/backup-cluster-data.asciidoc

This file was deleted.

18 changes: 0 additions & 18 deletions docs/reference/high-availability/backup-cluster.asciidoc

This file was deleted.

4 changes: 2 additions & 2 deletions docs/reference/ilm/index.asciidoc
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
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