canasta backup schedule set

From Canasta Wiki

canasta > backup > backup schedule > set

canasta backup schedule set

Set a recurring backup schedule

Synopsis

Schedule recurring backups using a cron expression. The cron expression follows the standard 5-field format minute hour day-of-month month day-of-week.

This writes a crontab entry on the host where the instance runs (the instance's host for Compose, the control-plane node for Kubernetes) that runs canasta backup create -i <id> --tag scheduled on the schedule; output goes to backup.log in the instance directory. canasta must be installed on that host — on a remote or Kubernetes instance, set it up first with canasta install canasta -H <host>.

Use --purge-older-than to chain canasta backup purge --keep-within <duration> after each backup, so old snapshots are pruned without a separate maintenance run.

The schedule is persisted to config/backup-schedule.yml (captured by backups, re-materialized on restore). Setting a new schedule replaces the existing crontab entry in place; duplicates aren't created.

canasta backup schedule set [flags]

Examples

canasta backup schedule set '0 2 * * *'
canasta backup schedule set '0 3 * * *' --purge-older-than 30d

Flags

Flag Shorthand Description Default Required Orchestrator
--cron-expression Cron expression for the schedule Both
--id -i Canasta instance ID * Both
--purge-older-than Purge backups older than this on each scheduled run Both

* Defaults to the Canasta instance matching the current directory, if any.

Global flags

Flag Shorthand Description Default Required Orchestrator
--help -h Show help message and exit Both
--verbose -v Enable verbose output Both