diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-09 19:10:48 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-09 19:10:48 -0500 |
| commit | 57fef6b775feae3d7ff9303b3ffe62d7fbe66bbe (patch) | |
| tree | a6efe6e8572284c1bf83a2918578ce75a715c563 /roles | |
| parent | 06e7e4f6df6dc6573a314ce3c5d040cbc09d4e45 (diff) | |
| download | selfhosted-57fef6b775feae3d7ff9303b3ffe62d7fbe66bbe.tar.gz selfhosted-57fef6b775feae3d7ff9303b3ffe62d7fbe66bbe.zip | |
update documentation
Diffstat (limited to 'roles')
| -rw-r--r-- | roles/archive_client/README.md | 10 | ||||
| -rw-r--r-- | roles/archive_job/README.md | 18 | ||||
| -rw-r--r-- | roles/archive_server/README.md | 12 |
3 files changed, 20 insertions, 20 deletions
diff --git a/roles/archive_client/README.md b/roles/archive_client/README.md index 8dcd0fb..11224bc 100644 --- a/roles/archive_client/README.md +++ b/roles/archive_client/README.md @@ -19,11 +19,11 @@ Variables This role **accepts** the following variables: -Variable | Default | Description -----------------------------------|------------|------------ -`archive_server_user` | s-archiver | Username of the [archive server](../archive_server) user -`archive_cleanup_on_calendar` | daily | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for deleting old archive files -`archive_cleanup_older_than_days` | 7 | Maximum age of files to retain in the archive spool (days) +Variable | Default | Description +----------------------------------|--------------|------------ +`archive_server_user` | `s-archiver` | Username of the [archive server](../archive_server) user +`archive_cleanup_on_calendar` | `daily` | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) for deleting old archive files +`archive_cleanup_older_than_days` | 7 | Maximum age of files to retain in the archive spool (days) Usage diff --git a/roles/archive_job/README.md b/roles/archive_job/README.md index d2f2e5f..7e516a7 100644 --- a/roles/archive_job/README.md +++ b/roles/archive_job/README.md @@ -24,15 +24,15 @@ 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 +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. diff --git a/roles/archive_server/README.md b/roles/archive_server/README.md index 378f82f..3f69579 100644 --- a/roles/archive_server/README.md +++ b/roles/archive_server/README.md @@ -43,12 +43,12 @@ Variables This role **accepts** the following variables: -Variable | Default | Description -------------------------|--------------|------------ -`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 +Variable | Default | Description +------------------------|----------------|------------ +`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 Usage |