b'nerd Backup Operator
A Kubernetes operator for managing automated Restic-based volume backups, restores, and snapshot-based backups. Built with the Kopf framework.
What You Can Do
- Scheduled Backups -- Automatically back up Kubernetes PersistentVolumeClaims on a cron schedule
- One-Click Restores -- Restore data to new or existing PVCs from any backup snapshot
- Snapshot Backups -- Create point-in-time backups from OpenStack Cinder volume snapshots
- S3 Bucket Backups -- Back up entire S3-compatible buckets (AWS, Ceph, MinIO) to a Restic repository
- Integrity Checks -- Periodic repository verification with configurable data subset scanning
- Restore Testing -- Automated random file restore tests with SHA-256 checksum verification
- Webhook Notifications -- HTTP callbacks on backup success or failure
- Prometheus Metrics -- Full observability with pre-built alerts and Grafana dashboard
- Multi-Cluster Support -- Back up volumes from remote clusters via kubeconfig
Custom Resources
| CRD |
Short Name |
Description |
| VolumeBackup |
vbkp |
Scheduled PVC backup via CronJob |
| VolumeRestore |
vrestore, vr |
One-time restore to a new or existing PVC |
| VolumeSnapshotBackup |
vsb |
OpenStack Cinder snapshot-based backup |
| S3Backup |
s3bkp |
S3 bucket-to-repository backup |
Supported Repository Backends
All Restic-supported storage backends are available:
| Backend |
URL Format |
Example |
| Amazon S3 / S3-compatible |
s3:endpoint/bucket/path |
s3:s3.amazonaws.com/my-bucket/backups |
| Google Cloud Storage |
gs:bucket/path |
gs:my-gcs-bucket/backups |
| Azure Blob Storage |
azure:container/path |
azure:my-container/backups |
| Local / NFS |
local:/path |
local:/mnt/backup-storage |
| SFTP |
sftp:host:/path |
sftp:backup-server:/data/restic |
| REST Server |
rest:url |
rest:https://backup.example.com/repo |
Prerequisites
- Kubernetes 1.19+
- Helm 3.x (for Helm installation)
- A supported storage backend for Restic repositories
- OpenStack credentials (only for VolumeSnapshotBackup)
Version Info
| Component |
Version |
| Operator |
0.10.2 |
| Helm Chart |
0.6.2 |
| Default Restic Image |
0.18.1 |
Quick Links