Skip to content

README.md

Latest commit

 

History

History
95 lines (66 loc) · 2.78 KB

README.md

File metadata and controls

95 lines (66 loc) · 2.78 KB
Raw

Puppet Module for rSyslogd

manage installation and configuration of rsyslogd v5.

Documentation

Installing rsyslog

     include rsyslog

Install rsyslog, install the rsyslog-relp input plugin, and enable it on its standard port (2514)

     class { 'syslog':
       relp => true,
     }

Install rsyslog, enable the UDP input listener on a non-standard port, and the TCP input listener on the default port:

     class { 'syslog':
       udp => '55114',
       tcp => true,
     }

Patches and Testing

Contributions are highly welcomed, more so are those which contribute patches with tests. Or just more tests! We have rspec-puppet and rspec-system tests. When contributing patches, please make sure that your patches pass tests:

  igalic@levix ~/src/bw/puppet-rsyslog (git)-[master] % rake spec
  ....................................

  Finished in 2.29 seconds
  36 examples, 0 failures
  igalic@levix ~/src/bw/puppet-rsyslog (git)-[master] % rake spec:system

  ...loads of output...
  2 examples, 0 failures
  igalic@levix ~/src/bw/puppet-rsyslog (git)-[master] %

Release process

The version in Modulefile should be bumped according to semver during development, i.e.: The first commit after the release should already bump the version, as master at this point differs from the latest release.

When cutting a new release, please

  • make sure that all tests pass
  • make sure that the documentation is up-to-date
  • verify that all dependencies are correct, and up-to-date
  • create a new, signed tag and a package, using rake
    igalic@levix ~/src/bw/puppet-rsyslog (git)-[master] % rake release
    git tag -s 1.3.2 -m 't&r 1.3.2'
    ...
    git checkout 1.3.2
    Note: checking out '1.3.2'.
    ...
    HEAD is now at ff9aaae... Most awesome feature added. SHIPIT!
    puppet module build .
    Notice: Building /home/igalic/src/bw/puppet-rsyslog for release
    Module built: /home/igalic/src/bw/puppet-rsyslog/pkg/brainsware-rsyslog-1.3.2.tar.gz
    igalic@levix ~/src/bw/puppet-rsyslog (git)-[1.3.2] %
  • push the tag,
    igalic@levix ~/src/bw/puppet-rsyslog (git)-[1.3.2] % git push --tags origin

License

Apache Software License 2.0

Contact

You can send us questions via mail puppet@brainsware.org, or reach us IRC: igalic hangs out in #puppet

Support

Please log tickets and issues at our Project's issue tracker