rsyslog_client

Table of Contents

1. Description
2. Usage - Configuration options and additional functionality
3. Limitations - OS compatibility, etc.
4. Development - Guide for contributing to the module

Description

lightweight rsyslog client for linux

Usage

See reference and examples

Limitations

• Not supported by Puppet, Inc.

Development

PRs accepted :)

Testing

This module supports testing using PDQTest.

Test can be executed with:

bundle install
make

See .travis.yml for a working CI example

Reference

Table of Contents

Classes

• rsyslog_client: Support for installation and configuration of rsyslog.

Classes

rsyslog_client

Support for installation and configuration of rsyslog. We support the bare minimum needed to enable support on RHEL7, eg all legacy config/no rainer script. This is inline with the default rsyslog.conf file installed by the vendor.

Examples

Install and enable rsyslog

include rsyslog_client

Hiera data for general rsyslog settings

rsyslog_client::settings:
  - '$FileOwner': 'root'
  - '$FileGroup': 'root'
  - '$FileCreateMode': '0600'
  - '$DirOwner': 'root'
  - '$DirGroup': 'root'
  - '$DirCreateMode': '0750'

Hiera data for rsyslog entries

rsyslog_client::entries:
  'daemon.*': /var/log/daemon.log
  'syslog.*': /var/log/syslog

Parameters

The following parameters are available in the rsyslog_client class.

service

Data type: String

Name of rsyslog service to manage

Default value: "rsyslog"

service_ensure

Data type: Enum['running','stopped']

Ensure the service to this value

Default value: "running"

service_enable

Data type: Boolean

Enable the service at boot?

Default value: true

settings

Data type: Array[Hash[String,Any]]

Settings to insert into the rsyslog.conf file. Existing definitions will be replaced in-place. If a setting is added that doesn't already exist, it will be inserted into the file from line setting_insertion_line. Settings will be processed in array order (see examples)

Default value: []

entries

Data type: Hash[String,Any]

Hash of logging entries to create (see examples)

Default value: {}

config_file

Data type: String

configuration file to write

Default value: "/etc/rsyslog.conf"

settings_insertion_line

Data type: Integer

If a setting needs to be inserted, insert starting at this line (zero indexed)

Default value: 23

package

Data type: String

Default value: "rsyslog"