Documentation

Cluster migration

Using Backups and Restores

Velero can help you port your resources from one cluster to another, as long as you point each Velero instance to the same cloud object storage location. This scenario assumes that your clusters are hosted by the same cloud provider. Note that Velero does not natively support the migration of persistent volumes snapshots across cloud providers. If you would like to migrate volume data between cloud platforms, please enable restic, which will backup volume contents at the filesystem level.

  1. (Cluster 1) Assuming you haven’t already been checkpointing your data with the Velero schedule operation, you need to first back up your entire cluster (replacing <BACKUP-NAME> as desired):

    velero backup create <BACKUP-NAME>
    

    The default backup retention period, expressed as TTL (time to live), is 30 days (720 hours); you can use the --ttl <DURATION> flag to change this as necessary. See how velero works for more information about backup expiry.

  2. (Cluster 2) Configure BackupStorageLocations and VolumeSnapshotLocations, pointing to the locations used by Cluster 1, using velero backup-location create and velero snapshot-location create. Make sure to configure the BackupStorageLocations as read-only by using the --access-mode=ReadOnly flag for velero backup-location create.

  3. (Cluster 2) Make sure that the Velero Backup object is created. Velero resources are synchronized with the backup files in cloud storage.

    velero backup describe <BACKUP-NAME>
    

    Note: The default sync interval is 1 minute, so make sure to wait before checking. You can configure this interval with the --backup-sync-period flag to the Velero server.

  4. (Cluster 2) Once you have confirmed that the right Backup (<BACKUP-NAME>) is now present, you can restore everything with:

    velero restore create --from-backup <BACKUP-NAME>
    

Verify Both Clusters

Check that the second cluster is behaving as expected:

  1. (Cluster 2) Run:

    velero restore get
    
  2. Then run:

    velero restore describe <RESTORE-NAME-FROM-GET-COMMAND>
    

If you encounter issues, make sure that Velero is running in the same namespace in both clusters.

Migrating Workloads Across Different Kubernetes Versions

Migration across clusters that are not running the same version of Kubernetes might be possible, but some factors need to be considered: compatibility of API groups between clusters for each custom resource, and if a Kubernetes version upgrade breaks the compatibility of core/native API groups. For more information about API group versions, please see EnableAPIGroupVersions. Note: Velero doesn’t support restoring into a cluster with a lower Kubernetes version than where the backup was taken.

Getting Started

To help you get started, see the documentation.