diff options
Diffstat (limited to 'roles')
| -rw-r--r-- | roles/archive_server/README.md | 22 |
1 files changed, 12 insertions, 10 deletions
diff --git a/roles/archive_server/README.md b/roles/archive_server/README.md index 2871cf4..b815b2a 100644 --- a/roles/archive_server/README.md +++ b/roles/archive_server/README.md @@ -9,18 +9,20 @@ The general idea is that applications can write data to a dedicated directory in `/var/spool/archive`, and the archive server will rsync these files to a central location each night. -The `archive_server` role generates the _archiver_ script, along with a -corresponding FreeIPA user account and systemd timer. The [archvier script](templates/usr/local/bin/archiver.sh.j2) -runs daily. It iterates over each host in the `archive_clients` hostgroup -and `rsync`s any archive files to a subdirectory `archive_dest_path`, organized -by hostname. +The `archive_server` role generates the [archiver script](templates/usr/local/bin/archiver.sh.j2), +along with a corresponding FreeIPA user account and systemd timer. The archvier +script runs daily. It iterates over each host in the `archive_clients` hostgroup +and `rsync`s anything in `/var/spool/archive` to the location specified by +`archive_dest_path`. + +Archived files are sorted into subdirectories by hostname. ### Plugins For hosts that don't support rsync, such as network equipment, the _archiver_ -provides a plugin-based method of downloading files. Plugins consist of -executable files in the [plugin directory](files/usr/local/libexec/archiver/) -that take a target hostname as the first argument (you can also pass additional +provides a plugin-based method of retrieving files. A plugin is just an +executable file in the [plugin directory](files/usr/local/libexec/archiver/) +that takes a target hostname as the first argument (you can also pass additional arguments if needed). Each line in the archiver [config file](templates/etc/archiver.conf.j2) specifies @@ -36,8 +38,8 @@ This role **accepts** the following variables: Variable | Default | Description ------------------------|--------------|------------ -`archive_dest_path` | /nfs/archive | Path to store archive files -`archive_user` | s-archiver | FreeIPA user account to perform SSH-based rsync (keytab will be retrieved) +`archive_dest_path` | /nfs/archive | Path to store archived files +`archive_user` | s-archiver | FreeIPA user account for performing SSH-based rsync `archive_on_calendar` | 23:00:00 | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for archiving hosts `archive_retention_days`| 365 | Number of days to retain archive files |