Snapshots

The snapshots panel manages snapshot repositories and the snapshots in them. Double-click Snapshots in the sidebar to open it. Repositories are listed on the left; pick one to see its snapshots.

Register a repository

1. Choose Register repository….
2. Enter a Name and pick the Type: Shared file system (fs) or Read-only URL (url).
3. For a file system repository, enter the Location (a path under path.repo). The path must be allowed by the nodes’ path.repo setting. For a URL repository, enter the URL.
4. Tick Read-only (another cluster writes to it) when this cluster should only read from it.
5. Choose Register….

Each repository in the list has Verify (it sends POST /_snapshot/<name>/_verify) and Unregister…. Unregistering leaves the repository’s files where they are.

Take a snapshot

1. Pick a repository and choose New snapshot….
2. Enter the Name (lower case).
3. In Indices (comma-separated, patterns allowed; empty for all), list what to include.
4. Tick Include the cluster state (templates, pipelines, persistent settings) if you want it.
5. Choose Create….

The snapshot list shows each snapshot’s state, indices, start time, duration and shards. While a snapshot is in progress, the list refreshes every 2 seconds.

Restore a snapshot

1. Choose Restore… on a snapshot.
2. In Indices (comma-separated), keep or change the indices to restore. The field starts with every index in the snapshot whose name does not start with a dot.
3. Set Rename pattern (regular expression; empty keeps names) and Replacement ($1 for the first group). They start as (.+) and restored-$1, so orders comes back as restored-orders.
4. Tick Restore their aliases too if you want them.
5. Check the preview, which lists each index with the name it will get, and choose Restore….

Restores and deletes always ask

A restore can replace closed indices of the same name, so it always shows the request and asks. Deleting a snapshot removes its data from the repository and also always asks.

Related

• Cluster
• Index operations