Skip to content

Commit cf39d5a

Browse files
committed
feat(backup): add doc for cluster backups
Signed-off-by: Abhradeep Chakraborty <abhradeep@dragonflydb.io>
1 parent 26ac37e commit cf39d5a

1 file changed

Lines changed: 22 additions & 0 deletions

File tree

docs/cloud/backups.md

Lines changed: 22 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -21,6 +21,9 @@ from a remote storage system is also supported.
2121
Existing backups in your Dragonfly Cloud account can be [restored to an active data store](#restoring-from-backup)
2222
at any time.
2323

24+
For clustered (multi-shard) data stores, please review the [cluster backup limitations](#cluster-datastore-backups)
25+
before restoring.
26+
2427
## Manual On-Demand Backups
2528

2629
To create a manual on-demand backup, follow the steps below:
@@ -63,6 +66,25 @@ To restore a backup in an existing data store, follow the steps below, **with ca
6366
- Make **100% sure you select the correct backup** from the dropdown.
6467
- Click **Restore**.
6568

69+
## Cluster Datastore Backups
70+
71+
Dragonfly Cloud supports backups for clustered (multi-shard) data stores. A cluster backup captures
72+
the full dataset distributed across all shards at the point in time the backup was taken.
73+
74+
### Limitations
75+
76+
- **Shard count must match on restore**: The target data store must have the same number of shards
77+
as the data store at the time the backup was created. Restoring a cluster backup to a data store
78+
with a different shard count is not supported.
79+
- **Shard distribution must be identical**: Data is partitioned across shards by hash slot ranges.
80+
Because each shard's backup encodes data bound to a specific slot range, the slot layout of the
81+
target data store must exactly match the original. A mismatch will result in a restore failure.
82+
- **Cross-tier restore is not supported**: A backup taken from a clustered data store cannot be
83+
restored to a single-shard (non-clustered) data store, and vice versa.
84+
85+
***CAUTION: Before initiating a restore, verify that the target data store's shard count and
86+
configuration match the data store that the backup was originally taken from.***
87+
6688
## Viewing and Deleting Backups
6789

6890
- You can view all backups under the [Account > Backups](https://dragonflydb.cloud/account/backups) tab.

0 commit comments

Comments
 (0)