Marty Oehme
135aadf3a0
Sets up regular backup maintenance for a restic (S3) backend, and enables global variables for other roles to use for their individual backup. Example found in nextcloud role.
49 lines
1.2 KiB
Markdown
49 lines
1.2 KiB
Markdown
# restic
|
|
|
|
Backup maintenance stack.
|
|
|
|
Takes care of regularly pruning the backup repository and checking its integrity.
|
|
Currently only supports S3 as a backend.
|
|
|
|
## Defaults
|
|
|
|
```yaml
|
|
restic_timezone: US/Chicago
|
|
```
|
|
|
|
The timezone to be used for the cronjob.
|
|
|
|
```yaml
|
|
restic_version: latest
|
|
```
|
|
|
|
The docker image version to be used in stack creation.
|
|
|
|
```yaml
|
|
restic_repo: s3.eu-central-1.wasabisys.com/myrepo
|
|
restic_pass: <restic-pass>
|
|
```
|
|
|
|
The repository url and the restic repository password.
|
|
See the restic documentation for more information.
|
|
|
|
```yaml
|
|
restic_s3_key: <s3-key>
|
|
restic_s3_secret: <s3-secret>
|
|
```
|
|
|
|
The restic S3 credentials, i.e. the `AWS_ACCESS_KEY_ID` and `AWS_SECRET_ACCESS_KEY`.
|
|
|
|
```yaml
|
|
restic_prune_cron: 0 0 4 * * *
|
|
restic_forget_args: --prune --keep-last 14 --keep-daily 2 --keep-weekly 2
|
|
```
|
|
|
|
The default prune and forget cronjob schedule and arguments: Prune the repository every day at 4:00 AM and keep the last 14 snapshots, 2 daily snapshots and 2 weekly snapshots.
|
|
|
|
```yaml
|
|
restic_check_cron: 0 15 5 * * *
|
|
restic_check_args: --read-data-subset=5%
|
|
```
|
|
|
|
The default check cronjob schedule and arguments: Check the repository integrity every day at 5:15 AM and in addition to structural checks, read 5 randomly chosen % for a data integrity check.
|