RedisShake is an open-source tool for migrating data online or offline (by importing backup files) between Redis Clusters. When you need to migrate your Redis cluster deployed on another cloud, you can choose offline migration if online migration is not possible.

Migrating Data Online

You can migrate data online from a self-hosted Redis Cluster to a DCS Redis instance as long as the two clusters are directly connected or connected through a transit server.

There are multiple modes of online migration. If the SYNC and PSYNC commands are not disabled, it is recommended to use the sync_reader mode. Otherwise, use the scan_reader mode. For details, see the official RedisShake community.

1. Creating a Redis instance on the DCS console.

Note that the capacity of the newly created Redis instance cannot be less than the actual capacity used by the source Redis instance.

2. Preparing a Cloud Server and Installing RedisShake.

RedisShake can access both the source and the destination DCS instances and is bound to an EIP.

3. Obtaining the IP addresses of the source and destination clusters.

If the source instance or target instance is in a proxy mode architecture, just obtain the proxy IP addresses.

4. Editing the RedisShake configuration file.

Edit the shake.toml file by providing the following information about the source and destination instance and the migration mode:

[sync_reader]

cluster = false            # set to true if source is a redis cluster

address = "127.0.0.1:6379" # when cluster is true, set address to one of the cluster node

username = ""              # keep empty if not using ACL

password = ""              # keep empty if no authentication is required

tls = false

sync_rdb = true # set to false if you don't want to sync rdb

sync_aof = true # set to false if you don't want to sync aof

[scan_reader]

cluster = false            # set to true if source is a redis cluster

address = "127.0.0.1:6379" # when cluster is true, set address to one of the cluster node

username = ""              # keep empty if not using ACL

password = ""              # keep empty if no authentication is required

ksn = false                # set to true to enabled Redis keyspace notifications (KSN) subscription

tls = false

dbs = []                   # set you want to scan dbs such as [1,5,7], if you don't want to scan all

[redis_writer]

cluster = false            # set to true if target is a redis cluster

address = "127.0.0.1:6380" # when cluster is true, set address to one of the cluster node

5. Synchronizing data online.

Use the following command to synchronize data between the source Redis cluster and the destination Redis cluster:

./redis-shake shake.toml

When the following information appears in the execution log, it means that the full synchronization has been completed and incremental synchronization begins.

syncing aof

When the following information appears in the execution log, it means that no new data is incremented. You can stop the incremental synchronization by pressing Ctrl+C.

read_count=[0], read_ops=[0.00], write_count=[0], write_ops=[0.00]

RedisShake online migration diagram

6. Verifying the migration.

After data synchronization, access the DCS Redis instance using Redis-cli. Run the dbsize command to query the number of keys to confirm that data has been fully imported.

If the data has not been fully imported, run the flushall or flushdb command to clear the cached data in the instance, and synchronize data again.

7. Clearing the RedisShake configuration file.

Offline Migration (Importing Backup Files)

Compared with online migration, offline migration is suitable for scenarios where the source Redis and the destitution Redis cannot be connected.

1. Creating a Redis Instance on the DCS Console.

Note that the capacity of the newly created Redis instance cannot be less than the actual capacity used by the source Redis instance.

2. Preparing a Cloud Server and Installing RedisShake.

RedisShake can access both the source and the destination DCS instances and is bound to an EIP.

3. Exporting the RDB File.

Use the following command to export the RDB file:

./redis-cli -h {redis_address} -p {redis_port} -a {password} --rdb {output.rdb}

After executing the command, Transfer finished with success. is displayed, indicating that the file has been successfully exported.

4. Uploading the exported RDB file (or files) to the **** cloud server.

5. Editing the RedisShake Configuration File.

Edit the shake.toml file by providing the following information about the source and destination instance and the migration mode:

[rdb_reader]

filepath = "/tmp/dump.rdb"

[redis_writer]

cluster = false            # set to true if target is a redis cluster

address = "127.0.0.1:6380" # when cluster is true, set address to one of the cluster node

username = ""              # keep empty if not using ACL

password = ""              # keep empty if no authentication is required

tls = false

6. Synchronizing Data Online.

Use the following command to synchronize data between the source Redis cluster and the destination Redis cluster:

./redis-shake shake.toml

When the following information appears in the execution log, it means that the synchronization is completed:

all done

RedisShake online migration diagram

7. Verifying the Migration.

After data synchronization, access the DCS Redis instance using redis-cli. Run the dbsize command to query the number of keys to confirm that data has been fully imported.

If the data has not been fully imported, run the flushall or flushdb command to clear the cached data in the instance, and synchronize data again.

8. Clearing the RedisShake Configuration File.

DCS Redis Help Documentation

Self-Hosted Redis Cluster Migration with RedisShake