diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-09 18:49:13 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-09 18:49:13 -0500 |
| commit | 15cec24b55a28302597aee4210ba0483c31210fa (patch) | |
| tree | 8adfc24b45fddcd3fee211d4bcbdcd56c3dda4a0 /roles | |
| parent | afbddfa994471e8b3b7b7065e3fb52c2898ef0ec (diff) | |
| download | selfhosted-15cec24b55a28302597aee4210ba0483c31210fa.tar.gz selfhosted-15cec24b55a28302597aee4210ba0483c31210fa.zip | |
update documentation
Diffstat (limited to 'roles')
| -rw-r--r-- | roles/archive_job/README.md | 14 |
1 files changed, 9 insertions, 5 deletions
diff --git a/roles/archive_job/README.md b/roles/archive_job/README.md index 04084ff..dc907ba 100644 --- a/roles/archive_job/README.md +++ b/roles/archive_job/README.md @@ -6,15 +6,17 @@ Description The _archiver_ is my method of performing periodic backups of application data. The general idea is that applications can write data to a dedicated directory in -`/var/spool/archive`, and the [archive\_server](../archive_server) will rsync any -of these files to a central location each night. +`/var/spool/archive`, and the [archive server](../archive_server) will rsync +these files to a central location each night. The `archive_job` role creates a systemd timer to perform an application's archive job at a given calendar interval. The archive command can be specified as an -`argv` to pass to exec, or as a string to be interpreted by the shell. +`argv` to pass to directly to `exec()`, or as a string to be interpreted by the +shell. Archive commands are `chdir`ed to the appropriate spool directory prior to -execution, so it's safe to to just write to the current working directory. +execution, so it's safe for them to simply write files to their current working +directory. Variables @@ -32,6 +34,8 @@ Variable | Default | Description `archive_shell` | | Shell command to execute `archive_on_calendar` | weekly | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for running archive job +You should define either `archive_command` or `archive_shell`, but not both. + Usage ----- @@ -39,7 +43,7 @@ Usage Example playbook: ````yaml -- name: configure cups archive job +- name: configure archive job for cupsd config files hosts: cups_servers roles: - role: archive_job |