Merge pull request #49 from ccin2p3/drop-centos

ccin2p3 · Jan 15, 2025 · 340bbd6 · 340bbd6
2 parents da14b31 + 9782649
commit 340bbd6
Show file tree

Hide file tree

Showing 34 changed files with 104 additions and 108 deletions.
diff --git a/README.md b/README.md
@@ -28,14 +28,14 @@ This module will manage the pattern databases of *syslog-ng* by using existing f
 
 ### What patterndb affects
 
-Depending on the top-level configuration variables `$base_dir` and `$temp_dir`, this module will manage and execute the following elements in order:
+Depending on the top-level configuration variables `$cache_dir`, this module will manage and execute the following elements in order:
 
 0. (OPTIONAL) Manage package `syslog-ng`
-1. Manage `$base_dir/etc/syslog-ng/patterndb.d` recursively
+1. Manage `/etc/syslog-ng/patterndb.d` recursively
 2. Manage the contents of the above directory using [existing](#defined-type-patterndbrawruleset) or [generated](#defined-type-patterndbsimpleruleset) patterndb *ruleset* files
-3. Merge the contents of the latter using `pdbtool` into a temporary file `${temp_dir}/syslog-ng/patterndb/${parser}.xml` where `$parser` is the name of the *patterndb* (you can have as many as you want, *e.g.* for *staged parsing*.
+3. Merge the contents of the latter using `pdbtool` into a temporary file `${cache_dir}/syslog-ng/patterndb/${parser}.xml` where `$parser` is the name of the *patterndb* (you can have as many as you want, *e.g.* for *staged parsing*.
 4. (OPTIONAL) Test the resulting patterndbs
-5. Deploy the temporary files into `${base_dir}/var/lib/syslog-ng/patterndb/${parser}.xml`
+5. Deploy the temporary files into `/var/lib/syslog-ng/patterndb/${parser}.xml`
 
 Reloading of the *syslog-ng* daemon is not being taken care of, as the latter already does that on its own by polling the *patterndb* file for change.
 
@@ -82,7 +82,6 @@ class { "patterndb": }
 ... or overriding paths
 ```puppet
 class { "patterndb":
-  $base_dir => "/",
   $temp_dir => "/tmp"
 }
 ```
@@ -142,12 +141,11 @@ This class will manage the following *resources*:
 
 * `Package[$package_name]` if `$manage_package` is set to `true`.
 * `File[$temp_dir]` as a directory.
-* `File["${base_dir}/etc/syslog-ng/patterndb.d"]` recursively, purging unknown files.
-* `File["${base_dir}/var/lib/syslog-ng/patterndb/${parser}.xml"]` for each `$parser` (defaults to `'default'`)
+* `File["$/etc/syslog-ng/patterndb.d"]` recursively, purging unknown files.
+* `File["/var/lib/syslog-ng/patterndb/${parser}.xml"]` for each `$parser` (defaults to `'default'`)
 
 #### Optional Parameters
 
-* `$base_dir` Top level directory for storing resources. Defaults to `'/'`
 * `$temp_dir` Temporary directory for various components. Defaults to `'/tmp/syslog-ng'`
 * `$package_name` Name of the `syslog-ng` package. Defaults to the OS shipped
 * `$manage_package` Boolean to control the management of the package. Defaults to `true`
@@ -266,11 +264,11 @@ Notice: Applied catalog in 1.33 seconds
 If using the defaults, and only one *pattern parser*, you probably won't need to define this resource, as it will get automatically created for you when defining a *ruleset*.
 This resource represents a *patterndb parser*, which is eventually materialized by a *File puppet resource*:
 ```puppet
-File["${base_dir}/var/lib/syslog-ng/patterndb/${name}.xml"]
+File["/var/lib/syslog-ng/patterndb/${name}.xml"]
 ```
 
 This *File* is generated by merging all defined *ruleset resources*, which come in two forms: [raw](#defined-type-patterndbrawruleset) and [simple](#defined-type-patterndbsimpleruleset).
-Merging is handled under the hood by using `pdbtool merge` which creates a new *patterndb parser* in the `${temp_dir}` directory. Testing of the merged *parser* is optionally handled using `pdbtool test`. If this is a success, the merged file is then being deployed into the definitive destination at `${base_dir}/var/lib/syslog-ng/patterndb/${name}.xml`.
+Merging is handled under the hood by using `pdbtool merge` which creates a new *patterndb parser* in the `${temp_dir}` directory. Testing of the merged *parser* is optionally handled using `pdbtool test`. If this is a success, the merged file is then being deployed into the definitive destination at `/var/lib/syslog-ng/patterndb/${name}.xml`.
 
 #### Optional Parameters
 
@@ -300,7 +298,7 @@ patterndb::parser { 'default':
 Describes a *resultset* using *XML* content. Use only if you have existing *pdb* files. The use of [`patterndb::simple::ruleset`](#defined-type-patterndbsimpleruleset) is highly encouraged otherwise.
 This type will define the following *puppet resource*:
 ```puppet
-File["${base_dir}/etc/syslog-ng/patterndb.d/${parser}/${name}.pdb"]
+File["/etc/syslog-ng/patterndb.d/${parser}/${name}.pdb"]
 ```
 
 #### Parameters
@@ -361,7 +359,7 @@ patterndb::raw::ruleset { 'ruleset_for_pdb_2':
 Describes a *ruleset* using *puppet code*.
 Like its sibling [`patterndb::raw::ruleset`](#defined-type-patterndbrawruleset), this type will define the following *puppet resource*:
 ```puppet
-File["${base_dir}/etc/syslog-ng/patterndb.d/${parser}/${name}.pdb"]
+File["/etc/syslog-ng/patterndb.d/${parser}/${name}.pdb"]
 ```
 
 Additional internal resources can be created, depending on the parameters:

diff --git a/data/default.yaml b/data/default.yaml
@@ -1,11 +1,11 @@
 ---
-patterndb::base_dir: /
-patterndb::temp_dir: /tmp/syslog-ng
 patterndb::package_name: false
 patterndb::manage_package: true
+patterndb::package_name: syslog-ng
 patterndb::syslogng_modules: []
 patterndb::use_hiera: false
 patterndb::_manage_top_dirs: true
 patterndb::test_before_deploy: &test_before_deploy true
 patterndb::parser::test_before_deploy: *test_before_deploy
-
+patterndb::config_dir: /etc/syslog-ng/patterndb.d
+patterndb::var_dir: /var/lib/syslog-ng
diff --git a/data/osfamily/Debian.yaml b/data/osfamily/Debian.yaml
@@ -0,0 +1,2 @@
+---
+patterndb::package_name: syslog-ng-core
diff --git a/data/osfamily/FreeBSD.yaml b/data/osfamily/FreeBSD.yaml
@@ -0,0 +1,3 @@
+---
+patterndb::config_dir: /usr/local/etc/patterndb.d
+patterndb::var_dir: /var/syslog-ng
diff --git a/examples/NOK_mismatching_action.pp b/examples/NOK_mismatching_action.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 Exec {

diff --git a/examples/OK_getent.pp b/examples/OK_getent.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package   => false,
-  base_dir         => '/tmp/',
   syslogng_modules => ['tfgetent'],
 }
 

diff --git a/examples/OK_hiera.pp b/examples/OK_hiera.pp
@@ -1,6 +1,5 @@
 #
 class { 'patterndb':
-  base_dir         => '/tmp/',
   manage_package   => false,
   syslogng_modules => [],
   use_hiera        => true,

diff --git a/examples/OK_hiera_puppet5.pp b/examples/OK_hiera_puppet5.pp
@@ -1,6 +1,5 @@
 #
 class { 'patterndb':
-  base_dir         => '/tmp/',
   manage_package   => false,
   syslogng_modules => [],
   use_hiera        => true,

diff --git a/examples/OK_hybrid.pp b/examples/OK_hybrid.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::raw::ruleset { 'raw':

diff --git a/examples/OK_ltgt.pp b/examples/OK_ltgt.pp
@@ -1,6 +1,5 @@
 #
 class { 'patterndb':
-  base_dir         => '/tmp/',
   manage_package   => false,
   syslogng_modules => [],
 }

diff --git a/examples/OK_modules.pp b/examples/OK_modules.pp
@@ -4,7 +4,6 @@
 }
 class { 'patterndb':
   manage_package   => false,
-  base_dir         => '/tmp/',
   syslogng_modules => ['basicfuncs'],
 }
 

diff --git a/examples/OK_multiple_pdb.pp b/examples/OK_multiple_pdb.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'dhclient':

diff --git a/examples/OK_notest.pp b/examples/OK_notest.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package     => false,
-  base_dir           => '/tmp/',
   syslogng_modules   => ['pdbtool_test_would_fail_with_this_module'],
   test_before_deploy => false,
 }

diff --git a/examples/OK_raw.pp b/examples/OK_raw.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package   => false,
-  base_dir         => '/tmp/',
   syslogng_modules => [],
 }
 

diff --git a/examples/OK_s.pp b/examples/OK_s.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 Patterndb::Simple::Rule {

diff --git a/examples/OK_separate_action.pp b/examples/OK_separate_action.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 Exec {

diff --git a/examples/OK_separate_rules.pp b/examples/OK_separate_rules.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'empty_ruleset':

diff --git a/examples/OK_separate_rules_and_actions.pp b/examples/OK_separate_rules_and_actions.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 Exec {

diff --git a/examples/OK_simple.pp b/examples/OK_simple.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'dhclient':

diff --git a/examples/OK_simple_action.pp b/examples/OK_simple_action.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'dhclient':

diff --git a/examples/OK_simple_coerce.pp b/examples/OK_simple_coerce.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'plop':

diff --git a/examples/OK_simple_context.pp b/examples/OK_simple_context.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'dhclient':

diff --git a/examples/OK_simple_empty.pp b/examples/OK_simple_empty.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package => false,
-  base_dir       => '/tmp/',
 }
 
 patterndb::simple::ruleset { 'empty':

diff --git a/examples/OK_yum.pp b/examples/OK_yum.pp
@@ -1,7 +1,6 @@
 #
 class { 'patterndb':
   manage_package     => false,
-  base_dir           => '/tmp',
   syslogng_modules   => [],
   test_before_deploy => true,
 }

diff --git a/manifests/init.pp b/manifests/init.pp
@@ -1,51 +1,30 @@
 #
 class patterndb (
-  String[1] $base_dir = '/',
-  String[1] $temp_dir = "${base_dir}/tmp/syslog-ng",
-  Variant[String[1],Boolean] $package_name = false,
+  String[1] $package_name,
+  Stdlib::Absolutepath $config_dir,
+  Stdlib::Absolutepath $var_dir,
+  Stdlib::Absolutepath $cache_dir = '/var/cache/syslog-ng',
   Boolean $manage_package = true,
   Array[String[1]] $syslogng_modules = [],
   Boolean $use_hiera = false,
-  Boolean $_manage_top_dirs = true,
   Boolean $test_before_deploy = true
 ) {
 # package
   if $manage_package {
-    if $package_name =~ String {
-      $real_package_name = $package_name
-    } else {
-      case $facts['os']['family'] {
-        'RedHat': { $real_package_name = 'syslog-ng' }
-        'Debian': { $real_package_name = 'syslog-ng-core' }
-        default: { fail("unsupported osfamily: ${facts['os']['family']}") }
-      }
-    }
-    ensure_resource ( 'package', $real_package_name, { 'ensure' => 'installed' })
-  }
-  ensure_resource ( 'file', $temp_dir, { ensure => directory })
-  if $_manage_top_dirs {
-    ensure_resource ( 'file', "${base_dir}/etc", { ensure => 'directory' })
-    ensure_resource ( 'file', "${base_dir}/var", { ensure => 'directory' })
-    ensure_resource ( 'file', "${base_dir}/var/lib", { ensure => 'directory' })
+    ensure_resource ( 'package', $package_name, { 'ensure' => 'installed' })
   }
+  ensure_resource ( 'file', $cache_dir, { ensure => directory })
   ensure_resource (
-    'file', "${base_dir}/etc/syslog-ng",
+    'file', $var_dir,
     { ensure => 'directory' }
   )
-  ensure_resource (
-    'file', "${base_dir}/var/lib/syslog-ng",
-    { ensure => 'directory' }
-  )
-  ensure_resource (
-    'file', "${base_dir}/var/lib/syslog-ng/patterndb",
-    {
-      ensure => 'directory',
-      purge => true,
-      recurse => true
-    }
-  )
-  $pdb_dir = "${base_dir}/etc/syslog-ng/patterndb.d"
-  file { $pdb_dir:
+  file { "${var_dir}/patterndb":
+    ensure  => 'directory',
+    purge   => true,
+    recurse => true,
+  }
+
+  file { $config_dir:
     ensure  => directory,
     purge   => true,
     force   => true,

diff --git a/manifests/parser.pp b/manifests/parser.pp
@@ -15,36 +15,36 @@
     $tmp = join($_modules,' --module=')
     $modules = "--module=${tmp}"
   }
-  ensure_resource('file', "${patterndb::pdb_dir}/${name}", {
+  ensure_resource('file', "${patterndb::config_dir}/${name}", {
       'ensure'  => 'directory',
       'purge'   => true,
       'force'   => true,
       'recurse' => true,
   })
-  ensure_resource ('file', "${patterndb::temp_dir}/patterndb", {
+  ensure_resource ('file', "${patterndb::cache_dir}/patterndb", {
       'ensure' => 'directory',
   })
   ensure_resource ('file', "patterndb::file::${name}", {
       'ensure' => 'present',
-      'path'   => "${patterndb::base_dir}/var/lib/syslog-ng/patterndb/${name}.xml"
+      'path'   => "${patterndb::var_dir}/patterndb/${name}.xml"
   })
   exec { "patterndb::merge::${name}":
-    command     => "pdbtool merge -r --glob \\*.pdb -D ${patterndb::pdb_dir}/${name} -p ${patterndb::temp_dir}/patterndb/${name}.xml",
+    command     => "pdbtool merge -r --glob \\*.pdb -D ${patterndb::config_dir}/${name} -p ${patterndb::cache_dir}/patterndb/${name}.xml",
     path        => $facts['path'],
     logoutput   => true,
     refreshonly => true,
   }
 
   exec { "patterndb::test::${name}":
-    #command    => "/usr/bin/pdbtool --validate test ${::patterndb::temp_dir}/patterndb/${name}.xml $modules",
-    command     => "pdbtool test ${patterndb::temp_dir}/patterndb/${name}.xml ${modules}",
+    #command    => "/usr/bin/pdbtool --validate test ${::patterndb::cache_dir}/patterndb/${name}.xml $modules",
+    command     => "pdbtool test ${patterndb::cache_dir}/patterndb/${name}.xml ${modules}",
     path        => $facts['path'],
     logoutput   => true,
     refreshonly => true,
   }
 
   exec { "patterndb::deploy::${name}":
-    command     => "cp ${patterndb::temp_dir}/patterndb/${name}.xml ${patterndb::base_dir}/var/lib/syslog-ng/patterndb/",
+    command     => "cp ${patterndb::cache_dir}/patterndb/${name}.xml ${patterndb::var_dir}/patterndb/",
     logoutput   => true,
     path        => $facts['path'],
     refreshonly => true,

diff --git a/manifests/raw/ruleset.pp b/manifests/raw/ruleset.pp
@@ -20,7 +20,7 @@
   }
 
   if $ensure == 'directory' {
-    file { "${patterndb::pdb_dir}/${parser}/${name}":
+    file { "${patterndb::config_dir}/${parser}/${name}":
       ensure       => $ensure,
       recurse      => $recurse,
       mode         => '0644',
@@ -31,7 +31,7 @@
       notify       => Exec["patterndb::merge::${parser}"],
     }
   } else {
-    file { "${patterndb::pdb_dir}/${parser}/${name}.pdb":
+    file { "${patterndb::config_dir}/${parser}/${name}.pdb":
       ensure => $ensure,
       mode   => '0644',
       source => $source,

diff --git a/manifests/simple/ruleset.pp b/manifests/simple/ruleset.pp
@@ -25,7 +25,7 @@
     }
   }
 
-  $pdb_file = "${patterndb::pdb_dir}/${parser}/${order}${name}.pdb"
+  $pdb_file = "${patterndb::config_dir}/${parser}/${order}${name}.pdb"
 
   concat { "patterndb_simple_ruleset-${title}":
     path   => $pdb_file,