Backup and restore your Key Value Store instance

Prerequisites

• You have created a Key Value Store instance.
  Check Create and manage instances for Key Value Store

Introduction

Backup and restore is an essential feature to guarantee the SLAs of your service. STACKIT Key Value Store offers backup and restore capabilities to help you achieving this goal. These are the features of the backup and restore capabilities:

• Backup and in-place-restore of your instances
• Automated scheduled backups every 4 hours
• Create manual backups
• Download your backups
• backup retention for 14 days
• All settings are accessible by the Portal, the CLI, Cloud Foundry and Terraform

Backup

STACKIT Key Value Store automatically creates a backup every 4 hours. These backups are held for 14 days. If you want a longer backup history, you need to download the created backups.

You need to create an encryption key before you are able to download your backups. Creating an encryption key only affects future backups.

You don’t pay for the backup itself, but for the storage the generated backup files reserve. The storage size depends on your backup settings and of the accumulated instance databases size. At the moment you need to estimate the storage need by yourself.

Backup settings and their description

Setting	Description	Options
Encryption Key	Defines the key with which the STACKIT system encrypts the backup	custom string

List existing backups

You can get an overview of all existing backups.

STACKIT Portal

You can view all backups by navigating to the Backups tab at the service dashboard of your instance.

1. Navigate to Key Value Store in the STACKIT Portal.

2. Select your Key Value Store instance.

3. In the sidebar select Backups.

4. You see a list of all backups with their properties:

   ID, Start time, End time, Backup size, Backup status, Restore created at

   If you created an encryption key prior to the start time of a backup, you are able to download the backup via its three dots menu.

Create an encryption key

Create an encryption key to be able to download your backups. Store the key in a safe place.

The backups are encrypted at creation time. If you change your encryption key, you need to preserve the prior key to be able to encrypt backups created with it.

STACKIT Portal

1. Navigate to Key Value Store in the STACKIT Portal.
2. Select your Key Value Store instance.
3. In the sidebar select Backups.
4. In the top bar select Create encryption key.
5. Enter an encryption key with a minimum length of 8 characters and select Create.
6. Read the note and select Done.

Trigger a manual backup

You can trigger a manual backup any time.

STACKIT Portal

1. Navigate to Key Value Store in the STACKIT Portal.
2. Select your Key Value Store instance and go to Backups.
3. Select Create manual backup.
4. In the popup select Create.
5. Wait until the status of the backup is Done.

Download a backup

You can download a backup any time.

You can only download backups which were encrypted. To encrypt future backups, create an encryption key.

STACKIT Portal

1. Navigate to Key Value Store in the STACKIT Portal.
2. Select your Key Value Store instance and go to Backups.
3. Choose a backup to download. In the three-dots-menu select Download. If there is no Download option, then the backup was created without encryption. Always create an encryption key before inserting important data into your instance.
4. Wait until the download is completed.

Restore

You can restore a specific backup to the same instance. To restore your backup to a separate instance, you need to download the backup and restore it manually after creating another instance.

Managed restore to the same instance

STACKIT Portal

1. Navigate to Key Value Store in the STACKIT Portal.
2. Select your Key Value Store instance and go to Backups.
3. In the backup’s three dots menu select Restore.
4. On the popup, read the warning that all data in your instance will be overwritten. If you agree, select Restore.

Decrypting of a downloaded backup file

You can download and decrypt your backup files. This is useful, if you plan to store your data independently of STACKIT.

STACKIT Portal

1. Download the encrypted backup
   1. Navigate to Key Value Store in the STACKIT Portal.
   2. Select your Key Value Store instance and go to Backups.
   3. In the backup’s three dots menu select Download.
   4. Wait for the download to complete.
2. Decrypt the downloaded backup

   1. Open a shell and navigate to the folder where you downloaded the backup into.

   2. Decrypt and unzip the backup: <encrypted-backup-file> is the placeholder for the downloaded file. <target-backup-file-prefix> is the name of the target file without the file ending. You can freely choose this name according to the limitations of your local file system.

      cat <encrypted-backup-file> | openssl enc -aes256 -md md5 -d -pass 'pass:<encryption-key>' > <target-backup-file-prefix>.rdb.tar.gz
      tar -xvjf <target-backup-file-prefix>.sql.gz

   3. Verify the file: Use the file command to verify the decrypted and uncompressed backup:

      file dump.rdb

      If everything is correct, file will return something like this:

      dump.rdb: Redis RDB file, version 0011