This is the documentation for the latest development version of Velero. Both code and docs may be unstable, and these docs are not guaranteed to be up to date or correct. See the latest version.
Integrating Container Storage Interface (CSI) snapshot support into Velero enables Velero to backup and restore CSI-backed volumes using the Kubernetes CSI Snapshot APIs.
By supporting CSI snapshot APIs, Velero can support any volume provider that has a CSI driver, without requiring a Velero-specific plugin to be available. This page gives an overview of how to add support for CSI snapshots to Velero through CSI plugins. For more information about specific components, see the plugin repo.
NOTE: Not all cloud provider’s CSI drivers guarantee snapshot durability, meaning that the VolumeSnapshot and VolumeSnapshotContent objects may be stored in the same object storage system location as the original PersistentVolume and may be vulnerable to data loss. You should refer to your cloud provider’s documentation for more information on configuring snapshot durability. Since v0.3.0 the velero team will provide official support for CSI plugin when they are used with AWS and Azure drivers.
To integrate Velero with the CSI volume snapshot APIs, you must enable the
EnableCSI feature flag and install the Velero
CSI plugins on the Velero server.
Both of these can be added with the
velero install command.
velero install \
--plugins=<object storage plugin>,velero/velero-plugin-for-csi:v0.3.0 \
To include the status of CSI objects associated with a Velero backup in
velero backup describe output, run
velero client config set features=EnableCSI.
Enabling Features for more information about managing client-side feature flags. You can also view the image on
This section documents some of the choices made during implementation of the Velero CSI plugins:
DeletionPolicy on the VolumeSnapshotClass is set to
Retain. To accomplish this, during deletion of the backup the prior to deleting the VolumeSnapshot, VolumeSnapshotContent object is patched to set its
Delete. Deleting the VolumeSnapshot object will result in cascade delete of the VolumeSnapshotContent and the snapshot in the storage provider.
velero backup that are dangling, unbound to a VolumeSnapshot object, will be discovered, using labels, and deleted on backup deletion.
You can simply create a VolumeSnapshotClass for a particular driver and put a label on it to indicate that it is the default VolumeSnapshotClass for that driver. For example, if you want to create a VolumeSnapshotClass for the CSI driver
disk.csi.cloud.com for taking snapshots of disks created with
disk.csi.cloud.com based storage classes, you can create a VolumeSnapshotClass like this:
Note: For each driver type, there should only be 1 VolumeSnapshotClass with the label
Choose VolumeSnapshotClass for a particular Backup Or Schedule:
If you want to use a particular VolumeSnapshotClass for a particular backup or schedule, you can add a annotation to the backup or schedule to indicate which VolumeSnapshotClass to use. For example, if you want to use the VolumeSnapshotClass
test-snapclass for a particular backup for snapshotting PVCs of
disk.csi.cloud.com, you can create a backup like this:
Note: Please ensure all your annotations are in lowercase. And follow the following format:
velero.io/csi-volumesnapshot-class_<driver name> = <VolumeSnapshotClass Name>
Choosing VolumeSnapshotClass for a particular PVC:
If you want to use a particular VolumeSnapshotClass for a particular PVC, you can add a annotation to the PVC to indicate which VolumeSnapshotClass to use. This overrides any annotation added to backup or schedule. For example, if you want to use the VolumeSnapshotClass
test-snapclass for a particular PVC, you can create a PVC like this:
Velero’s CSI support does not rely on the Velero VolumeSnapshotter plugin interface.
Instead, Velero uses a collection of BackupItemAction plugins that act first against PersistentVolumeClaims.
When this BackupItemAction sees PersistentVolumeClaims pointing to a PersistentVolume backed by a CSI driver, it will choose the VolumeSnapshotClass with the same driver name that has the
velero.io/csi-volumesnapshot-class label to create a CSI VolumeSnapshot object with the PersistentVolumeClaim as a source.
This VolumeSnapshot object resides in the same namespace as the PersistentVolumeClaim that was used as a source.
From there, the CSI external-snapshotter controller will see the VolumeSnapshot and create a VolumeSnapshotContent object, a cluster-scoped resource that will point to the actual, disk-based snapshot in the storage system.
The external-snapshotter plugin will call the CSI driver’s snapshot method, and the driver will call the storage system’s APIs to generate the snapshot.
Once an ID is generated and the storage system marks the snapshot as usable for restore, the VolumeSnapshotContent object will be updated with a
status.snapshotHandle and the
status.readyToUse field will be set.
Velero will include the generated VolumeSnapshot and VolumeSnapshotContent objects in the backup tarball, as well as upload all VolumeSnapshots and VolumeSnapshotContents objects in a JSON file to the object storage system. Note that only Kubernetes objects are uploaded to the object storage, not the data in snapshots.
When Velero synchronizes backups into a new cluster, VolumeSnapshotContent objects and the VolumeSnapshotClass that is chosen to take snapshot will be synced into the cluster as well, so that Velero can manage backup expiration appropriately.
DeletionPolicy on the VolumeSnapshotContent will be the same as the
DeletionPolicy on the VolumeSnapshotClass that was used to create the VolumeSnapshot. Setting a
Retain on the VolumeSnapshotClass will preserve the volume snapshot in the storage system for the lifetime of the Velero backup and will prevent the deletion of the volume snapshot, in the storage system, in the event of a disaster where the namespace with the VolumeSnapshot object may be lost.
When the Velero backup expires, the VolumeSnapshot objects will be deleted and the VolumeSnapshotContent objects will be updated to have a
Delete, to free space on the storage system.
For more details on how each plugin works, see the CSI plugin repo’s documentation.
Note: The AWS, Microsoft Azure, and Google Cloud Platform (GCP) Velero plugins version 1.4 and later are able to snapshot and restore persistent volumes provisioned by a CSI driver via the APIs of the cloud provider, without having to install Velero CSI plugins. See the AWS, Microsoft Azure, and Google Cloud Platform (GCP) Velero plugin repo for more information on supported CSI drivers.