diff options
| author | Ryan Coleman <ryan@puppetlabs.com> | 2012-01-25 11:03:45 -0800 |
|---|---|---|
| committer | Ryan Coleman <ryan@puppetlabs.com> | 2012-01-25 11:03:45 -0800 |
| commit | 7e41a862d1743f501c62f67382e0609e2b4dab91 (patch) | |
| tree | 67d9f3167b8c3265f6a555a85b230f5f660ff816 /README.md | |
| parent | 21b5e5f1df7a87d30781a8cb34fd9769d78211b1 (diff) | |
Add requirements to README + other cleanup
Prior to this commit, the README did not outline requirements for
the running Puppet version or the operating systems expected to work
with this module. This commit adds those features to the README
and cleans up the formatting from my last commit.
Diffstat (limited to 'README.md')
| -rw-r--r-- | README.md | 18 |
1 files changed, 11 insertions, 7 deletions
@@ -3,11 +3,14 @@ Manage rsyslog client and server via Puppet -## Usage -======== +## REQUIREMENTS + +* Puppet >=2.6 if using parameterized classes +* Currently supports Ubuntu >=11.04 & Debian running rsyslog >=4.5 + +## USAGE ### Client ----------- #### Using default values ``` @@ -27,6 +30,7 @@ Manage rsyslog client and server via Puppet ``` ### Server + #### Using default values ``` class { 'rsyslog::server': } @@ -46,11 +50,11 @@ Manage rsyslog client and server via Puppet Both can be installed at the same time. -### Parameters -============== +## PARAMETERS + The following lists all the class parameters this module accepts. - RSYSLOG::SERVER CLASS PARAMETER VALUES DESCRIPTION + RSYSLOG::SERVER CLASS PARAMETERS VALUES DESCRIPTION -------------------------------------------------------------- enable_tcp true,false Enable TCP listener. Defaults to true. enable_udp true,false Enable UDP listener. Defaults to true. @@ -58,7 +62,7 @@ The following lists all the class parameters this module accepts. custom_config STRING Specify your own template to use for server config. Defaults to undef. Example usage: custom_config => 'rsyslog/my_config.erb' high_precision_timestamps true,false Whether or not to use high precision timestamps. - RSYSLOG::CLIENT CLASS PARAMETER VALUES DESCRIPTION + RSYSLOG::CLIENT CLASS PARAMETERS VALUES DESCRIPTION -------------------------------------------------------------- log_remote true,false Log Remotely. Defaults to true. remote_type 'tcp','udp' Which protocol to use when logging remotely. Defaults to 'tcp'. |