Backup

Overview

This document explains the main aspects of the Kublr Backup/Restore feature. Kublr Cluster Backup make snapshots of all cluster volumes, including:

  1. Master nodes volumes (etcd state / cluster configuration)
  2. Volumes provisioned for volume claims

Each set of volume snapshots is called backup snapshot. You can restore a cluster from specific backup snapshot.

Kublr does not make application-level backups or external-services backups (RDS or DynamoDB for example).

How does the Kublr Cluster Backup work?

Kublr backups are created and purged according to the backup schedule. The schedule defines:

  1. How often Kublr backups are created for the cluster
  2. How many Kublr backups are kept for the current day, current week, current month as well as the maximum number of backups to keep.

The Kublr Platform uses AWS API and cluster’s AWS credentials to create volume snapshots and/or to remove old snapshots.

How can I set up a Kublr Backup schedule?

  1. Login to the Kublr Platform as an administrator
  2. Open the Backup page from the left menu and find the cluster you want to schedule
  3. Click on “Enable Backup” and then on the “Edit Settings” button Enable Backup
  4. Set how often backups are created
  5. Set up the retention policy for the created backup
  6. Click on “Update Settings” button

Backup Schedule Settings

How can I confirm that Kublr Backups are being created?

  1. Login to Kublr Platform as an administrator
  2. Open the Clusters page from the left menu and select the cluster where the backup should be created
  3. From the Cluster Overview page please check that the backup is set up
  4. Open the Logs tab for the cluster and search for entries: “Cluster backup creation process has been started” and “Cluster backup creation process has been completed”
  5. Switch to the Backup page from the left menu and find the cluster
  6. You should see the list of backup snapshots created for this cluster at the bottom of the page

Backup Logs

What details can I see for the created backups?

For each Kublr backup you can get:

  1. Volumes included for each backup
  2. Total size and size for the specific volume

Backup Volumes Details

How can I restore a cluster from an existing backup?

  1. Login to Kublr Platform as an administrator
  2. Open the Clusters page from the left menu and make sure that cluster you are going to restore is deleted
  3. Open the Backup page from the left menu and find the cluster you want to restore
  4. Select one of the backups you want to restore
  5. At the bottom of the page click on “Request Recovery” button and confirm the cluster recovery
  6. The cluster recovery process is similar to cluster creation process

Does Kublr guarantee cluster backup consistency?

No, Kublr can’t guarantee this. Because cluster nodes are not stopped during the backup procedure, snapshots typically have different creation times.

Kublr Backup limitations

Currently Kublr supports backup for AWS cloud providers only. Additional support for other cloud providers, as well as instructions for on-premise installations, will be available in future versions of Kublr.

At this moment Kublr cannot restore backups over existing clusters. Please remove the cluster before restoring it from the backup.

Please read the Kublr Release Notes about known issues related to backups.


Questions? Suggestions? Need help? Contact us.