Skip to content
SHC Docs

shc backup schedule

manage scheduled backups

Register, remove, list, and fire per-scope backup schedules. A schedule fires on the cluster leader and backs up every deployment the scope matches.

A scheduled fire takes the orchestrated path, the one that freezes the stack, escalates to a stop past the hold, and captures host binds, unbound named volumes and converter artifacts. Its finished .bak is then sealed into backup.repo under backup.password, verified readable there, and the local plaintext copy removed; the archive’s location becomes restic::.

Scheduled backups are restic-only. schedule set refuses a scope with no backup.repo, and one whose backup.repo has no backup.password. A fire whose scope lost its repo or its key after the schedule was set is skipped before it captures anything, with X400079BKPSKD naming what to set. shc backup ls -o json reports each archive’s encryption and location; shc doctor run reports the estate’s posture.

shc backup schedule [flags]
-h, --help help for schedule
--config stringArray extra YAML config file to layer on top of auto-discovered config; repeatable, later files win
-d, --debug enable debug mode (default: $SHC_DEBUG)
-e, --environment string environment name (default: "prod", or "default" on an estate with no licence and no trial; $SHC_ENVIRONMENT and shc ctx -e override it, and the "master" tenant is always "default")
--exclude string comma-separated dotted paths to drop
--fields string comma-separated columns/keys to show (and their order)
--filter string comma-separated dotted paths to keep (drops everything else)
-o, --output string output format: tty|text|json|yaml (default: $SHC_OUTPUT)
-s, --stack string stack name (default: $SHC_STACK)
-t, --tenant string tenant name (default: $SHC_TENANT)
-v, --verbose verbose output (default: $SHC_VERBOSE)