Restoring snapshots by enabling snapshots repository

You can restore snapshots of your OpenSearch data by enabling the OpenSearch snapshot repository.

About this task

Follow this procedure to restore snapshots of your OpenSearch data by enabling the OpenSearch snapshot repository.

Procedure

  1. Check the OpenSearch CR instance by retrieving the name of the instance.
    oc get ElasticsearchCluster -n <namespace>
  2. Edit the OpenSearch CR and update parameter snapshotRepo.snapshotActivity value is restore.
    oc edit ElasticsearchCluster opensearch -n <namespace>

Example

snapshotRepo:
  enabled: true
  seLinuxOptionsLevels: 's0:c26,c20'
  storageClass: rook-cephfs
  size: 10Gi
  snapshotActivity: restore
Table 1. Parameter description
Parameter Description
snapshotRepo Provide an elasticsearch snapshot repo via a shared volume
snapshotRepo.enabled

Enable/disable the Elasticsearch snapshot repo. Changing this value may require a restart/rebuild of the Elasticsearch cluster. If disabled it must not be deployed to a namespace which is backed up by Velero CSI snapshots.

snapshotRepo.storageClass Storage class to use for the shared volume used by the snapshot repo
snapshotRepo.size Size of the snapshot volume
snapshotRepo.snapshotActivity Indicate a backup or restore activity should be performed. Between multiple backup or restore activities the values should be set to none to reset.
snapshotRepo.seLinuxOptionsLevels User, role, type, and an optional field level in the format user:role:type:level for SELinux
Note:

To perform backup and restore snapshotRepo.enabled must be true in the CR section. This increases /workdir/snapshot_storage, which helps you create a repository for backup and restoration

For snapshotRepo.snapshotActivity, the available options are backup, restore and none. The backup option is configured to take snapshots daily, while the restore option is set to restore the most recent snapshot.

If customers want to perform backup and restore operations on their own, we suggest setting snapshotRepo.snapshotActivity to none.