This is an earlier version of the OpenSearch documentation. For the latest version, see the current documentation. For information about OpenSearch version maintenance, see Release Schedule and Maintenance Policy.
Snapshot Management (SM) lets you automate taking snapshots. To use this feature, you need to install the Index Management (IM) Plugin. Snapshots store only incremental changes since the last snapshot. Thus, while taking an initial snapshot may be a heavy operation, subsequent snapshots have minimal overhead. To set up automatic snapshots, you have to create an SM policy with a desired SM schedule and configuration.
When you create an SM policy, its document ID is given the name
<policy_name>-sm-policy. Because of this, SM policies have to obey the following rules:
SM policies must have unique names.
You cannot update the policy name after its creation.
SM-created snapshots have names in the format
<policy_name>-<date>-<random number>. Two snapshots created by different policies at the same time always have different names because of the
<policy_name> prefix. To avoid name collisions within the same policy, each snapshot’s name contains a random string suffix.
Each policy has associated metadata that stores the policy status. Snapshot Management saves SM policies and metadata in the system index and reads them from the system index. Thus, Snapshot Management depends on the OpenSearch cluster’s indexing and searching functions. The policy’s metadata keeps information about the latest creation and deletion only. The metadata is read before running every scheduled job so that SM can continue execution from the previous job’s state. You can view the metadata using the explain API.
An SM schedule is a custom cron expression. It consists of two parts: a creation schedule and a deletion schedule. You must set up a creation schedule that specifies the frequency and timing of snapshot creation. Optionally, you can set up a separate schedule for deleting snapshots.
An SM configuration includes the indexes and repository for the snapshots and supports all parameters you can define when creating a snapshot using the API. Additionally, you can specify the format and time zone for the date used in the snapshot’s name.
One snapshot can contain as many indexes as there are in the cluster. We expect at most dozens of SM policies in one cluster, but a snapshot repository can safely scale to thousands of snapshots. However, to manage its metadata, a large repository requires more memory on the cluster manager node.
Snapshot Management depends on the Job Scheduler plugin to schedule a job that is run periodically. Each SM policy corresponds to one SM-scheduled job. The scheduled job is lightweight, so the burden of SM depends on the snapshot creation frequency and the burden of running the snapshot operation itself.
An SM policy does not support concurrent snapshot operations, since too many such operations may degrade the cluster. Snapshot operations (creation or deletion) are performed asynchronously. SM does not start a new operation until the previous asynchronous operation finishes.
We don’t recommend creating several SM policies with the same schedule and overlapping indexes in one cluster because it leads to concurrent snapshot creation on the same indexes and hinders performance.
We don’t recommend setting up the same repository for multiple SM policies with same schedule in different clusters, since it may cause a sudden spike of burden in this repository.
If a snapshot operation fails, it is retried a maximum of three times. The failure message is saved in
metadata.latest_execution and is overwritten when a subsequent snapshot operation starts. You can view the failure message using the explain API. When using OpenSearch Dashboards, you can view the failure message on the policy details page. Possible reasons for failure include red index status and shard reallocation.
The Security plugin has two built-in roles for Snapshot Management actions:
snapshot_management_read_access. For descriptions of each, see Predefined roles.
The following table lists the required permissions for each Snapshot Management API.
|Get policy||GET _plugins/_sm/policies |
|Create/update policy||POST _plugins/_sm/policies/ |
|Delete policy||DELETE _plugins/_sm/policies/ ||cluster:admin/opensearch/snapshot_management/policy/delete|
|Explain||GET _plugins/_sm/policies/ ||cluster:admin/opensearch/snapshot_management/policy/explain|
|Start||POST _plugins/_sm/policies/ ||cluster:admin/opensearch/snapshot_management/policy/start|
|Stop||POST _plugins/_sm/policies/ ||cluster:admin/opensearch/snapshot_management/policy/stop|
The following table lists all Snapshot Management API functions.
|Create policy||POST _plugins/_sm/policies/ ||Creates an SM policy.|
|Update policy||PUT _plugins/_sm/policies/ ||Modifies the |
|Get all policies||GET _plugins/_sm/policies||Returns all SM policies.|
|Get the policy ||GET _plugins/_sm/policies/ ||Returns the |
|Delete policy||DELETE _plugins/_sm/policies/ ||Deletes the |
|Explain||GET _plugins/_sm/policies/ ||Provides the enabled/disabled status and the metadata for all policies specified by |
|Start policy||POST _plugins/_sm/policies/ ||Starts the |
|Stop policy||POST _plugins/_sm/policies/ ||Stops the |