Fix documentation string
[cacert-puppet.git] / sitemodules / profiles / manifests / rsyslog.pp
1 # Class: profiles::rsyslog
2 # ========================
3 #
4 # This class installs and configures rsyslog
5 #
6 # Parameters
7 # ----------
8 #
9 # @param enable_klog whether to enable kernel logging
10 #
11 # Examples
12 # --------
13 #
14 # @example
15 # class roles::myhost {
16 # include profiles::rsyslog
17 # }
18 #
19 # Authors
20 # -------
21 #
22 # Jan Dittberner <jandd@cacert.org>
23 #
24 # Copyright
25 # ---------
26 #
27 # Copyright 2017-2018 Jan Dittberner
28 class profiles::rsyslog (
29 Boolean $enable_klog = false,
30 ) {
31 package { 'rsyslog':
32 ensure => present,
33 } ->
34 file { '/etc/rsyslog.conf':
35 ensure => file,
36 owner => 'root',
37 group => 'root',
38 mode => '0644',
39 content => epp(
40 'profiles/rsyslog/rsyslog.conf.epp',
41 {'enable_klog' => $enable_klog}
42 ),
43 } ->
44 service { 'rsyslog':
45 ensure => running,
46 enable => true,
47 }
48 }