Skip to content

Backup Location

In order to perform backup or restore your cluster, you need to first define a location to store the backup snapshots. The backup locations can be an "AWS S3" bucket or any "S3 Compatible Storage" like MinIO. Follow the steps described below to create a backup location.


AWS S3 Storage

Control Plane

  • Create an AWS S3 bucket in your AWS account
  • Note down AWS region and the name of the bucket
  • From Web Console, navigate to your Project
  • Select "Backup/Restore > Locations" and add "New Location"
  • Provide the location name and provide an optional description
  • Select Type "Control Plane Backup"
  • Click "CREATE"

Add Location

  • In the location settings page, under Config section, select Target Type as "Amazon"
  • Enter the Region and Bucket Name for the AWS S3 bucket created above
  • And click "SAVE" to create the location for control plane backup to S3 bucket

Configure Location


Persistent Volumes

  • Go back to Backup/Restore > Locations menu to add "New Location"
  • Provide the location name, description and select Type "Volume Backup"
  • And click "CREATE"

Add Location

  • In the location settings page, under Config section, select Target Type as "Amazon"
  • Enter the Region name
  • And click "SAVE" to create the location for persistent volume backup to S3 bucket

Configure Location


S3 Compatible Storage

Control Plane

  • Install S3 Compatible Storage in your environment like MinIO to use for cluster backup. You can follow the recipe on how to install a centralize MinIO to your infrastructure cluster here
  • Create a bucket in your MinIO with Read and Write access to use for backing up your cluster data. Note down Minio's URL and the bucket name to use for configuring in Web Console in later steps.
  • From the Web Console, navigate to your Project
  • Go to Backup/Restore > Locations menu to add "New Location"
  • Provide the location name, description and select Type "Control Plane Backup"
  • And click "CREATE"

Add Location

  • In the location settings page, under Config section, select Target Type as "S3 Compatible Endpoint"
  • Enter the MinIO URL and Bucket Name for the MinIO bucket created above
  • And click "SAVE" to create the location for control plane backup to MinIO bucket

Configure Location


Persistent Volumes

  • Go back to Backup/Restore > Locations menu to add "New Location"
  • Provide the location name, description and select Type "Volume Backup"
  • And click "CREATE"

Add Location

  • In the location settings page, under Config section, select Target Type as "S3 Compatible Endpoint"
  • Enter the MinIO URL
  • And click "SAVE" to create the location for persistent volume backup to MinIO bucket

Configure Location


CLI for creating Backup Location

Amazon S3 Storage/S3 Compatible Storage

Users can also define a location to store the backup snapshots through RCTL with the below commands

Create Control Plane Backup Location with Amazon Target Type

 ./rctl create dp-location <name> --backup-type <controlplanebackup> --target-type <amazon> --region <region> --bucket-name <bucketname>
 ```

__Create Control Plane Backup Location with S3 Compatible Endpoint Target Type__

``` bash
./rctl create dp-location <name> --backup-type <controlplanebackup> --target-type <s3compatible> --url <url> --bucket-name <bucketname>

Create Volume Backup Location with Amazon Target Type

./rctl create dp-location <name> --backup-type <volumebackup> --target-type <amazon> --region <region>

Create Volume Backup Location with S3 Compatible Endpoint Target Type

./rctl create dp-location <name> --backup-type <volumebackup> --target-type <s3compatible> --url <url> --bucket-name <bucketname>

Update Location objects with Amazon Target Type

./rctl update dp-location <name> --backup-type <backup-type> --target-type <amazon> --region <region> --bucket-name <bucketname>

Update Location objects with S3 Compatible Endpoint Target Type

./rctl update dp-location <name> --backup-type <backup-type> --target-type <s3compatible> --url <url> --bucket-name <bucketname>

Azure Storage Account

For AKS clusters, users can define a location to store the backup snapshots through RCTL with the below commands

Create Control Plane Backup Location with Azure Target Type

./rctl create dp-location <name> --backup-type <controlplanebackup> --target-type <azure> --bucket-name <bucketname> --resource-group <resource-group> --storage-account <storage-account>

Create Volume Backup Location with Azure Target Type

./rctl create dp-location <name> --backup-type <volumebackup> --target-type <azure> --resource-group <resource-group>

Update Control Plane Backup Location with Azure Target Type

./rctl update dp-location <name> --backup-type <controlplanebackup> --target-type <azure> --bucket-name <bucketname> --resource-group <resource-group> --storage-account <storage-account>

Update Volume Backup Location with Azure Target Type

./rctl update dp-location <name> --backup-type <volumebackup> --target-type <azure> --resource-group <resource-group>

Fetch / Delete Location

Delete Location

./rctl delete dp-location <name>

Fetch Location objects

./rctl get dp-location

An illustrative example is shown below where RCTL retrieves the list of location objects

+-------------------+----------------------+------------------------------+
| NAME              | TYPE                 | CREATED AT                   |
+-------------------+----------------------+------------------------------+
| demo-cpb          | Control Plane Backup | Fri Sep 17 09:26:19 UTC 2021 |
+-------------------+----------------------+------------------------------+
| demo-controlplane | Control Plane Backup | Fri Sep 17 09:25:53 UTC 2021 |
+-------------------+----------------------+------------------------------+
| demo-volume       | Volume Backup        | Fri Sep 17 09:26:06 UTC 2021 |
+-------------------+----------------------+------------------------------+

Use the below command to retrieve a specific location's details

./rctl get dp-location <location-name>