How vmware-tanzu/velero works
Velero is a Kubernetes backup and restore product with a local CLI and an in-cluster server. The main workflow is a user initiating backup or restore operations through the CLI, with server controllers coordinating resource handling and persistent-volume data movement to storage; restored resources and volume data are applied back to Kubernetes. The repository also includes scheduled operations, plugins, hooks, and storage-location management. Some subsystem links below are documented by the README or SOURCE INDEX; unsampled implementation details are not asserted.
Main entry points: controller Controllers · manager.go Data path · server.go Velero server · restore.go Restore engine
Components 18
User entry points
- Velero CLI
pkg/cmd/cli
Server control plane
- Velero server
pkg/cmd/server/server.go - Controllers
pkg/controller - Backup locations
pkg/controller/backup_storage_location_controller.go
Resource backup and restore
- Backup engine
pkg/backup/backup.go - Restore engine
pkg/restore/restore.go - Restore hooks
internal/hook/item_hook_handler.go
Volume data movement
- Data download
pkg/controller/data_download_controller.go - Data upload
pkg/controller/data_upload_controller.go - Data path
pkg/datapath/manager.go - Data mover
pkg/datamover/backup_micro_service.go - Pod-volume service
pkg/podvolume/backup_micro_service.go
Storage and extensions
- Repository manager
pkg/repository/manager/manager.go - Backup object store
pkg/persistence/object_store.go - Plugin manager
pkg/plugin/clientmgmt/manager.go - Plugin framework
pkg/plugin/framework/server.go
Other components
- Cluster operator
- Kubernetes cluster
Connections 24
- Cluster operator → Velero CLI: runs commands
README.md - Velero CLI → Velero server: initiates operations
- Velero server → Controllers: configures
pkg/cmd/server/server.go - Controllers → Backup engine: coordinates backup
pkg/controller/backup_controller.go - Controllers → Restore engine: coordinates restore
- Controllers → Backup locations: reconciles locations
- Backup locations → Backup object store: validates store
pkg/controller/backup_storage_location_controller.go - Backup engine → Backup object store: stores backups
- Restore engine → Backup object store: reads backups
- Restore engine → Restore hooks: runs hooks
- Controllers → Data download: reconciles downloads
- Controllers → Data upload: reconciles uploads
- Data download → Data path: creates data path
pkg/controller/data_download_controller.go - Data upload → Data path: creates data path
pkg/controller/data_upload_controller.go - Data path → Data mover: watches services
- Data mover → Repository manager: uses repository
pkg/datamover/backup_micro_service.go - Data mover → Data path: starts backup
pkg/datamover/backup_micro_service.go - Pod-volume service → Data path: starts backup
pkg/podvolume/backup_micro_service.go - Repository manager → Backup object store: accesses storage
- Velero server → Plugin manager: initializes plugins
- Plugin manager → Plugin framework: uses framework
pkg/plugin/clientmgmt/manager.go - Velero server → Kubernetes cluster: manages resources
- Backup engine → Kubernetes cluster: backs up resources
README.md - Restore engine → Kubernetes cluster: restores resources
README.md