Velero Helm Chart
Deploy Velero on Kubernetes for cluster backup, restore, migration, and filesystem backup workflows.
This chart uses the official velero/velero image and is intentionally centered on a clear v1 scope:
- explicit plugin init containers
- S3-compatible object storage as the main path
- optional
BackupStorageLocation,VolumeSnapshotLocation, andScheduleresources - optional node-agent DaemonSet for filesystem backup
Features
- Official
velero/veleroimage pinned to the latest stable Velero release - Official CRDs included through the chart
crds/directory - AWS plugin by default for AWS S3 and S3-compatible providers such as MinIO
- BackupStorageLocation resources rendered directly from chart values
- VolumeSnapshotLocation resources rendered when snapshot providers are configured
- Schedule resources for recurring backups
- Optional node-agent for filesystem backup workflows
- Optional ServiceMonitor for Prometheus Operator
- Restricted server and plugin containers with non-root identities, read-only root filesystems, dropped capabilities, and RuntimeDefault seccomp
- NetworkPolicy enabled by default for the server metrics endpoint
- Configurable metrics listener and Service ports connected by a named target port
- Startup, readiness, and liveness probes against the metrics listener
- Extra objects support for carefully reviewed provider-specific resources
Installation
HTTPS repository
helm repo add helmforge https://repo.helmforge.dev
helm repo update
helm install velero helmforge/velero -n velero --create-namespace -f values.yaml
OCI registry
helm install velero oci://ghcr.io/helmforgedev/helm/velero -n velero --create-namespace -f values.yaml
S3-Compatible Example
credentials:
secretContents: |
[default]
aws_access_key_id=minioadmin
aws_secret_access_key=minioadmin123
configuration:
backupStorageLocations:
- name: default
provider: aws
bucket: velero
default: true
config:
region: minio
s3Url: http://minio.minio.svc.cluster.local:9000
s3ForcePathStyle: true
checksumAlgorithm: ""
insecureSkipTLSVerify: true
nodeAgent:
enabled: true
Scheduled Backup Example
schedules:
- name: daily
schedule: "0 3 * * *"
template:
ttl: 168h
includedNamespaces:
- apps
snapshotVolumes: false
defaultVolumesToFsBackup: true
For a complete hardened configuration, see
examples/production.yaml.
Metrics Port Example
The process listener is independent from the Service port. The Service uses a named target so both values can change safely:
metrics:
containerPort: 9085
service:
port: 9090
Values & Configuration Reference
All schema parameters, types, defaults, and allowed values are extracted directly from the chart repository. Filter and search them in the interactive reference below or customize in Values Studio.
|-----|---------|-------------|
| commonAnnotations | {} | Annotations added to chart-owned resource metadata, excluding pod templates |
| image.repository | docker.io/velero/velero | Velero server image |
| image.tag | v1.18.4 | Velero server image tag |
| plugins.aws.tag | v1.14.0 | Default AWS/S3 plugin image tag |
| credentials.useSecret | true | Mount credentials when existingSecret, name, or secretContents is set |
| credentials.existingSecret | "" | Existing credentials secret |
| configuration.backupStorageLocations | one empty default entry | Backup storage definitions |
| configuration.backupStorageLocations[].config.checksumAlgorithm | unset (CRC32 upstream) | S3 checksum algorithm; set "" to disable checksum headers |
| configuration.volumeSnapshotLocations | [] | Snapshot storage definitions |
| configuration.defaultVolumesToFsBackup | false | Default filesystem backup mode |
| nodeAgent.enabled | false | Deploy filesystem backup DaemonSet |
| schedules | [] | Schedule resources created by the chart |
| metrics.containerPort | 8085 | Port listened on by the Velero process |
| metrics.service.port | 8085 | Metrics Service port |
| service.ipFamilyPolicy | "" | Optional metrics Service IP family policy |
| metrics.serviceMonitor.enabled | false | Create a ServiceMonitor |
| networkPolicy.enabled | true | Isolate the Velero server pod |
| networkPolicy.allowExternalEgress | true | Allow Kubernetes API and object-storage egress |
| extraManifests | [] | Additional manifests rendered with tpl |
Architecture Guides
Resources Generated
| Resource | Condition |
|---|---|
| ServiceAccount | serviceAccount.server.create |
| ClusterRoleBinding | rbac.create and rbac.clusterAdministrator |
| Secret | credentials.useSecret and no credentials.existingSecret |
| Deployment | Always |
DaemonSet node-agent |
nodeAgent.enabled |
| Service | metrics.enabled |
| ServiceMonitor | metrics.serviceMonitor.enabled |
| NetworkPolicy | networkPolicy.enabled |
| BackupStorageLocation | one per configuration.backupStorageLocations entry |
| VolumeSnapshotLocation | one per configuration.volumeSnapshotLocations entry |
| Schedule | one per schedules entry |
| Extra manifests | one per extraManifests entry |
Notes
- this v1 chart is intentionally focused on clear install and configuration flows, not on abstracting every Velero provider combination
- for S3-compatible storage, use the AWS plugin with explicit
s3Urlands3ForcePathStylesettings when required by the provider - if you enable
nodeAgent, validate hostPath and Pod Security expectations in your cluster before relying on filesystem backups - the server and default AWS plugin run as non-root with restricted security contexts; the optional node-agent runs as UID 0 because filesystem backup requires kubelet host-path access
- NetworkPolicy egress is open by default because the Kubernetes API and
object-storage endpoints are installation-specific; set
networkPolicy.allowExternalEgress=falsebefore adding a restrictive environment-specific policy, because NetworkPolicy rules are additive - when the node-agent uses Kopia, the chart mounts ephemeral writable
/home/cnb/udmrepoand/home/cnb/.cachepaths in the server and node-agent while keeping their root filesystems read-only
Velero v1.18.4 fixes a backup queue that could remain stuck when a dequeued backup completed during its status patch. Review the upstream release before upgrading production recovery infrastructure.
Troubleshooting
If the Deployment is not ready, inspect the server logs and the status of the configured backup storage locations:
kubectl logs deployment/velero -n velero --all-containers
kubectl get backupstoragelocations.velero.io -n velero -o yaml
An unavailable backup storage location normally indicates invalid provider
credentials, an unreachable endpoint, a missing bucket, or an incompatible
plugin. If probes fail after changing ports, confirm
metrics.containerPort matches the --metrics-address argument in the pod;
metrics.service.port affects only the Service-facing port. See the
operations guide for recovery checks and upgrade notes.
Security Scan
Security Scan: velero
| Framework | Score |
|---|---|
| MITRE + NSA + SOC2 | 77.27273% |
Security posture acceptable.
More Information
System Architecture
DESIGN.md SyncedVerified architecture contract rendered dynamically from GitHub DESIGN.md
flowchart TD values[Helm values] --> deploy[Velero Deployment] values --> bsl[BackupStorageLocation] values --> vsl[VolumeSnapshotLocation] values --> schedules[Schedule resources] values --> metrics[Metrics Service] values --> nodeAgent[Node-agent DaemonSet] credentials[Credentials Secret] --> deploy credentials --> nodeAgent plugins[Provider plugin init containers] --> deploy deploy --> objectStore[S3 or S3-compatible object storage] nodeAgent --> podVolumes[Pod volume host paths] schedules --> backups[Velero Backup resources] backups --> objectStore
Velero Values Schema Reference
Official schema parameters, default values, and types extracted directly from the chart repository.
Global(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| global | object | - | Global settings shared by the chart. |
Name Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nameOverride | string | - | Override the chart name used in resource names |
Fullname Override(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| fullnameOverride | string | - | Override the full release name used in resource names |
Common Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonLabels | object | - | Labels added to every resource created by this chart |
Common Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| commonAnnotations | object | - | Annotations added to chart-owned resource metadata, excluding pod templates |
Image(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| image.repository | string | - | Velero server image repository |
| image.tag | string | - | Velero server image tag (defaults to appVersion when empty) |
| image.pullPolicy | string | - | Image pull policy Allowed: AlwaysIfNotPresentNever |
Image Pull Secrets(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| imagePullSecrets | array | - | Image pull secrets for private registries |
Plugins(12)
| Parameter | Type | Default | Description |
|---|---|---|---|
| plugins.enabled | boolean | - | Enable the default AWS/S3-compatible plugin init container |
| plugins.aws.name | string | - | Init container name for the AWS plugin |
| plugins.aws.repository | string | - | AWS plugin image repository |
| plugins.aws.tag | string | - | AWS plugin image tag |
| plugins.aws.pullPolicy | string | - | AWS plugin image pull policy Allowed: AlwaysIfNotPresentNever |
| plugins.aws.securityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| plugins.aws.securityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| plugins.aws.securityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| plugins.aws.securityContext.runAsUser | integer | - | Chart configuration parameter |
| plugins.aws.securityContext.runAsGroup | integer | - | Chart configuration parameter |
| plugins.aws.securityContext.capabilities.drop | array | - | Chart configuration parameter |
| plugins.extra | array | - | Extra plugin init containers appended after the default AWS plugin |
Credentials(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| credentials.useSecret | boolean | - | Mount a credentials secret into the Velero pods |
| credentials.existingSecret | string | - | Existing secret containing the credentials file |
| credentials.name | string | - | Secret name to create when existingSecret is empty |
| credentials.key | string | - | Key used inside the credentials secret |
| credentials.secretContents | string | - | Full credentials file content used when creating the secret inline |
| credentials.extraEnvVars | object | - | Extra environment variables loaded from the credentials secret |
| credentials.extraSecretRef | string | - | Existing secret reference loaded through envFrom |
Service Account(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| serviceAccount.server.create | boolean | - | Create the Velero service account |
| serviceAccount.server.name | string | - | Existing service account name |
| serviceAccount.server.annotations | object | - | Annotations added to the service account |
| serviceAccount.server.labels | object | - | Labels added to the service account |
| serviceAccount.server.automountServiceAccountToken | boolean | - | Automount the API token into the pod |
Rbac(3)
| Parameter | Type | Default | Description |
|---|---|---|---|
| rbac.create | boolean | - | Create a ClusterRoleBinding for the Velero service account |
| rbac.clusterAdministrator | boolean | - | Bind the service account to cluster-admin |
| rbac.clusterAdministratorName | string | - | ClusterRole name bound when clusterAdministrator is true |
Configuration(15)
| Parameter | Type | Default | Description |
|---|---|---|---|
| configuration.namespace | string | - | Kubernetes namespace watched by the Velero server (defaults to release namespace) |
| configuration.uploaderType | string | - | Uploader type used by Velero Allowed: kopiarestic |
| configuration.defaultBackupTTL | string | - | Default backup TTL applied by the server |
| configuration.defaultItemOperationTimeout | string | - | Default item operation timeout |
| configuration.storeValidationFrequency | string | - | Default storage validation frequency |
| configuration.metricsAddress | string | - | Deprecated pre-1.6 metrics listener; prefer metrics.containerPort |
| configuration.logLevel | string | - | Server log level Allowed: tracedebuginfowarningerrorfatalpanic |
| configuration.logFormat | string | - | Server log format Allowed: textjson |
| configuration.restoreOnlyMode | boolean | - | Start the server in restore-only mode |
| configuration.defaultVolumesToFsBackup | boolean | - | Enable filesystem backup by default for pod volumes |
| configuration.features | string | - | Comma-separated Velero feature flags |
| configuration.extraArgs | array | - | Additional server arguments |
| configuration.extraEnvVars | array | - | Additional environment variables for the Velero server and node-agent |
| configuration.backupStorageLocations | array | - | Backup storage location definitions |
| configuration.volumeSnapshotLocations | array | - | Volume snapshot location definitions |
Schedules(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| schedules | array | - | Velero backup schedule definitions |
Pod Annotations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podAnnotations | object | - | Extra annotations for pods |
Pod Labels(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podLabels | object | - | Extra labels for pods |
Pod Security(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| podSecurityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| podSecurityContext.runAsUser | integer | - | Chart configuration parameter |
| podSecurityContext.runAsGroup | integer | - | Chart configuration parameter |
| podSecurityContext.fsGroup | integer | - | Chart configuration parameter |
| podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
Container Security Context(7)
| Parameter | Type | Default | Description |
|---|---|---|---|
| containerSecurityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| containerSecurityContext.runAsNonRoot | boolean | - | Chart configuration parameter |
| containerSecurityContext.runAsUser | integer | - | Chart configuration parameter |
| containerSecurityContext.runAsGroup | integer | - | Chart configuration parameter |
| containerSecurityContext.capabilities.drop | array | - | Chart configuration parameter |
| containerSecurityContext.privileged | boolean | - | Chart configuration parameter |
| containerSecurityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
Resources(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| resources | object | - | Resource requests and limits for the Velero server |
Priority Class Name(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| priorityClassName | string | - | Priority class name for pods |
Runtime Class Name(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| runtimeClassName | string | - | Runtime class name for pods |
Termination Grace Period Seconds(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| terminationGracePeriodSeconds | integer | - | Termination grace period in seconds |
Node Selector(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeSelector | object | - | Node selector for pod scheduling |
Tolerations(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| tolerations | array | - | Tolerations for pod scheduling |
Affinity(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| affinity | object | - | Affinity rules for pod scheduling |
Dns Policy(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| dnsPolicy | string | - | DNS policy for pods |
Dns Config(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| dnsConfig | object | - | DNS configuration for pods |
Host Aliases(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| hostAliases | array | - | Host aliases for pods |
Extra Volumes(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumes | array | - | Extra volumes for pods |
Extra Volume Mounts(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraVolumeMounts | array | - | Extra volume mounts for containers |
Node Agent(28)
| Parameter | Type | Default | Description |
|---|---|---|---|
| nodeAgent.enabled | boolean | - | Deploy the Velero node-agent DaemonSet for filesystem backup |
| nodeAgent.disableHostPath | boolean | - | Disable hostPath mounts in the node-agent |
| nodeAgent.podVolumePath | string | - | Host path to pod volumes |
| nodeAgent.pluginVolumePath | string | - | Host path to kubelet plugins |
| nodeAgent.useScratchEmptyDir | boolean | - | Mount an emptyDir scratch volume into the node-agent |
| nodeAgent.podSecurityContext.seccompProfile.type | string | - | Chart configuration parameter |
| nodeAgent.containerSecurityContext.allowPrivilegeEscalation | boolean | - | Chart configuration parameter |
| nodeAgent.containerSecurityContext.capabilities.drop | array | - | Chart configuration parameter |
| nodeAgent.containerSecurityContext.privileged | boolean | - | Chart configuration parameter |
| nodeAgent.containerSecurityContext.readOnlyRootFilesystem | boolean | - | Chart configuration parameter |
| nodeAgent.containerSecurityContext.runAsUser | integer | - | Chart configuration parameter |
| nodeAgent.resources | object | - | Resource requests and limits for node-agent |
| nodeAgent.updateStrategy | object | - | DaemonSet update strategy |
| nodeAgent.priorityClassName | string | - | Priority class name for node-agent pods |
| nodeAgent.runtimeClassName | string | - | Runtime class name for node-agent pods |
| nodeAgent.nodeSelector | object | - | Node selector for node-agent pods |
| nodeAgent.tolerations | array | - | Tolerations for node-agent pods |
| nodeAgent.affinity | object | - | Affinity rules for node-agent pods |
| nodeAgent.dnsPolicy | string | - | DNS policy for node-agent pods |
| nodeAgent.dnsConfig | object | - | DNS configuration for node-agent pods |
| nodeAgent.hostAliases | array | - | Host aliases for node-agent pods |
| nodeAgent.annotations | object | - | Annotations for the node-agent DaemonSet |
| nodeAgent.labels | object | - | Labels for the node-agent DaemonSet |
| nodeAgent.podLabels | object | - | Extra labels for node-agent pods |
| nodeAgent.extraArgs | array | - | Extra arguments for node-agent |
| nodeAgent.extraEnvVars | array | - | Extra environment variables for node-agent |
| nodeAgent.extraVolumes | array | - | Extra volumes for node-agent pods |
| nodeAgent.extraVolumeMounts | array | - | Extra volume mounts for node-agent containers |
Metrics & Observability(12)
| Parameter | Type | Default | Description |
|---|---|---|---|
| metrics.enabled | boolean | - | Expose Velero metrics on a Service |
| metrics.containerPort | integer | - | Port listened on by the Velero metrics server |
| metrics.service.annotations | object | - | Service annotations for Velero metrics |
| metrics.service.labels | object | - | Service labels for Velero metrics |
| metrics.service.type | string | - | Service type Allowed: ClusterIPNodePortLoadBalancer |
| metrics.service.port | integer | - | Metrics port |
| metrics.serviceMonitor.enabled | boolean | - | Create a ServiceMonitor for Prometheus Operator |
| metrics.serviceMonitor.annotations | object | - | ServiceMonitor annotations |
| metrics.serviceMonitor.additionalLabels | object | - | Additional ServiceMonitor labels |
| metrics.serviceMonitor.namespace | string | - | ServiceMonitor namespace (defaults to release namespace) |
| metrics.serviceMonitor.interval | string | - | Metrics scrape interval |
| metrics.serviceMonitor.scrapeTimeout | string | - | Metrics scrape timeout |
Liveness Probe(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| livenessProbe.enabled | boolean | - | Chart configuration parameter |
| livenessProbe.initialDelaySeconds | integer | - | Chart configuration parameter |
| livenessProbe.periodSeconds | integer | - | Chart configuration parameter |
| livenessProbe.timeoutSeconds | integer | - | Chart configuration parameter |
| livenessProbe.failureThreshold | integer | - | Chart configuration parameter |
Readiness Probe(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| readinessProbe.enabled | boolean | - | Chart configuration parameter |
| readinessProbe.initialDelaySeconds | integer | - | Chart configuration parameter |
| readinessProbe.periodSeconds | integer | - | Chart configuration parameter |
| readinessProbe.timeoutSeconds | integer | - | Chart configuration parameter |
| readinessProbe.failureThreshold | integer | - | Chart configuration parameter |
Startup Probe(5)
| Parameter | Type | Default | Description |
|---|---|---|---|
| startupProbe.enabled | boolean | - | Chart configuration parameter |
| startupProbe.initialDelaySeconds | integer | - | Chart configuration parameter |
| startupProbe.periodSeconds | integer | - | Chart configuration parameter |
| startupProbe.timeoutSeconds | integer | - | Chart configuration parameter |
| startupProbe.failureThreshold | integer | - | Chart configuration parameter |
Network Policy(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| networkPolicy.enabled | boolean | - | Chart configuration parameter |
| networkPolicy.allowExternalEgress | boolean | - | Chart configuration parameter |
Service & Networking(2)
| Parameter | Type | Default | Description |
|---|---|---|---|
| service.ipFamilyPolicy | string | - | Service IP family policy Allowed: SingleStackPreferDualStackRequireDualStack |
| service.ipFamilies | array | - | Ordered Service IP families |
Extra Manifests(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraManifests | array | - | Additional manifests rendered with tpl |
Extra Objects(1)
| Parameter | Type | Default | Description |
|---|---|---|---|
| extraObjects | array | - | Deprecated pre-1.6 alias for extraManifests |
No schema parameters match your search
Try searching for a different keyword or reset the filter.