Overview:
| Variable | Required? | Description |
|---|---|---|
| s3: | ||
AWS_ACCESS_KEY_ID |
yes | S3 Access Key ID |
AWS_SECRET_ACCESS_KEY |
yes | S3 Secret Access Key |
| mcs-backup config: | ||
BACKUP_HTTP_PORT |
no | default: 9000 |
BACKUP_PATHS |
no | e.g. "foo:bar": only subdirectories foo and
bar will be backed up/restored
|
BACKUP_PRUNE_INTERVAL |
no | e.g. "168h": prune will be run every 168 hours; default: 120h
|
BACKUP_ROOT |
no | default: "/mnt" |
CRON_SCHEDULE_FILE |
no | points to file containing schedule |
CRON_SCHEDULE |
no | e.g. "0 */2 * * *", default: no automatic backup |
EXCLUDE_PATHS |
no | e.g. "bar:baz": bar and
baz will be excluded from backup
|
RETENTION_POLICY |
yes | no default |
| metrics: | ||
INFLUXDB_DATABASE |
no | e.g. mcs,
has to pre-exist |
INFLUXDB_ORG |
no | |
INFLUXDB_TOKEN |
no | |
INFLUXDB_URL |
no | e.g. http://influxdb.backup-monitoring.svc:8086 |
LOKI_URL |
no | e.g. http://loki-dev.backup-monitoring.svc:3100 |
METRICS_LABELS |
no | e.g. {"namespace":"foo","service":"bar"} |
S3_METRICS_TIMEOUT |
no | default: 5s |
| hook scripts: | ||
PRE_BACKUP_SCRIPT |
no | script to run before backup |
POST_BACKUP_SCRIPT |
no | script to run after backup |
PRE_RESTORE_SCRIPT |
no | script to run before restore |
POST_RESTORE_SCRIPT |
no | script to run after restore |
PIPE_IN_SCRIPT |
no | script that dumps data to stdout |
PIPE_OUT_SCRIPT |
no | script that reads data from stdin |
| restic: | ||
RESTIC_REPOSITORY
| yes | e.g. "s3:s3.example.com/bucket-name" |
| or... | ||
RESTIC_REPOSITORY_BASERESTIC_REPOSITORY_PATH
|
RESTIC_REPOSITORY = RESTIC_REPOSITORY_BASE
+ / + RESTIC_REPOSITORY_PATH |
|
RESTIC_PASSWORD |
yes | Password for backup encryption |