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 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.

Setting Up Kublr Backup Schedule

  1. Login to Kublr as administrator.
  2. On the left menu, click Backup.
  3. Click the name of the cluster which backup you want to schedule. The page for managing cluster backups is displayed.
  4. In the Settings section, make sure the Backup enabled option is selected.
  5. Click Edit Settings. The Settings section is displayed in the editing mode. Page for Managing Cluster Backups - Settings
  6. Set schedule options and then click CREATE CONFIG.

Cheking Kublr Backup Creation Status

  1. In Kublr, on the left menu, click Backup.
  2. Click the name of the cluster. The page for managing cluster backups is displayed. Page for Managing Cluster Backups - Backup List
  3. Check the Backup List.

Backup Details

For each Kublr backup you can get:

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

Backup Page

Cluster Restoration from Backup

You can restore only deleted clusters. The cluster recovery process is similar to cluster creation.

To restore a deleted cluster:

  1. In Kublr, on the left menu, click Backup.

  2. Click the name of the deleted cluster. The page for managing cluster backups is displayed.

  3. In the Backup List, to the rigth of the approptiate backup, click the Request Recovery button. Page for Managing Cluster Backups - Backup List

    Note Alternatively, you can enter the page of the backup and click the REQUET RECOVERY button.

  4. Confirm the cluster recovery.

What else can I do?

Additionally, you can:

  • Delete a particular backup. Navigate to the Backup List and click the trash icon to the rigth of the backup name.
  • Delete all backups of a cluster. On the left menu, click Backup and click the trash icon to the rigth of the cluster name.

Kublr Backup Consistency

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-premises 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.