mirror of
https://github.com/roles-ansible/ansible_role_restic.git
synced 2024-12-11 23:41:32 +01:00
document include
This commit is contained in:
parent
4fe4a2a7ac
commit
911f51e27c
1 changed files with 20 additions and 3 deletions
23
README.md
23
README.md
|
@ -157,7 +157,7 @@ Available variables:
|
||||||
| `stdin` | no [see Note] | Is this backup created from a [stdin](https://restic.readthedocs.io/en/stable/040_backup.html#reading-data-from-stdin)? |
|
| `stdin` | no [see Note] | Is this backup created from a [stdin](https://restic.readthedocs.io/en/stable/040_backup.html#reading-data-from-stdin)? |
|
||||||
| `stdin_cmd` | no (yes if `stdin` == `true`) | The command to produce the stdin. |
|
| `stdin_cmd` | no (yes if `stdin` == `true`) | The command to produce the stdin. |
|
||||||
| `stdin_filename` | no | The filename used in the repository. |
|
| `stdin_filename` | no | The filename used in the repository. |
|
||||||
| `include` | no (`{}`) [see Note] | If set, used to specify --files-from, --files-from-verbatim, and/or --files-from-raw. |
|
| `include` | no (`{}`) [see Note] | If set, used to specify --files-from, --files-from-verbatim, and/or --files-from-raw. See [Include](#include) for reference. |
|
||||||
| `exclude` | no (`{}`) | Allows you to specify files to exclude. See [Exclude](#exclude) for reference. |
|
| `exclude` | no (`{}`) | Allows you to specify files to exclude. See [Exclude](#exclude) for reference. |
|
||||||
| `pre_backup_cmd` | no | A command to run before backup, typically used to dump databases to disk |
|
| `pre_backup_cmd` | no | A command to run before backup, typically used to dump databases to disk |
|
||||||
| `tags` | no | Array of default tags |
|
| `tags` | no | Array of default tags |
|
||||||
|
@ -214,9 +214,11 @@ restic_backups:
|
||||||
specified_files:
|
specified_files:
|
||||||
name: specified_files
|
name: specified_files
|
||||||
repo: remote
|
repo: remote
|
||||||
|
include:
|
||||||
|
files_from:
|
||||||
|
- /etc/restic-specified-files.txt
|
||||||
options:
|
options:
|
||||||
- --files-from
|
- --compression off
|
||||||
- /etc/restic-specified-files.txt
|
|
||||||
scheduled: true
|
scheduled: true
|
||||||
schedule_oncalendar: '*-*-* 03:00:00'
|
schedule_oncalendar: '*-*-* 03:00:00'
|
||||||
```
|
```
|
||||||
|
@ -243,6 +245,21 @@ exclude:
|
||||||
Please refer to the use of the specific keys to the
|
Please refer to the use of the specific keys to the
|
||||||
[documentation](https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files).
|
[documentation](https://restic.readthedocs.io/en/latest/040_backup.html#excluding-files).
|
||||||
|
|
||||||
|
#### Include
|
||||||
|
the `include` key on a backup allows you to specify multiple files containing lists of
|
||||||
|
files to include. You can specify the following keys:
|
||||||
|
```yaml
|
||||||
|
include:
|
||||||
|
files_from:
|
||||||
|
- /path/to/file
|
||||||
|
files_from_verbatim:
|
||||||
|
- /path/to/file
|
||||||
|
files_from_raw:
|
||||||
|
- /path/to/file
|
||||||
|
```
|
||||||
|
Please refer to the use of the specific keys to the
|
||||||
|
[documentation](https://restic.readthedocs.io/en/latest/040_backup.html#including-files).
|
||||||
|
|
||||||
## Dependencies
|
## Dependencies
|
||||||
This role does not have any other ansible roles as dependencies.
|
This role does not have any other ansible roles as dependencies.
|
||||||
|
|
||||||
|
|
Loading…
Reference in a new issue