You can manually export your data from a specific Redis Enterprise Software (RS) database at any time. You can also schedule backups of your databases to make sure you always have valid backups. The backup process can be scheduled for every 1, 4, 12 or 24 hours from the time that you save the backup configuration.

You can schedule backups to these locations:

  • FTP server
  • SFTP server
  • Amazon S3
  • Local mount point
  • OpenStack Swift (Object Storage)
  • Azure Blob Storage
  • Google Cloud Storage

The backup process creates compressed (.gz) RDB files that you can import into a database. If you backup a database configured for database clustering, RS copies a backup file for each shard to the specified backup location.

Note -
  • Make sure that you have enough space available in your storage location. If there is not enough space in the backup location, the backup fails.
  • The backup configuration only applies to the node it is configured on.

Scheduling periodic backups

To schedule periodic backups for a database:

  1. In databases, click on the database that you want to configure backups for.
  2. In configuration, select Periodic backup.
  3. Select an interval for the backups to run either every 1, 4, 12 or 24 hours.
  4. Select one of the available storage types.
  5. Enter the details for the selected storage type.
  6. To save the database configuration, click Update.

FTP server

Before you choose to backup to an FTP server, make sure that:

  • The RS cluster has network connectivity to the FTP server.
  • The user that you specify in the FTP server location has read and write priviledges.

To backup to an FTP server, enter the FTP server location in the format:

ftp://user:password@host<:custom_port>/path/

For example: ftp://username:password@10.1.1.1/home/backups/

SFTP server

Before you choose to backup to an SFTP server, make sure that:

  • The RS cluster has network connectivity to the SFTP server.
  • The user that you specify in the SFTP server location has read and write priviledges.
  • The RS server and SFTP server have the correct TLS certificates. You can select either:
    • Use the cluster auto generated key - Go to settings and copy the Cluster SSH Public Key to the SFTP server.
    • Use a custom key - Generate a TLS key pair for the SFTP server, copy the private key to the SSH Private Key box, and copy the public key to the location required by the SFTP server.

To backup to an SFTP server, enter the SFTP server location in the format:

sftp://user:password@host:<:custom_port>/path/

For example: sftp://username:password@10.1.1.1/home/backups/

AWS S3

Before you choose to backup to Amazon AWS S3, make sure that you have:

  • Storage location path in the format: s3://bucketname/path/
  • Access key ID
  • Secret access key

You can also connect to a storage service that uses the S3 protocol but is not hosted by Amazon AWS. The storage service must have a valid SSL certificate. To connect to an S3-compatible storage location, run: rladmin cluster config s3_url <url>

Local mount point

Before you choose to backup to a local mount point, make sure that:

  • The node has network connectivity to the destination server of the mount point.
  • The redislabs:redislabs user has read and write priviledges on the local mount point and on the destination server.
  • The backup location has enough disk space for your backup files. The backup files are saved with filenames that include the timestamp so that backup files are not overwritten.

To backup to a local mount point for a node:

  1. On each node in the cluster, create the mount point:

    1. Connect to the terminal of the RS server that the node is running on.

    2. Mount the remote storage to a local mount point.

      For example:

      sudo mount -t nfs 192.168.10.204:/DataVolume/Public /mnt/Public
      
  2. In the path for the backup location, enter the mount point.

    For example: /mnt/Public

OpenStack Swift

Note -
Support for OpenStack Object Storage (“Swift”) for backup, import and export location ends on November 30, 2020.

Before you choose to backup to OpenStack Swift, make sure that you have:

  • Storage URL in the format: https://<openstack_url>/v1
  • Container
  • Prefix (Optional)
  • User
  • Key

Azure Blob Storage

Before you choose to backup to Azure Blob Storage, make sure that you have:

  • Storage location path in the format: /container_name/[path/]/
  • Account name
  • Account key

Google Cloud Storage

Before you choose to backup to Google Cloud Storage, make sure that you have:

  • Storage location path in the format: /bucket_name/[path/]/
  • Client ID
  • Client email
  • Private key ID
  • Private key
Note -

You can find the client and key details in your service account in the GCP console (API & Services > Credentials > Create Credentials).

  • Make sure that the service account has the Storage Legacy Bucket Writer permission on the target bucket.
  • Make sure that the bucket doesn’t use a retention policy because it can interfere with the process.
  • The format of the private key from the downloaded JSON is in a single string where new lines are marked with \n characters. When you paste the key into the RS web UI, replace each \n character with a new line.