Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/vmware-tanzu/velero-plugin-for-csi
Velero plugins for integrating with CSI snapshot API
https://github.com/vmware-tanzu/velero-plugin-for-csi
velero velero-plugin
Last synced: 3 months ago
JSON representation
Velero plugins for integrating with CSI snapshot API
- Host: GitHub
- URL: https://github.com/vmware-tanzu/velero-plugin-for-csi
- Owner: vmware-tanzu
- License: apache-2.0
- Created: 2019-06-04T15:04:55.000Z (over 5 years ago)
- Default Branch: main
- Last Pushed: 2024-04-19T12:52:21.000Z (7 months ago)
- Last Synced: 2024-04-22T00:34:02.896Z (7 months ago)
- Topics: velero, velero-plugin
- Language: Go
- Homepage:
- Size: 4.33 MB
- Stars: 105
- Watchers: 12
- Forks: 68
- Open Issues: 5
-
Metadata Files:
- Readme: README.md
- Changelog: changelogs/CHANGELOG-0.1.2.md
- Contributing: CONTRIBUTING.md
- License: LICENSE
- Code of conduct: CODE_OF_CONDUCT.md
Awesome Lists containing this project
- awesome-starred - vmware-tanzu/velero-plugin-for-csi - Velero plugins for integrating with CSI snapshot API (others)
README
[![Build Status][101]][102]
# Velero CSI plugins
This repository contains Velero plugins for snapshotting CSI backed PVCs using the [CSI _beta_ snapshot APIs][7].
CSI plugin reaches GA for AWS and Azure environments as of the [Velero 1.9 release][1]. It should also work for those environments in which CSI plugin provides durable snapshot (please check [WARNING](#WARNING) section for more details), but Velero team doesn't have enough resources to verify, so please do enough tests before using CSI plugin in some environments.
After Velero's data mover function is ready (v1.12), for those environments that don't have durable snapshot capability, CSI plugin also reached GA. Please use the [CSI snapshot data mover][8] to make the snapshot data durable.
For a list of prerequisites and installation instructions, please refer to our documentation [here][2].
> [!TIP]
> Since Velero v1.14, this plugin is integrated into Velero and should not be added manually. You can safely remove it from your configuration if upgrading from v1.13. See [Upgrade notes](https://velero.io/docs/v1.14/upgrade-to-1.14/)
# WARNING
CSI Snapshots are a standard Kubernetes mechanism for taking snapshots. The actual implementation of snapshots varies by storage vendor. For disaster recovery, snapshots must be stored in a durable store, such as an S3 bucket, tape library, etc. and not just on the primary storage. If the snapshot is only stored on the primary storage and the storage is corrupted or destroyed the backup will be lost.
CSI snapshots on AWS EBS, Azure managed disks and Google Cloud Persistent Disk are durable and can be safely used for backup.
For all other storage systems, please check with your storage vendor. If your storage vendor doesn't support durable snapshot storage you can use the [CSI snapshot data mover][8].
## Verified environment
Velero CSI plugin v0.7 is tested with Velero v1.13 on the following environments:
* EKS: ebs.csi.aws.com driver is tested with version v1.27.8.
* AKS: disk.csi.azure.com driver is tested with version v1.28.3.
* GKE: pd.csi.storage.gke.io driver is tested with version v1.27.3.
## Compatibility
Below is a listing of plugin versions and respective Velero versions that are compatible.
| Plugin Version | Velero Version |
|-----------------|----------------|
| v0.7.x | v1.13.x |
| v0.6.x | v1.12.x |
| v0.5.x | v1.11.x |
| v0.4.x | v1.10.x |
| v0.3.0 | v1.9.x |
| v0.2.0 | v1.7.x, v1.8.x |
### Choosing VolumeSnapshotClass For snapshotting (>=0.6.0)
#### Default Behavior
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:
```yaml
apiVersion: snapshot.storage.k8s.io/v1
kind: VolumeSnapshotClass
metadata:
name: test-snapclass
labels:
velero.io/csi-volumesnapshot-class: "true"
driver: disk.csi.cloud.com
```
> Note: For each driver type, there should only be 1 VolumeSnapshotClass with the label `velero.io/csi-volumesnapshot-class: "true"`.
#### 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:
```yaml
apiVersion: velero.io/v1
kind: Backup
metadata:
name: test-backup
annotations:
velero.io/csi-volumesnapshot-class_disk.csi.cloud.com: "test-snapclass"
spec:
includedNamespaces:
- default
```
> Note: Please ensure all your annotations are in lowercase. And follow the following format: `velero.io/csi-volumesnapshot-class_ = `
#### 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:
```yaml
apiVersion: v1
kind: PersistentVolumeClaim
metadata:
name: test-pvc
annotations:
velero.io/csi-volumesnapshot-class: "test-snapclass"
spec:
accessModes:
- ReadWriteOnce
resources:
requests:
storage: 1Gi
storageClassName: disk.csi.cloud.com
```
> Note: Please ensure all your annotations are in lowercase. And follow the following format: `velero.io/csi-volumesnapshot-class = `
## Filing issues
If you would like to file a GitHub issue for the plugin, please open the issue on the [core Velero repo][103]
## Kinds of Plugins Included
### PVCBackupItemAction
A plugin of type BackupItemAction that backs up `PersistentVolumeClaims` which are backed by CSI volumes.
This plugin will create a [CSI VolumeSnapshot][3] which in turn triggers the CSI driver to perform the snapshot operation on the volume.
### VolumeSnapshotBackupItemAction
A plugin of type BackupItemAction that backs up [`volumesnapshots.snapshot.storage.k8s.io`][3].
When invoked, this plugin will capture information about the underlying [`volumesnapshotcontent.snapshot.storage.k8s.io`][4] in the annotations of the volumesnapshots being backed up. This plugin will also return the underlying [`volumesnapshotcontent.snapshot.storage.k8s.io`][4] and the associated [`snapshot.storage.k8s.io.volumesnapshotclasses`][5] as additional resources to be backed up.
### VolumeSnapshotContentBackupItemAction
A plugin of type BackupItemAction that backs up [`volumesnapshotcontent.snapshot.storage.k8s.io`][4].
This plugin will look for snapshot delete operation secrets from the [annotations][6] on the VolumeSnapshotContent object being backed up.
### VolumeSnapshotClassBackupItemAction
A plugin of type BackupItemAction that backs up [`snapshot.storage.k8s.io.volumesnapshotclasses`][5].
This plugin will look for snapshot list operation secret from the [annotations][6] on the VolumeSnapshotClass object being backed up.
### PVCRestoreItemAction
A plugin of type RestoreItemAction that restores `PersistentVolumeClaims` which were backed up by [PVCBackupItemAction](#PVCBackupItemAction).
This plugin will modify the spec of the `PersistentVolumeClaim` being restored to use the VolumeSnapshot, created during backup, as the data source ensuring that the newly provisioned volume, to satisfy this claim, may be pre-populated using the VolumeSnapshot.
### VolumeSnapshotRestoreItemAction
A plugin of type RestoreItemAction that restores [`volumesnapshots.snapshot.storage.k8s.io`][3].
This plugin will use the annotations, added during backup, to create a [`volumesnapshotcontent.snapshot.storage.k8s.io`][4] and statically bind it to the VolumeSnapshot object being restored. The plugin will also set the necessary [annotations][6] if the original VolumeSnapshotContent had snapshot deletion secrets associated with it.
### VolumeSnapshotClassRestoreItemAction
A plugin of type RestoreItemAction that restores [`snapshot.storage.k8s.io.volumesnapshotclasses`][5].
This plugin will use the [annotations][6] on the object being restored to return, as additional items, any snapshot lister secret that is associated with the VolumeSnapshotClass.
## Building the plugins
Official images of the plugin are available on [Velero DockerHub](https://hub.docker.com/repository/docker/velero/velero-plugin-for-csi).
For development and testing, the plugin images may be built by running the below command
```bash
$ IMAGE=/velero-plugin-for-csi: make container
```
## Known shortcomings
We are tracking known limitations with the plugins [here][2]
[1]: https://github.com/vmware-tanzu/velero/releases
[2]: https://velero.io/docs/csi
[3]: https://kubernetes.io/docs/concepts/storage/volume-snapshots/#volumesnapshots
[4]: https://kubernetes.io/docs/concepts/storage/volume-snapshots/#volume-snapshot-contents
[5]: https://kubernetes.io/docs/concepts/storage/volume-snapshot-classes/
[6]: https://github.com/kubernetes-csi/external-snapshotter/blob/master/pkg/utils/util.go#L59-L60
[7]: https://kubernetes.io/blog/2019/12/09/kubernetes-1-17-feature-cis-volume-snapshot-beta/
[8]: https://velero.io/docs/v1.13/csi-snapshot-data-movement/
[101]: https://github.com/vmware-tanzu/velero-plugin-for-csi/workflows/Main%20CI/badge.svg
[102]: https://github.com/vmware-tanzu/velero-plugin-for-csi/actions?query=workflow%3A"Main+CI"
[103]: https://github.com/vmware-tanzu/velero/issues/new/choose