Skip to main content

Configure Other Storage Destinations

This topic describes installing Velero and configuring storage for Amazon Web Service (AWS), Google Cloud Provider (GCP), Microsoft Azure, and S3-compatible providers.

To configure host path or NFS as a storage destination, see Configure a Host Path Storage Destination and Configure an NFS Storage Destination.

note

If Velero is already installed, you can update your storage destination in the Replicated Admin Console.

For embedded clusters with the Velero add-on, you must update the default internal storage settings in the Admin Console because internal storage is insufficient for full backups.

For more information about updating storage, see Updating Settings in the Admin Console.

Prerequisites​

Complete the following items before you install Velero and configure a storage destination:

Configure AWS Storage for Online Environments​

In this procedure, you install Velero and configure an AWS storage destination in online environments.

Snapshots does not support Amazon Simple Storage Service (Amazon S3) buckets that have a bucket policy requiring the server-side encryption header. If you want to require server-side encryption for objects, you can enable default encryption on the bucket instead. For more information about Amazon S3, see the Amazon S3 documentation.

To install Velero and configure an AWS storage destination:

  1. Follow the instructions for installing Velero on AWS in the velero-plugin-for-aws repository in GitHub.

  2. Run the velero install command with these additional flags:

    • Velero 1.10 and later: Use the --use-node-agent, --uploader-type=restic, and --use-volume-snapshots=false flags.
    • Velero versions earlier than 1.10: Use the --use-restic and --use-volume-snapshots=false flags.

    Example:

    velero install \
       --provider aws \
       --plugins velero/velero-plugin-for-aws:v1.2.0 \
       --bucket $BUCKET \
       --backup-location-config region=$REGION \
       --secret-file CREDS_FILE \
       --use-node-agent --uploader-type=restic \
       --use-volume-snapshots=false

Configure GCP Storage for Online Environments​

In this procedure, you install Velero and configure a GCP storage destination in online environments.

To install Velero and configure a GCP storage destination:

  1. Follow the instructions for installing Velero on GCP in the velero-plugin-for-gcp repository in GitHub.

  2. Run the velero install command with these additional flags:

    • Velero 1.10 and later: Use the --use-node-agent, --uploader-type=restic, and --use-volume-snapshots=false flags.
    • Velero versions earlier than 1.10: Use the --use-restic and --use-volume-snapshots=false flags.

    Example:

    velero install \
      --provider gcp \
      --plugins velero/velero-plugin-for-gcp:v1.5.0 \
      --bucket $BUCKET \
      --secret-file ./CREDS_FILE
      --use-node-agent --uploader-type=restic \
      --use-volume-snapshots=false

Configure Azure Storage for Online Environments​

In this procedure, you install Velero and configure an Azure storage destination in online environments.

To install Velero and configure an Azure storage destination:

  1. Follow the instructions for Install Velero on Azure in the Velero documentation.

  2. Run the velero install command with these additional flags:

    • Velero 1.10 and later: Use the --use-node-agent, --uploader-type=restic, and --use-volume-snapshots=false flags.
    • Velero versions earlier than 1.10: Use the --use-restic and --use-volume-snapshots=false flags.

    Example:

    velero install \
      --provider azure \
      --plugins velero/velero-plugin-for-microsoft-azure:v1.5.0 \
      --bucket $BLOB_CONTAINER \
      --secret-file ./CREDS_FILE \
      --backup-location-config resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,storageAccount=$AZURE_STORAGE_ACCOUNT_ID[,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID] \
      --snapshot-location-config apiTimeout=<YOUR_TIMEOUT>[,resourceGroup=$AZURE_BACKUP_RESOURCE_GROUP,subscriptionId=$AZURE_BACKUP_SUBSCRIPTION_ID]
      --use-node-agent --uploader-type=restic \
      --use-volume-snapshots=false

Configure S3-Compatible Storage for Online Environments​

Replicated supports the following S3-compatible object stores for storing backups with Velero:

  • Ceph RADOS v12.2.7
  • MinIO

Run the following command to install Velero and configure an S3-compatible storage destination in an online environment. For more information about required storage destination flags, see velero in Reference.

kubectl kots velero configure-other-s3 \
  --namespace NAME \
  --endpoint ENDPOINT \
  --region REGION \
  --bucket BUCKET \
  --access-key-id ACCESS_KEY_ID \
  --secret-access-key SECRET_ACCESS_KEY

Replace:

  • NAME with the name of the namespace where the Replicated KOTS Admin Console is installed and running
  • ENDPOINT with the s3 endpoint
  • REGION with the region where the bucket exists
  • BUCKET with the name of the object storage bucket where backups should be stored
  • ACCESS_KEY_ID with the access key id to use for accessing the bucket
  • SECRET_ACCESS_KEY with the secret access key to use for accessing the bucket

Example:

kubectl kots velero configure-other-s3 \
  --namespace default \
  --endpoint http://minio \
  --region minio \
  --bucket kots-snaps \
  --access-key-id XXXXXXXJTJB7M2XZUV7D \
  --secret-access-key mysecretkey

If no Velero installation is detected, instructions are displayed to install Velero and configure the storage destination.

Configure S3-Compatible Storage for Air Gapped Environments​

Introduced in Replicated KOTS v1.94.0

The following S3-compatible object stores are supported for storing backups with Velero:

  • Ceph RADOS v12.2.7
  • MinIO

Run the following command to install Velero and configure an S3-compatible storage destination in an air gapped environment. For more information about required storage destination flags, see velero in Reference.

kubectl kots velero configure-other-s3 \
  --namespace NAME \
  --endpoint ENDPOINT \
  --region REGION \
  --bucket BUCKET \
  --access-key-id ACCESS_KEY_ID \
  --secret-access-key SECRET_ACCESS_KEY \
  --kotsadm-registry REGISTRY_HOSTNAME[/REGISTRY_NAMESPACE] \
  --registry-username REGISTRY_USERNAME \
  --registry-password REGISTRY_PASSWORD

Replace:

  • NAME with the name of the namespace where the Admin Console is installed and running
  • ENDPOINT with the s3 endpoint
  • REGION with the region where the bucket exists
  • BUCKET with the name of the object storage bucket where backups should be stored
  • ACCESS_KEY_ID with the access key id to use for accessing the bucket
  • SECRET_ACCESS_KEY with the secret access key to use for accessing the bucket
  • REGISTRY_HOSTNAME with the registry endpoint where the images are hosted
  • REGISTRY_NAMESPACE with the registry namespace where the images are hosted (Optional)
  • REGISTRY_USERNAME with the username to use to authenticate with the registry
  • REGISTRY_PASSWORD with the password to use to authenticate with the registry

If no Velero installation is detected, instructions are displayed to install Velero and configure the storage destination.

note

It is typical for the velero and node-agent (restic) Pods to be in the ErrImagePull or ImagePullBackOff state after you run the velero install command because Velero does not support passing registry credentials during installation. In Replicated KOTS v1.94.0 and later, this situation resolves itself after you complete the instructions to configure the storage destination.

If you are on an earlier version of KOTS, Replicated recommends that you upgrade to KOTS v1.94.0 or later. Otherwise, you must patch the Velero deployment manually and add the image pull secret to access the registry.

Next Steps​

Additional Resources​