Skip to content

Parameters ​

Parameters are grouped and documented inline in values.yaml (## @param). Key sections:

SectionHighlights
image, initImageagent image (defaults to appVersion)
borgversion, repoBase, passphrase, remotePath, retention, archive naming — see Borg 1 and Borg 2; checkSchedule/backupSchedule for managed agents, keyed by pod hostname — see Check and backup schedules
s3S3 sources mounted via s3fs: endpoint, region, mountPath, credentials, verifyListing, onMountFailure — see S3 buckets
ssh, databasesSSH key + MariaDB/MySQL/PostgreSQL/MongoDB logical-dump and Redis/Valkey RDB configs (→ Secrets)
node / clusterthe two backup scopes. node is the DaemonSet; cluster is the CronJob and the console/agent StatefulSet (they share cluster.nodeName/resources/extraVolumes/nodeSelector/affinity/tolerations, pinned to the storage node). cluster.mode (legacy/agent) and cluster.backupMode (cronjob/plan) select enrollment and scheduling. Borg include/exclude patterns (+ cluster.s3Buckets) live under each scope: node.include/node.exclude, cluster.include/cluster.exclude. node.datastoreSnapshot adds the cluster datastore — see Cluster datastore snapshot
borgUIoptional server (Deployment/Service/Ingress), agentConnection, reconcile Job, oidc, remoteMachines, notifications (see Notification channels), redis (archive-listing cache: mode: internal deploys a dedicated Redis pod that survives UI-pod rolls, or external points at an existing instance)
persistenceNFS source, cache, UI state PVCs (+ optional static NFS PVs)
repoServeroptional repository server: sshd + borg serve, clients from authorized_keys in the ssh Secret, service, persistence — see Repository server

Upgrade note (1.0.21): two breaking value renames — the chart fails fast if the old sections are still set.

  • app merged into cluster: app.mode→cluster.mode, app.agentScripts→cluster.agentScripts, drop app.enabled/app.nodeName/… — the console pod now shares the cluster.* pod settings with the CronJob.
  • config split into node/cluster: config.clusterInclude→cluster.include, config.clusterExclude→cluster.exclude, config.s3Buckets→cluster.s3Buckets, config.nodeInclude→node.include, config.nodeExclude→node.exclude.

Distributed under the AGPL-3.0-only license.