Skip to content

Clarify snapshot docs #1782

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

Open
wants to merge 2 commits into
base: main
Choose a base branch
from
Open
Show file tree
Hide file tree
Changes from all commits
Commits
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
24 changes: 21 additions & 3 deletions deploy-manage/tools/snapshot-and-restore/create-snapshots.md
Original file line number Diff line number Diff line change
Expand Up @@ -11,9 +11,9 @@
- id: elasticsearch
---

# Create snapshots [snapshots-take-snapshot]
# Create, monitor and delete snapshots [snapshots-take-snapshot]

This guide shows you how to take snapshots of a running cluster. You can later [restore a snapshot](restore-snapshot.md) to recover or transfer its data.
This guide shows you how to create, monitor and delete snapshots of a running cluster. You can later [restore a snapshot](restore-snapshot.md) to recover or transfer its data.

In this guide, you’ll learn how to:

Expand Down Expand Up @@ -187,6 +187,20 @@

A snapshot repository can safely scale to thousands of snapshots. However, to manage its metadata, a large repository requires more memory on the master node. Retention rules ensure a repository’s metadata doesn’t grow to a size that could destabilize the master node.

### Update an existing {{slm-init}} policy [update-slm-policy]

You can update an existing {{slm-init}} policy after it's created. To manage {{slm-init}} in {{kib}}, go to the main menu and click **Stack Management** > **Snapshot and Restore** > **Policies**, click the pencil icon, and make the desired change.

For example, you can change the schedule, or snapshot retention related configurations.


![change schedule](/manage-data/images/elasticsearch-reference-change-slm-schedule.png)

Check notice on line 197 in deploy-manage/tools/snapshot-and-restore/create-snapshots.md

View workflow job for this annotation

GitHub Actions / preview / build

Image '/manage-data/images/elasticsearch-reference-change-slm-schedule.png' is referenced out of table of contents scope '/github/workspace/deploy-manage'.

![change snapshot retention](/manage-data/images/elasticsearch-reference-change-slm-snapshot-retention.png)

Check notice on line 199 in deploy-manage/tools/snapshot-and-restore/create-snapshots.md

View workflow job for this annotation

GitHub Actions / preview / build

Image '/manage-data/images/elasticsearch-reference-change-slm-snapshot-retention.png' is referenced out of table of contents scope '/github/workspace/deploy-manage'.


You can also update an {{slm-init}} policy using the [{{slm-init}} APIs](https://www.elastic.co/docs/api/doc/elasticsearch/group/endpoint-slm), as described in [Create an {{slm-init}} policy](#create-slm-policy).


## Manually create a snapshot [manually-create-snapshot]

Expand Down Expand Up @@ -242,7 +256,11 @@

## Delete or cancel a snapshot [delete-snapshot]

To delete a snapshot in {{kib}}, go to the **Snapshots** page and click the trash icon under the **Actions** column. You can also use the [delete snapshot API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete).
To delete a snapshot in {{kib}}, go to the **Snapshots** page and click the trash icon under the **Actions** column. To delete multiple snapshots at once, select the snapshots first, and then click `Delete snapshots` button.

![delete snapshot](/manage-data/images/elasticsearch-reference-delete-snapshots.png)

Check notice on line 261 in deploy-manage/tools/snapshot-and-restore/create-snapshots.md

View workflow job for this annotation

GitHub Actions / preview / build

Image '/manage-data/images/elasticsearch-reference-delete-snapshots.png' is referenced out of table of contents scope '/github/workspace/deploy-manage'.

You can also use the [delete snapshot API](https://www.elastic.co/docs/api/doc/elasticsearch/operation/operation-snapshot-delete).

```console
DELETE _snapshot/my_repository/my_snapshot_2099.05.06
Expand Down
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading