diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 10:04:57 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 10:04:57 -0500 |
| commit | 76e7d7117ca34abdbe489544581d2833d64241f9 (patch) | |
| tree | 77044921c94eccbfb331f0ec973816b92ba44746 /roles | |
| parent | e3963c424b1dfa3a984efa7e5fb9783ecfbd0c2c (diff) | |
| download | selfhosted-76e7d7117ca34abdbe489544581d2833d64241f9.tar.gz selfhosted-76e7d7117ca34abdbe489544581d2833d64241f9.zip | |
rsyslog_server: add docs
Diffstat (limited to 'roles')
| -rw-r--r-- | roles/rsyslog_server/README.md | 44 |
1 files changed, 44 insertions, 0 deletions
diff --git a/roles/rsyslog_server/README.md b/roles/rsyslog_server/README.md new file mode 100644 index 0000000..49a0e4b --- /dev/null +++ b/roles/rsyslog_server/README.md @@ -0,0 +1,44 @@ +Rsyslog Server +============== + +Description +----------- + +The `rsyslog_server` role configures Rsyslog to log messages from other client +hosts. Log files are stored in paths of the following format: +`/var/log/remote/YYYY/MM/DD/$HOSTNAME` + +Variables +--------- + +This role **accepts** the following variables: + +Variable | Default | Description +---------------------------|----------------------|------------ +`rsyslog_owner` | `root` | Unix owner of log files +`rsyslog_group` | `root` | Unix group owner of log files +`rsyslog_file_mode` | `0640` | Permission mode of log files +`rsyslog_dir_mode` | `0750` | Permission mode of log directories +`rsyslog_port` | 514 | Syslog listening port +`rsyslog_relp_port` | 20514 | RELP listening port +`rsyslog_relp_tls_port` | 10514 | TLS RELP listening port +`rsyslog_gzip_on_calendar` | `daily` | Systemd [calendar interval](https://www.freedesktop.org/software/systemd/man/systemd.time.html#Calendar%20Events) to gzip log files +`rsyslog_gzip_days_ago` | 7 | Days to keep text logs before compressing +`rsyslog_permitted_peers` | `['*.{{ domain }}']` | List of TLS client name patterns to accept + + +Usage +----- + +Example playbook: + +````yaml +- name: configure syslog servers + hosts: syslog_servers + roles: + - role: rsyslog_server + vars: + rsyslog_owner: root + rsyslog_group: sysadmins + rsyslog_gzip_days_ago: 7 +```` |