aboutsummaryrefslogtreecommitdiffstats
path: root/roles/journald/README.md
diff options
context:
space:
mode:
authorStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 21:44:25 -0500
committerStonewall Jackson <stonewall@sacredheartsc.com>2023-02-13 21:44:25 -0500
commitee4556fa5ccb87890e4531fd4b9b7f5975447ddb (patch)
tree4b499aa6b309f0802b1e855009cd9a2ec26db240 /roles/journald/README.md
parent48f820b60f284b2bb9aea5c35b580b2148c1b37f (diff)
downloadselfhosted-ee4556fa5ccb87890e4531fd4b9b7f5975447ddb.tar.gz
selfhosted-ee4556fa5ccb87890e4531fd4b9b7f5975447ddb.zip
journald: add docs
Diffstat (limited to 'roles/journald/README.md')
-rw-r--r--roles/journald/README.md33
1 files changed, 33 insertions, 0 deletions
diff --git a/roles/journald/README.md b/roles/journald/README.md
new file mode 100644
index 0000000..58ec604
--- /dev/null
+++ b/roles/journald/README.md
@@ -0,0 +1,33 @@
+Journald
+========
+
+Description
+-----------
+
+The `journald` role configures the systemd journal.
+
+Variables
+---------
+
+This role **accepts** the following variables:
+
+Variable | Default | Description
+-----------------------------|---------|------------
+`journald_persistent` | no | Persist journal to disk
+`journald_forward_to_syslog` | yes | Forward journal messages to syslog socket
+`journald_max_use` | &nbsp; | Set [maximum journal size](https://www.freedesktop.org/software/systemd/man/journald.conf.html#SystemMaxUse=)
+
+
+Usage
+-----
+
+Example playbook:
+
+````yaml
+- hosts: all
+ roles:
+ - role: journald
+ vars:
+ journald_persistent: no
+ journald_forward_to_syslog: yes
+````