blob: d2f2e5fb8714743a25da4702c68ab06f30f9f7e8 (
plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
|
Archive Job
===========
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
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 directly to `exec()`, or as a string to be interpreted by the
shell.
Archive commands are `chdir`'d to the appropriate spool directory prior to
execution, so it's safe for them to simply write files to their current working
directory.
Variables
---------
This role **accepts** the following variables:
Variable | Default | Description
----------------------|------------------------------|------------
`archive_name` | | Name of the archive job
`archive_description` | `archive {{ archive_name }}` | Description of the archive job
`archive_user` | root | Unix user that executes the job process
`archive_group` | `{{ archive_user }}` | Unix group that executes the job process
`archive_on_calendar` | weekly | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for running archive job
`archive_command` | | Command to execute (will be passed as-is to `exec`)
`archive_shell` | | Shell command to execute
You should define either `archive_command` or `archive_shell`, but not both.
Usage
-----
Example playbook:
````yaml
- name: configure archive job for cupsd config files
hosts: cups_servers
roles:
- role: archive_job
archive_name: cups
archive_shell: >-
TIMESTAMP=$(date +%Y%m%d%H%M%S);
tar czf "cups-${TIMESTAMP}.tar.gz"
--transform "s|^\.|cups-${TIMESTAMP}|"
-C /etc/cups
./ppd ./printers.conf
tags: archive
````
|
