github-mirrors/elasticsearch
1
0
Fork 0
mirror of https://github.com/elastic/elasticsearch.git synced 2025-04-24 15:17:30 -04:00
Code Issues Projects Releases Packages Wiki Activity

[DOCS] Update snapshot/restore and SLM docs for data streams (#58513)

Browse source 
Updates the existing snapshot/restore and SLM docs to make them
aware of data streams.
This commit is contained in:
James Rodewig 2020-07-13 08:34:42 -04:00 • committed by GitHub
parent 82740f65e4
commit 786104eef7
No known key found for this signature in database
GPG key ID: 4AEE18F83AFDEB23
11 changed files with 159 additions and 83 deletions
Download patch file Download diff file Expand all files Collapse all files

6
docs/reference/slm/apis/index.asciidoc
View file

@ -4,12 +4,12 @@
== Manage the snapshot lifecycle
You can set up snapshot lifecycle policies to automate the timing, frequency, and retention of snapshots.
Snapshot policies can apply to multiple indices.
Snapshot policies can apply to multiple data streams and indices.
The snapshot lifecycle management (SLM) <<snapshot-lifecycle-management-api, CRUD APIs>> provide
the building blocks for the snapshot policy features that are part of the Management application in {kib}.
The Snapshot and Restore UI makes it easy to set up policies, register snapshot repositories,
view and manage snapshots, and restore indices.
The Snapshot and Restore UI makes it easy to set up policies, register snapshot repositories,
view and manage snapshots, and restore data streams or indices.
You can stop and restart SLM to temporarily pause automatic backups while performing
upgrades or other maintenance.

13
docs/reference/slm/apis/slm-put.asciidoc
View file

@ -56,7 +56,7 @@ Configuration for each snapshot created by the policy.
====
`ignore_unavailable`::
(Optional, boolean)
If `true`, missing indices do *not* cause snapshot creation to fail and return
If `true`, missing data streams or indices do *not* cause snapshot creation to fail and return
an error. Defaults to `false`.
`include_global_state`::
@ -65,14 +65,15 @@ If `true`, cluster states are included in snapshots. Defaults to `false`.
`indices`::
(Optional, array of strings)
Array of index names or wildcard pattern of index names included in snapshots. It
supports <<date-math-index-names,date math>> expressions.
Array of data streams and indices to include in snapshots.
<<date-math-index-names,Date math>> and wildcard (`*`) expressions are
supported.
====
`name`::
(Required, string)
Name automatically assigned to each snapshot created by the policy. This value
supports the same <<date-math-index-names,date math>> supported in index names.
Name automatically assigned to each snapshot created by the policy.
<<date-math-index-names,Date math>> is supported.
To prevent conflicting snapshot names, a UUID is automatically appended to each
snapshot name.
@ -141,7 +142,7 @@ PUT /_slm/policy/daily-snapshots
<2> The name each snapshot should be given
<3> Which repository to take the snapshot in
<4> Any extra snapshot configuration
<5> Which indices the snapshot should contain
<5> Data streams and indices the snapshot should contain
<6> Optional retention configuration
<7> Keep snapshots for 30 days
<8> Always keep at least 5 successful snapshots, even if they're more than 30 days old

2
docs/reference/slm/apis/slm-stop.asciidoc
View file

@ -27,7 +27,7 @@ cluster privilege to use this API. For more information, see
Halts all {slm} ({slm-init}) operations and stops the {slm-init} plugin.
This is useful when you are performing maintenance on a cluster and need to
prevent {slm-init} from performing any actions on your indices.
prevent {slm-init} from performing any actions on your data streams or indices.
Stopping {slm-init} does not stop any snapshots that are in progress.
You can manually trigger snapshots with the <<slm-api-execute-lifecycle>> even if {slm-init} is stopped.