adds more info to changelog and pillar.example

README.rst

@@ -2,7 +2,8 @@ rsyslog-formula
 ===============
 
 Configures and starts rsyslog service. Currently the log file schema is based on the debian default. The formula allows
-control if rsyslog should listen for tcp / udp connections. Further ikml logging (kernel) logging can be disabled, e.g. for lxc containers and logs can be redirected to an other server.
+control if rsyslog should listen for tcp / udp connections. Further ikml logging (kernel) logging can be disabled, e.g. for lxc containers.
+It supports both a client only (sending all logs to another machine) and a server side (receiving logs from mulitple other machines).
 
 .. note::
 
@@ -17,4 +18,8 @@ Available states
 ``rsyslog``
 ------------
 
-Install and configure the ``rsyslog`` package and enable the service.
+Install and configure the ``rsyslog`` package and enable the service. See the `pillar.example` file for configuration.
+
+Changelog
+================
+Recently the default rules were moved from `rsyslog.conf` to `50-default.conf`. This file will be loaded if the `rsyslog:custom` pillar isnt set. However, if your `rsyslog:custom` specifies other files to include, you must add the `50-default.conf` as well!

pillar.example

@@ -10,7 +10,9 @@ rsyslog:
   filemode: '0640'                        # mode for created log files
   dirmode: '0755'                         # mode for dirs created in log file paths
 
-  custom:                                 # put custom config files in /etc/rsyslog.d/
-    - 001_custom1.conf                    # files must be reachable from path
-    - 002_custom2.conf                    # salt://rsyslog/
-    - salt://some_other/003_custom3.conf  # Or with an absolute path
+  custom:                                 # Put custom config files in /etc/rsyslog.d/.
+    - 001_custom1.conf                    # Files must be reachable from path `salt://rsyslog/`
+    - salt://some_other/002_custom2.conf  # Or with an absolute path.
+                                          # The default is to include `salt://rsyslog/files/50-default.conf`.
+                                          # If you change the custom conf dict, make sure to
+                                          # include the 50-default.conf as well if needed.