Skip to content

Latest commit

 

History

History
116 lines (73 loc) · 3.38 KB

README.md

File metadata and controls

116 lines (73 loc) · 3.38 KB
Raw

Puppet module: syslog_ng

This is a Puppet module for syslog_ng based on the second generation layout ("NextGen") of Example42 Puppet Modules.

Made by Ed Szynaka

Official site: https://github.com/szynaka/syslog_ng

Official git repository: https://github.com/szynaka/syslog_ng

Released under the terms of Apache 2 License.

This module requires functions provided by the Example42 Puppi module (you need it even if you don't use and install Puppi)

For detailed info about the logic and usage patterns of Example42 modules check the DOCS directory on Example42 main modules set.

USAGE - Basic management

  • Install syslog_ng with default settings

      class { 'syslog_ng': }

  • Install a specific version of syslog_ng package

      class { 'syslog_ng':
    version => '1.0.1',
  }

  • Disable syslog_ng service.

      class { 'syslog_ng':
    disable => true
  }

  • Remove syslog_ng package

      class { 'syslog_ng':
    absent => true
  }

  • Enable auditing without without making changes on existing syslog_ng configuration files

      class { 'syslog_ng':
    audit_only => true
  }

  • Module dry-run: Do not make any change on all the resources provided by the module

      class { 'syslog_ng':
    noops => true
  }

USAGE - Overrides and Customizations

  • Use custom sources for main config file

      class { 'syslog_ng':
    source => [ "puppet:///modules/example42/syslog_ng/syslog_ng.conf-${hostname}" , "puppet:///modules/example42/syslog_ng/syslog_ng.conf" ], 
  }

  • Use custom source directory for the whole configuration dir

      class { 'syslog_ng':
    source_dir       => 'puppet:///modules/example42/syslog_ng/conf/',
    source_dir_purge => false, # Set to true to purge any existing file not present in $source_dir
  }

  • Use custom template for main config file. Note that template and source arguments are alternative.

      class { 'syslog_ng':
    template => 'example42/syslog_ng/syslog_ng.conf.erb',
  }

  • Automatically include a custom subclass

      class { 'syslog_ng':
    my_class => 'example42::my_syslog_ng',
  }

USAGE - Example42 extensions management

  • Activate puppi (recommended, but disabled by default)

      class { 'syslog_ng':
    puppi    => true,
  }

  • Activate puppi and use a custom puppi_helper template (to be provided separately with a puppi::helper define ) to customize the output of puppi commands

      class { 'syslog_ng':
    puppi        => true,
    puppi_helper => 'myhelper', 
  }

  • Activate automatic monitoring (recommended, but disabled by default). This option requires the usage of Example42 monitor and relevant monitor tools modules

      class { 'syslog_ng':
    monitor      => true,
    monitor_tool => [ 'nagios' , 'monit' , 'munin' ],
  }

  • Activate automatic firewalling. This option requires the usage of Example42 firewall and relevant firewall tools modules

      class { 'syslog_ng':       
    firewall      => true,
    firewall_tool => 'iptables',
    firewall_src  => '10.42.0.0/24',
    firewall_dst  => $ipaddress_eth0,
  }

CONTINUOUS TESTING

Travis {Build Status}[https://travis-ci.org/example42/puppet-syslog_ng]