homelab/build/config/ansible/roles/pve_backup/defaults/main.yml
Russell Seymour 1250c9cef6
Some checks are pending
deploy / deploy (push) Waiting to run
Initial checkin of code for managing homelab
2026-08-24 20:52:36 +01:00

61 lines
2.4 KiB
YAML

---
# Backup storage on the NAS, and the vzdump job that writes to it. Override
# per-node in inventory/host_vars/<node>.yml.
# Name the storage appears under in Proxmox. Also what `pve_backup_job`
# targets.
pve_backup_storage: nas-backup
# `nfs` or `pbs`. NFS is the plain option and needs nothing on the NAS beyond
# an export; PBS gets deduplication and incremental backups but needs a Proxmox
# Backup Server to exist first. See tasks/main.yml for what each consumes.
pve_backup_storage_type: nfs
# NFS (pve_backup_storage_type: nfs)
pve_backup_nfs_server: ""
pve_backup_nfs_export: ""
# 4.2 rather than 3: better locking and no separate portmapper.
pve_backup_nfs_options: vers=4.2
# PBS (pve_backup_storage_type: pbs)
pve_backup_pbs_server: ""
pve_backup_pbs_datastore: ""
pve_backup_pbs_username: ""
pve_backup_pbs_password: ""
pve_backup_pbs_fingerprint: ""
# How many archives the storage keeps. Proxmox prunes archives, not their
# contents — anything inside a guest (such as Forgejo's nightly pg_dump output)
# is pruned by that guest, on its own schedule.
pve_backup_prune:
keep-daily: 7
keep-weekly: 4
keep-monthly: 6
# systemd calendar event. Guests that dump a database into their own filesystem
# first must finish before this — see src/forgejo/ansible/proxmox/README.md.
pve_backup_schedule: "02:00"
# Stable marker used to find this job again on later runs. The Proxmox API
# assigns job IDs itself, so matching on the comment is what makes this
# idempotent rather than creating a duplicate job every deploy.
pve_backup_comment: managed-by-homelab-iac
# Which guests to back up. `true` covers everything on the node, including
# guests added later without an edit here; set it false and list VMIDs in
# pve_backup_vmids to be selective.
pve_backup_all: true
pve_backup_vmids: []
# snapshot: no downtime, and the guest filesystem is captured as if it had
# crashed at that instant. Fine for Forgejo — git repositories tolerate it, and
# the database is a separate consistent dump rather than live files.
pve_backup_mode: snapshot
pve_backup_compress: zstd
pve_backup_enabled: true
# Optional: address Proxmox mails backup reports to. Left empty means the node
# default applies. PVE 8 moved most of this to its notification-target system;
# `mailto` still works, but if you want anything richer, configure a
# notification target in the UI rather than extending this role.
pve_backup_mailto: ""