diff options
| author | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 09:42:17 -0500 |
|---|---|---|
| committer | Stonewall Jackson <stonewall@sacredheartsc.com> | 2023-02-20 09:42:17 -0500 |
| commit | e3963c424b1dfa3a984efa7e5fb9783ecfbd0c2c (patch) | |
| tree | c3f847fed04984979ed2656dc2f7e60caa3c3926 | |
| parent | 9c7683dd4503347fd653499cb51b3d2ccbeba945 (diff) | |
| download | selfhosted-e3963c424b1dfa3a984efa7e5fb9783ecfbd0c2c.tar.gz selfhosted-e3963c424b1dfa3a984efa7e5fb9783ecfbd0c2c.zip | |
rsyslog_client: add readme
| -rw-r--r-- | roles/rsyslog_client/README.md | 40 |
1 files changed, 40 insertions, 0 deletions
diff --git a/roles/rsyslog_client/README.md b/roles/rsyslog_client/README.md new file mode 100644 index 0000000..7eed159 --- /dev/null +++ b/roles/rsyslog_client/README.md @@ -0,0 +1,40 @@ +Rsyslog Client +============== + +Description +----------- + +The `rsyslog_client` role configures Rsyslog to forward local syslog messages +to a central syslog server. + +Variables +--------- + +This role **accepts** the following variables: + +Variable | Default | Description +-------------------------------|---------------------|------------ +`rsyslog_forward` | yes | Forward syslog messages to remote server +`rsyslog_tls` | yes | Use TLS encryption +`rsyslog_target` | `{{ syslog_host }}` | Hostname of syslog server +`rsyslog_relp_port` | 20514 | Destination port for RELP messages +`rsyslog_relp_tls_port` | 10514 | Destination TLS port for RELP messages +`rsyslog_queue_max_disk_space` | `250m` | Maximum disk space to use for message queue +`rsyslog_queue_size` | 10000 | Maximum number of messages to keep in message queue + + +Usage +----- + +Example playbook: + +````yaml +- name: configure syslog forwarding + hosts: all + roles: + - role: rsyslog_client + vars: + rsyslog_target: syslog.ipa.example.com + rsyslog_forward: yes + rsyslog_tls: yes +```` |