Skip to content

Commit 1fc0c70

Browse files
sazsaz
committed
add data types to all parameters, add REFERENCE.md
1 parent 1bab870 commit 1fc0c70

File tree

14 files changed

+1675
-444
lines changed

14 files changed

+1675
-444
lines changed

‎README.md

Lines changed: 2 additions & 157 deletions
Original file line numberDiff line numberDiff line change
@@ -1,19 +1,7 @@
1-
# puppet-rsyslog [![Build Status](https://secure.travis-ci.org/saz/puppet-rsyslog.png)](https://travis-ci.org/saz/puppet-rsyslog)
1+
# puppet-rsyslog
22

33
Manage rsyslog client and server via Puppet
44

5-
## REQUIREMENTS
6-
7-
* Puppet >= 3.0
8-
* Starting with release 4.0.0 Puppet < 3.0 is not tested anymore
9-
10-
## Supported platforms
11-
* Debian-based distributions
12-
* RedHat-based distributions
13-
* Suse-based distributions
14-
* Gentoo
15-
* FreeBSD
16-
175
## USAGE
186

197
### Client
@@ -23,37 +11,6 @@ Manage rsyslog client and server via Puppet
2311
class { 'rsyslog::client': }
2412
```
2513

26-
#### Variables and default values
27-
```
28-
class { 'rsyslog::client':
29-
log_remote => true,
30-
spool_size => '1g',
31-
spool_timeoutenqueue => false,
32-
remote_type => 'tcp',
33-
remote_forward_format => 'RSYSLOG_ForwardFormat',
34-
log_local => false,
35-
disable_xconsole => false,
36-
log_local_custom => undef,
37-
log_auth_local => false,
38-
listen_localhost => false,
39-
split_config => false,
40-
custom_config => undef,
41-
custom_params => undef,
42-
server => 'log',
43-
port => '514',
44-
remote_servers => false,
45-
ssl => false,
46-
ssl_ca => undef,
47-
ssl_permitted_peer => undef,
48-
ssl_auth_mode => 'anon',
49-
log_templates => false,
50-
log_filters => false,
51-
actionfiletemplate_cust => false,
52-
actionfiletemplate => false,
53-
high_precision_timestamps => false,
54-
imfiles => undef
55-
}
56-
```
5714
#### imfile entries
5815
Gathers log information from a file
5916
```
@@ -160,40 +117,7 @@ rsyslog::client::log_filters:
160117
action: /var/log/foo.log
161118
```
162119

163-
#### Variables and default values
164-
```
165-
class { 'rsyslog::server':
166-
enable_tcp => true,
167-
enable_udp => true,
168-
enable_relp => true,
169-
remote_ruleset_tcp => true,
170-
remote_ruleset_udp => true,
171-
remote_ruleset_relp => true,
172-
enable_onefile => false,
173-
relay_server => false,
174-
server_dir => '/srv/log',
175-
custom_config => undef,
176-
content => undef,
177-
port => '514',
178-
relp_port => '20514',
179-
address => '*',
180-
high_precision_timestamps => false,
181-
ssl => false,
182-
ssl_ca => undef,
183-
ssl_cert => undef,
184-
ssl_key => undef,
185-
ssl_permitted_peer => undef,
186-
ssl_auth_mode => 'anon',
187-
log_templates => false,
188-
log_filters => false,
189-
actionfiletemplate_cust => false,
190-
actionfiletemplate => false,
191-
rotate => undef,
192-
rules => undef
193-
}
194-
```
195-
196-
Both can be installed at the same time.
120+
Both, client and server, can be installed at the same time.
197121

198122
#### Defining custom rules
199123

@@ -226,85 +150,6 @@ Each rule has the following parameters:
226150
* *selector*: Sets the selector field of the rule. Defaults to `undef`
227151
* *action*: Sets the action field of the rule. Defaults to `undef`
228152

229-
## PARAMETERS
230-
231-
The following lists all the class parameters this module accepts.
232-
233-
RSYSLOG CLASS PARAMETERS VALUES DESCRIPTION
234-
-------------------------------------------------------------------
235-
msg_reduction true,false Reduce repeated messages. Defaults to false.
236-
non_kernel_facility true,false Permit non-kernel facility messages in the kernel log. Defaults to false.
237-
omit_local_logging true,false Turn off message reception via local log socket. Defaults to true only for RedHat 7+ and false elsewhere.
238-
preserve_fqdn true,false Use full name of host even if sender and receiver are in the same domain. Defaults to false.
239-
local_host_name STRING Use a custom local host name, instead of clients actual host name. Defaults to undef.
240-
package_status STRING Manages rsyslog package installation. Defaults to 'present'.
241-
system_log_rate_limit_interval INTEGER Specifies the number of seconds per rate limit interval. Defaults to 1.
242-
system_log_rate_limit_burst INTEGER Specifies the number of messages before limiting begins. Defaults to 100.
243-
244-
RSYSLOG::SERVER CLASS PARAMETERS VALUES DESCRIPTION
245-
-------------------------------------------------------------------
246-
enable_tcp true,false Enable TCP listener. Defaults to true.
247-
enable_udp true,false Enable UDP listener. Defaults to true.
248-
enable_relp true,false Enable RELP listener. Defaults to true (v6.3.6+).
249-
remote_ruleset_tcp true,false Disables the remote ruleset when the TCP listener is enabled.
250-
remote_ruleset_udp true,false Disables the remote ruleset when the UDP listener is enabled.
251-
remote_ruleset_relp true,false Disables the remote ruleset when the RELP listener is enabled.
252-
enable_onefile true,false Only one logfile per remote host. Defaults to false.
253-
relay_server true,false If the server should be able to relay the received logs to another server. The rsyslog::client must also be set up. Defaults to false.
254-
server_dir STRING Folder where logs will be stored on the server. Defaults to '/srv/log'
255-
custom_config STRING Specify your own template to use for server config. Defaults to undef. Example usage: custom_config => 'rsyslog/my_config.erb'
256-
content STRING Specify the content of the server config, instead of using a template. Defaults to undef.
257-
port STRING/INTEGER Port to listen on for messages via UDP and TCP. Defaults to 514
258-
relp_port STRING/INTEGER Port to listen on for messages via RELP. Defaults to 20514
259-
address STRING The IP address to bind to. Applies to UDP listener only. Defaults to '*'.
260-
high_precision_timestamps true,false Whether or not to use high precision timestamps. Defaults to false.
261-
ssl true,false Enable SSL support. Defaults to false.
262-
ssl_ca STRING Path to SSL CA certificate. Defaults to undef.
263-
ssl_cert STRING Path to SSL certificate. Defaults to undef.
264-
ssl_key STRING Path to SSL private key. Defaults to undef.
265-
ssl_permitted_peer STRING List of permitted peers. Defaults to undef.
266-
ssl_auth_mode STRING SSL auth mode. Defaults to anon.
267-
log_templates HASH Provides a hash defining custom logging templates using the `$template` configuration parameter. Defaults to false.
268-
log_filters HASH Provides a hash defining custom logging filters using the `if/then` configurations parameter. Defaults to false.
269-
actionfiletemplate_cust STRING If set this defines the `ActionFileDefaultTemplate custom formatting` which sets customisations over the default log format for remote and local logging. Must be used with actionfiletemplate to take effect. Defaults to false.
270-
actionfiletemplate STRING If set this defines the `ActionFileDefaultTemplate` which sets the default logging format for remote and local logging. Defaults to false.
271-
rotate STRING Enables rotation of logfiles. Valid values: year, month, day. Defaults to undef.
272-
rules Array of hashes Array of hashes for configuring custom rules for the server. If set, this replaces the default rules. See documentation above. Defaults to undef.
273-
274-
RSYSLOG::CLIENT CLASS PARAMETERS VALUES DESCRIPTION
275-
-------------------------------------------------------------------
276-
log_remote true,false Log Remotely. Defaults to true.
277-
spool_size STRING Max size for disk queue if remote server failed. Defaults to '1g'.
278-
remote_type 'tcp','udp','relp' Which protocol to use when logging remotely. Defaults to 'tcp'.
279-
remote_forward_format STRING Which forward format for remote servers should be used. Only used if remote_servers is false.
280-
log_local true,false Log locally. Defaults to false.
281-
log_auth_local true,false Just log auth facility locally. Defaults to false.
282-
split_config true,false Splits the client config into 00_client_config.conf, 50_client_remote.conf and 99_client_local.conf. Defaults to false.
283-
custom_config STRING Specify your own template to use for client config. Defaults to undef. Example usage: custom_config => 'rsyslog/my_config.erb'
284-
custom_params TODO TODO
285-
server STRING Rsyslog server to log to. Will be used in the client configuration file. Only used, if remote_servers is false.
286-
port '514' Remote server port. Only used if remote_servers is false.
287-
remote_servers Array of hashes Array of hashes with remote servers. See documentation above. Defaults to false.
288-
ssl true,false Enable SSL support. Defaults to false.
289-
ssl_ca STRING SSL CA file location. Defaults to undef.
290-
ssl_cert STRING Path to SSL certificate. Defaults to undef.
291-
ssl_key STRING Path to SSL private key. Defaults to undef.
292-
ssl_permitted_peer STRING List of permitted peers. Defaults to undef.
293-
ssl_auth_mode STRING SSL auth mode. Defaults to anon.
294-
log_templates HASH Provides a hash defining custom logging templates using the `$template` configuration parameter.
295-
log_filters HASH Provides a hash defining custom logging filters using the `if/then` configurations parameter.
296-
actionfiletemplate_cust STRING If set this defines the `ActionFileDefaultTemplate custom formatting` which sets customisations over the default log format for remote and local logging. Must be used with actionfiletemplate to take effect. Defaults to false.
297-
actionfiletemplate STRING If set this defines the `ActionFileDefaultTemplate` which sets the default logging format for remote and local logging.
298-
high_precision_timestamps true,false Whether or not to use high precision timestamps.
299-
300-
RSYSLOG::DATABASE CLASS PARAMETERS VALUES DESCRIPTION
301-
-------------------------------------------------------------------
302-
backend 'mysql','pgsql' Database backend (MySQL or PostgreSQL).
303-
server STRING Database server.
304-
database STRING Database name.
305-
username STRING Database username.
306-
password STRING Database password.
307-
308153
### Other notes
309154

310155
By default, rsyslog::server will strip numbers from hostnames. This means the logs of

0 commit comments

Comments
 (0)