# vmware-tanzu/velero architecture

> Architecture diagram of the GitHub repository vmware-tanzu/velero, generated by GitDiagram from its file tree, README and a sample of source files (last updated 2026-10-02). It is an AI-made overview: check details against the source.

- Interactive diagram: https://gitdiagram.com/vmware-tanzu/velero
- Repository: https://github.com/vmware-tanzu/velero

## Overview

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: [`pkg/controller`](https://github.com/vmware-tanzu/velero/tree/main/pkg/controller) (Controllers), [`pkg/datapath/manager.go`](https://github.com/vmware-tanzu/velero/blob/main/pkg/datapath/manager.go) (Data path), [`pkg/cmd/server/server.go`](https://github.com/vmware-tanzu/velero/blob/main/pkg/cmd/server/server.go) (Velero server), [`pkg/restore/restore.go`](https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restore.go) (Restore engine)

## Diagram (Mermaid)

```mermaid
flowchart TD

subgraph group_entry["User entry points"]
  node_cli["Velero CLI"]
end

subgraph group_control["Server control plane"]
  node_server["Velero server<br/>[server.go]"]
  node_controllers["Controllers"]
  node_bsl["Backup locations"]
end

subgraph group_resource["Resource backup and restore"]
  node_backup["Backup engine<br/>[backup.go]"]
  node_restore["Restore engine<br/>[restore.go]"]
  node_hooks["Restore hooks"]
end

subgraph group_volume["Volume data movement"]
  node_datadownload["Data download"]
  node_dataupload["Data upload"]
  node_datapath["Data path<br/>[manager.go]"]
  node_datamover["Data mover"]
  node_podvolume["Pod-volume service"]
end

subgraph group_ext["Storage and extensions"]
  node_repository["Repository manager<br/>[manager.go]"]
  node_objectstore[("Backup object store<br/>[object_store.go]")]
  node_plugins["Plugin manager<br/>[manager.go]"]
  node_pluginframework["Plugin framework<br/>[server.go]"]
end

node_user(("Cluster operator"))
node_kubernetes{{"Kubernetes cluster"}}

node_user -->|"runs commands"| node_cli
node_cli -.->|"initiates operations"| node_server
node_server -->|"configures"| node_controllers
node_controllers -->|"coordinates backup"| node_backup
node_controllers -.->|"coordinates restore"| node_restore
node_controllers -.->|"reconciles locations"| node_bsl
node_bsl -->|"validates store"| node_objectstore
node_backup -.->|"stores backups"| node_objectstore
node_restore -.->|"reads backups"| node_objectstore
node_restore -.->|"runs hooks"| node_hooks
node_controllers -->|"reconciles downloads"| node_datadownload
node_controllers -->|"reconciles uploads"| node_dataupload
node_datadownload -->|"creates data path"| node_datapath
node_dataupload -->|"creates data path"| node_datapath
node_datapath -->|"watches services"| node_datamover
node_datamover -->|"uses repository"| node_repository
node_datamover -->|"starts backup"| node_datapath
node_podvolume -->|"starts backup"| node_datapath
node_repository -.->|"accesses storage"| node_objectstore
node_server -.->|"initializes plugins"| node_plugins
node_plugins -->|"uses framework"| node_pluginframework
node_server -.->|"manages resources"| node_kubernetes
node_backup -->|"backs up resources"| node_kubernetes
node_restore -->|"restores resources"| node_kubernetes

click node_cli "https://github.com/vmware-tanzu/velero/tree/main/pkg/cmd/cli"
click node_server "https://github.com/vmware-tanzu/velero/blob/main/pkg/cmd/server/server.go"
click node_controllers "https://github.com/vmware-tanzu/velero/tree/main/pkg/controller"
click node_bsl "https://github.com/vmware-tanzu/velero/blob/main/pkg/controller/backup_storage_location_controller.go"
click node_backup "https://github.com/vmware-tanzu/velero/blob/main/pkg/backup/backup.go"
click node_restore "https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restore.go"
click node_hooks "https://github.com/vmware-tanzu/velero/blob/main/internal/hook/item_hook_handler.go"
click node_datadownload "https://github.com/vmware-tanzu/velero/blob/main/pkg/controller/data_download_controller.go"
click node_dataupload "https://github.com/vmware-tanzu/velero/blob/main/pkg/controller/data_upload_controller.go"
click node_datapath "https://github.com/vmware-tanzu/velero/blob/main/pkg/datapath/manager.go"
click node_datamover "https://github.com/vmware-tanzu/velero/blob/main/pkg/datamover/backup_micro_service.go"
click node_podvolume "https://github.com/vmware-tanzu/velero/blob/main/pkg/podvolume/backup_micro_service.go"
click node_repository "https://github.com/vmware-tanzu/velero/blob/main/pkg/repository/manager/manager.go"
click node_objectstore "https://github.com/vmware-tanzu/velero/blob/main/pkg/persistence/object_store.go"
click node_plugins "https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/clientmgmt/manager.go"
click node_pluginframework "https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/framework/server.go"

classDef toneNeutral fill:#f8fafc,stroke:#334155,stroke-width:1.5px,color:#0f172a
classDef toneBlue fill:#dbeafe,stroke:#2563eb,stroke-width:1.5px,color:#172554
classDef toneAmber fill:#fef3c7,stroke:#d97706,stroke-width:1.5px,color:#78350f
classDef toneMint fill:#dcfce7,stroke:#16a34a,stroke-width:1.5px,color:#14532d
classDef toneRose fill:#ffe4e6,stroke:#e11d48,stroke-width:1.5px,color:#881337
classDef toneIndigo fill:#e0e7ff,stroke:#4f46e5,stroke-width:1.5px,color:#312e81
classDef toneTeal fill:#ccfbf1,stroke:#0f766e,stroke-width:1.5px,color:#134e4a
class node_cli toneBlue
class node_server,node_controllers,node_bsl toneAmber
class node_backup,node_restore,node_hooks toneMint
class node_datadownload,node_dataupload,node_datapath,node_datamover,node_podvolume toneRose
class node_repository,node_objectstore,node_plugins,node_pluginframework,node_user,node_kubernetes toneIndigo
```

## Components

### User entry points

- [Velero CLI](https://github.com/vmware-tanzu/velero/tree/main/pkg/cmd/cli): `pkg/cmd/cli`

### Server control plane

- [Velero server](https://github.com/vmware-tanzu/velero/blob/main/pkg/cmd/server/server.go): `pkg/cmd/server/server.go`
- [Controllers](https://github.com/vmware-tanzu/velero/tree/main/pkg/controller): `pkg/controller`
- [Backup locations](https://github.com/vmware-tanzu/velero/blob/main/pkg/controller/backup_storage_location_controller.go): `pkg/controller/backup_storage_location_controller.go`

### Resource backup and restore

- [Backup engine](https://github.com/vmware-tanzu/velero/blob/main/pkg/backup/backup.go): `pkg/backup/backup.go`
- [Restore engine](https://github.com/vmware-tanzu/velero/blob/main/pkg/restore/restore.go): `pkg/restore/restore.go`
- [Restore hooks](https://github.com/vmware-tanzu/velero/blob/main/internal/hook/item_hook_handler.go): `internal/hook/item_hook_handler.go`

### Volume data movement

- [Data download](https://github.com/vmware-tanzu/velero/blob/main/pkg/controller/data_download_controller.go): `pkg/controller/data_download_controller.go`
- [Data upload](https://github.com/vmware-tanzu/velero/blob/main/pkg/controller/data_upload_controller.go): `pkg/controller/data_upload_controller.go`
- [Data path](https://github.com/vmware-tanzu/velero/blob/main/pkg/datapath/manager.go): `pkg/datapath/manager.go`
- [Data mover](https://github.com/vmware-tanzu/velero/blob/main/pkg/datamover/backup_micro_service.go): `pkg/datamover/backup_micro_service.go`
- [Pod-volume service](https://github.com/vmware-tanzu/velero/blob/main/pkg/podvolume/backup_micro_service.go): `pkg/podvolume/backup_micro_service.go`

### Storage and extensions

- [Repository manager](https://github.com/vmware-tanzu/velero/blob/main/pkg/repository/manager/manager.go): `pkg/repository/manager/manager.go`
- [Backup object store](https://github.com/vmware-tanzu/velero/blob/main/pkg/persistence/object_store.go): `pkg/persistence/object_store.go`
- [Plugin manager](https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/clientmgmt/manager.go): `pkg/plugin/clientmgmt/manager.go`
- [Plugin framework](https://github.com/vmware-tanzu/velero/blob/main/pkg/plugin/framework/server.go): `pkg/plugin/framework/server.go`

### Other components

- **Cluster operator**
- **Kubernetes cluster**

## Connections

- Cluster operator → Velero CLI: runs commands (evidence: `README.md`)
- Velero CLI → Velero server: initiates operations
- Velero server → Controllers: configures (evidence: `pkg/cmd/server/server.go`)
- Controllers → Backup engine: coordinates backup (evidence: `pkg/controller/backup_controller.go`)
- Controllers → Restore engine: coordinates restore
- Controllers → Backup locations: reconciles locations
- Backup locations → Backup object store: validates store (evidence: `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 (evidence: `pkg/controller/data_download_controller.go`)
- Data upload → Data path: creates data path (evidence: `pkg/controller/data_upload_controller.go`)
- Data path → Data mover: watches services
- Data mover → Repository manager: uses repository (evidence: `pkg/datamover/backup_micro_service.go`)
- Data mover → Data path: starts backup (evidence: `pkg/datamover/backup_micro_service.go`)
- Pod-volume service → Data path: starts backup (evidence: `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 (evidence: `pkg/plugin/clientmgmt/manager.go`)
- Velero server → Kubernetes cluster: manages resources
- Backup engine → Kubernetes cluster: backs up resources (evidence: `README.md`)
- Restore engine → Kubernetes cluster: restores resources (evidence: `README.md`)
