augeasproviders_syslog

approved
Augeas-based syslog type and providers for Puppet
Hercules Team

Hercules Team

herculesteam

140,682 downloads

16,634 latest version

5.0 quality score

Version information

  • 2.3.0 (latest)
  • 2.2.1
  • 2.2.0
  • 2.1.1
  • 2.1.0
  • 2.0.0
released Mar 13th 2019
This version is compatible with:
  • Puppet Enterprise 2019.8.x, 2019.7.x, 2019.5.x, 2019.4.x, 2019.3.x, 2019.2.x, 2019.1.x, 2019.0.x, 2018.1.x, 2017.3.x
  • Puppet >= 5.0.0 < 7.0.0
  • Debian
    ,
    Ubuntu
    ,
    RedHat
    ,
    CentOS
    ,
    OracleLinux

Start using this module

Documentation

herculesteam/augeasproviders_syslog — version 2.3.0 Mar 13th 2019

Puppet Forge Version Puppet Forge Downloads Puppet Forge Endorsement Build Status Coverage Status Gemnasium

syslog: types/providers for syslog files for Puppet

This module provides new types/providers for Puppet to read and modify syslog config files using the Augeas configuration library.

The advantage of using Augeas over the default Puppet parsedfile implementations is that Augeas will go to great lengths to preserve file formatting and comments, while also failing safely when needed.

This provider will hide all of the Augeas commands etc., you don't need to know anything about Augeas to make use of it.

Requirements

Ensure both Augeas and ruby-augeas 0.3.0+ bindings are installed and working as normal.

See Puppet/Augeas pre-requisites.

Installing

On Puppet 2.7.14+, the module can be installed easily (documentation):

puppet module install herculesteam/augeasproviders_syslog

You may see an error similar to this on Puppet 2.x (#13858):

Error 400 on SERVER: Puppet::Parser::AST::Resource failed with error ArgumentError: Invalid resource type `syslog` at ...

Ensure the module is present in your puppetmaster's own environment (it doesn't have to use it) and that the master has pluginsync enabled. Run the agent on the puppetmaster to cause the custom types to be synced to its local libdir (puppet master --configprint libdir) and then restart the puppetmaster so it loads them.

Compatibility

Puppet versions

Minimum of Puppet 2.7.

Augeas versions

Augeas Versions 0.10.0 1.0.0 1.1.0 1.2.0
PROVIDERS
syslog (augeas) yes yes yes yes
syslog (rsyslog) no yes yes yes
rsyslog_filter (augeas) no yes yes yes

Documentation and examples

Type documentation can be generated with puppet doc -r type or viewed on the Puppet Forge page.

A syslog provider handles basic syslog configs, while an rsyslog provider handles the extended rsyslog config (this requires Augeas 1.0.0).

manage entry

syslog { "my test":
  ensure      => present,
  facility    => "local2",
  level       => "*",
  action_type => "file",
  action      => "/var/log/test.log",
}

manage entry with no file sync

syslog { "cron.*":
  ensure      => present,
  facility    => "cron",
  level       => "*",
  action_type => "file",
  action      => "/var/log/cron",
  no_sync     => true,
}

manage remote hostname entry

syslog { "my test":
  ensure      => present,
  facility    => "local2",
  level       => "*",
  action_type => "hostname",
  action      => "centralserver",
}

manage remote hostname entry with port and protocol

syslog { "my test":
  ensure          => present,
  facility        => "local2",
  level           => "*",
  action_type     => "hostname",
  action_port     => "514",
  action_protocol => "tcp",
  action          => "centralserver",
}

manage user destination entry

syslog { "my test":
  ensure      => present,
  facility    => "local2",
  level       => "*",
  action_type => "user",
  action      => "root",
}

manage program entry

syslog { "my test":
  ensure      => present,
  facility    => "local2",
  level       => "*",
  action_type => "program",
  action      => "/usr/bin/foo",
}

delete entry

syslog { "mail.*":
  ensure      => absent,
  facility    => "mail",
  level       => "*",
  action_type => "file",
  action      => "/var/log/maillog",
}

manage entry in rsyslog

syslog { "my test":
  ensure      => present,
  facility    => "local2",
  level       => "*",
  action_type => "file",
  action      => "/var/log/test.log",
  provider    => "rsyslog",
}

manage entry in another syslog location

syslog { "my test":
  ensure      => present,
  facility    => "local2",
  level       => "*",
  action_type => "file",
  action      => "/var/log/test.log",
  target      => "/etc/mysyslog.conf",
}

Issues

Please file any issues or suggestions on GitHub.