Was this page helpful?
Caution
You're viewing documentation for an unstable version of Scylla Manager. Switch to the latest stable version.
Using sctool backup command, you can schedule a backup of a managed cluster. Backups and repairs are scheduled in the same manner, you can start, stop, resume, and track task progress on demand.
Note
If you are using ScyllaDB Manager deployed by ScyllaDB Operator, see dedicated ScyllaDB Operator documentation.
The following backup storage engines are supported:
Amazon S3,
S3 compatible API storage providers such as Ceph or MinIO,
Google Cloud Storage.
Glob patterns to select keyspaces or tables to back up
Deduplication of SSTables
Retention of old data
Throttling of upload speed
Configurable upload destination per datacenter
Pause and resume
--keyspace/--dc flags allow for specifying glob pattern for selecting tables/data centers to back up.--keyspace flag, but it is not replicated in specified data centers (--dc flag), the table won’t be backed up.The backup procedure consists of multiple steps executed sequentially.
Snapshot - Take a snapshot of data on each node (according to backup configuration settings).
Note that ScyllaDB Manager halts tablets migration for the duration of this step.
Schema - Upload the schema in CQL text format to the backup storage destination, this requires that you added the cluster with CQL username and password. If you didn’t you can update the cluster using sctool at any point in time.
Starting from ScyllaDB 6.0 and 2024.2 (and compatible ScyllaDB Manager 3.3), these CQL files are necessary for schema restoration (sctool restore –restore-schema).
Upload - Upload the snapshot to the backup storage destination.
Manifest - Upload the manifest file containing metadata about the backup.
Purge - If the retention threshold has been reached, remove the oldest backup from the storage location.
You need to create a backup location for example an S3 bucket. We recommend creating it in the same region as Scylla nodes to minimize cross region data transfer costs. In multi-dc deployments you should create a bucket per datacenter, each located in the datacenter’s region.
Details may differ depending on the storage engine, please consult:
Backups may require a lot of storage space. They are purged according to the retention defined on the backup task.
Sctool can be used to remove snapshots of clusters that are no longer managed by Scylla Manager. The removal process is performed through the Scylla Manager Agent installed on Scylla nodes.
However, it’s recommended to delete the snapshots from the storage before removing the cluster from Scylla Manager. Otherwise, you will need to add the cluster again, list the snapshots in the given location, and remove them using the new cluster as the coordinator. Another option is to purge them manually. If you want to remove the snapshots manually, please refer to the backup specification and remove them accordingly.
Was this page helpful?