Velero Plugin for CSI

Velero Plugin for CSI is a Velero plugin that snapshots Container Storage Interface (CSI)-backed persistent volumes in Kubernetes, enabling cluster operators…

  • Backup
  • Infrastructure
Velero Plugin for CSI is a Velero plugin that snapshots Container Storage Interface (CSI)-backed persistent volumes in Kubernetes, enabling cluster operators to include those volumes in Velero backup and restore jobs. The upstream repository is archived and no longer actively developed, but a Docker Hub image keeps builds available.

Platform availability

Available on 0 of 10 platforms

  • Unraid (not listed)
  • TrueNAS (not listed)
  • Umbrel (not listed)
  • ZimaOS (not listed)
  • Proxmox (not listed)
  • Helm (not listed)
  • Mac (not listed)
  • Windows (not listed)
  • Linux (not listed)
  • Any server (not listed)

Health score?A 0-100 score computed nightly from four factors: maintained (40%: recent commits and steady activity), popular (25%: GitHub stars, log scale), easy to install (20%: platforms, install notes, setup guides, Docker image) and light to run (15%: minimum RAM, ARM support). When the source code has been checked, a fifth factor, security check (20%: automated scan for committed secrets, unsafe desktop-app settings, known-vulnerable dependencies and project hygiene; any serious finding caps it at 20), is added. Factors without data are left out and the rest are rescaled.

29/100 Low

Maintained
0GitHub repository is archived
Popular
42119 GitHub stars
Easy to install
250 install platforms, install notes, Docker image
Light to run
100128 MB minimum RAM, runs on ARM
Security check
201 serious finding, 4 minor, CI, tests, OpenSSF Scorecard 4.2/10
GitHub stars
119
Open issues
5
Last commit
2024-08-05
Latest release
v0.7.1
License
Apache-2.0
Activity
stale

Checked 2 days ago - source: GitHub (vmware-tanzu/velero-plugin-for-csi)

Resources & Compatibility

Minimum requirements: 128 MB RAM. ARM (e.g. Raspberry Pi) is supported.

Checked 54 days ago - source: Docker Hub image tags and published docs

First-install notes

  • Tell Velero where to store backups When you run velero install, set the storage provider, backup bucket, and credentials file. If these are wrong, Velero may start but backups will fail or go to the wrong place. source
  • Add the right plugin image Point --plugins at the plugin image for your storage feature (a container image that teaches Velero how to work with that storage). Without the right plugin, Velero may not know how to back up your volumes or cloud storage. source
  • Match snapshot settings to storage Use the snapshot-location-config and volume snapshot settings that match your provider. If snapshot settings are wrong or disabled, data inside persistent volumes (storage attached to your apps) may not be backed up. source
  • Durable snapshots & data mover Environments without durable CSI snapshot support need Velero's CSI snapshot data mover (available from Velero v1.12) to make snapshot data durable before restore. source
  • Repository archived The GitHub repository is archived (last commit August 2024). Confirm the current plugin image tag on Docker Hub before deploying. source
  • Test non-AWS/Azure CSI backends The Velero team does not verify all CSI backends; test thoroughly before using the plugin in production outside AWS or Azure. source

Fetched 38 days ago - each note links to its source

Alternatives

No alternatives collected yet.

Common questions

What Velero feature and plugin are required for CSI snapshot support?

The Velero server must be running with the EnableCSI feature flag. The Velero CSI plugin is necessary to integrate with the CSI volume snapshot APIs.

Which backup storage values should be set during velero install?

Set the storage provider, backup bucket, and credentials file. If these are wrong, Velero may start but backups will fail or go to the wrong place.

How can snapshot settings cause PV data to be missed?

Use the snapshot-location-config and volume snapshot settings that match your provider. If snapshot settings are wrong or disabled, data inside persistent volumes may not be backed up.

Does the CSI plugin work the same with every storage vendor?

It uses the CSI beta snapshot APIs to snapshot CSI-backed PVCs. The actual snapshot implementation varies by storage vendor.

Can it be used with Ceph in a homelab?

A homelab example installed Velero on a bare-metal Kubernetes cluster and used rook-ceph's CSI snapshotter to back up 700+ volumes and 12TB.

Answers sourced from github.com, velero.io, velero.io, www.reddit.com

Community

Collected 49 days ago - public community threads