Add support for YAML config

REFERENCE.md

@@ -19,7 +19,8 @@
 
 ### Defined types
 
-* [`powerdns::config`](#powerdns--config): Manage powerdns settings
+* [`powerdns::config`](#powerdns--config): Manage powerdns settings in old format, see https://doc.powerdns.com/recursor/settings.html
+Supported up to recursor version 5.2.
 
 ### Resource types
 
@@ -107,6 +108,12 @@ The following parameters are available in the `powerdns` class:
 * [`authoritative_group`](#-powerdns--authoritative_group)
 * [`authoritative_file_owner`](#-powerdns--authoritative_file_owner)
 * [`authoritative_file_group`](#-powerdns--authoritative_file_group)
+* [`recursor_use_yaml`](#-powerdns--recursor_use_yaml)
+* [`recursor_config_includedir`](#-powerdns--recursor_config_includedir)
+* [`recursor_forward_zones_file`](#-powerdns--recursor_forward_zones_file)
+* [`recursor_local_config_file`](#-powerdns--recursor_local_config_file)
+* [`recursor_local_config`](#-powerdns--recursor_local_config)
+* [`recursor_forward_zones`](#-powerdns--recursor_forward_zones)
 
 ##### <a name="-powerdns--authoritative_package_name"></a>`authoritative_package_name`
 
@@ -152,7 +159,7 @@ Authoritative config file path
 
 ##### <a name="-powerdns--authoritative_version"></a>`authoritative_version`
 
-Data type: `Pattern[/4\.[0-9]+/]`
+Data type: `Pattern[/[4,5]\.[0-9]+/]`
 
 Authoritative server version
 
@@ -545,6 +552,54 @@ Group of authoritative config files
 
 Default value: `$authoritative_group`
 
+##### <a name="-powerdns--recursor_use_yaml"></a>`recursor_use_yaml`
+
+Data type: `Boolean`
+
+
+
+Default value: `false`
+
+##### <a name="-powerdns--recursor_config_includedir"></a>`recursor_config_includedir`
+
+Data type: `Optional[Stdlib::Absolutepath]`
+
+
+
+Default value: `undef`
+
+##### <a name="-powerdns--recursor_forward_zones_file"></a>`recursor_forward_zones_file`
+
+Data type: `Optional[Stdlib::Absolutepath]`
+
+
+
+Default value: `undef`
+
+##### <a name="-powerdns--recursor_local_config_file"></a>`recursor_local_config_file`
+
+Data type: `Optional[Stdlib::Absolutepath]`
+
+
+
+Default value: `undef`
+
+##### <a name="-powerdns--recursor_local_config"></a>`recursor_local_config`
+
+Data type: `Optional[Hash]`
+
+
+
+Default value: `undef`
+
+##### <a name="-powerdns--recursor_forward_zones"></a>`recursor_forward_zones`
+
+Data type: `Optional[Tuple]`
+
+
+
+Default value: `undef`
+
 ### <a name="powerdns--authoritative"></a>`powerdns::authoritative`
 
 powerdns::authoritative
@@ -582,6 +637,7 @@ powerdns recursor
 The following parameters are available in the `powerdns::recursor` class:
 
 * [`forward_zones`](#-powerdns--recursor--forward_zones)
+* [`config`](#-powerdns--recursor--config)
 
 ##### <a name="-powerdns--recursor--forward_zones"></a>`forward_zones`
 
@@ -591,6 +647,15 @@ Hash containing zone => dns servers pairs
 
 Default value: `$powerdns::forward_zones`
 
+##### <a name="-powerdns--recursor--config"></a>`config`
+
+Data type: `Hash`
+
+recursor config (will be converted to YAML, see https://doc.powerdns.com/recursor/yamlsettings.html)
+when powerdns::recursor_use_yaml is set to `true`
+
+Default value: `{}`
+
 ### <a name="powerdns--repo"></a>`powerdns::repo`
 
 powerdns::repo
@@ -599,7 +664,8 @@ powerdns::repo
 
 ### <a name="powerdns--config"></a>`powerdns::config`
 
-Manage powerdns settings
+Manage powerdns settings in old format, see https://doc.powerdns.com/recursor/settings.html
+Supported up to recursor version 5.2.
 
 #### Parameters
 

data/common.yaml

@@ -1,10 +1,14 @@
 ---
+lookup_options:
+  powerdns::recursor_local_config:
+    merge: deep
 powerdns::authoritative_package_ensure: installed
 powerdns::authoritative_extra_packages_ensure: installed
-powerdns::authoritative_version: '4.9'
+powerdns::authoritative_version: "4.9"
 powerdns::recursor_package_ensure: installed
-powerdns::recursor_version: '5.0'
+powerdns::recursor_version: "5.0"
 powerdns::recursor_user: pdns
 powerdns::recursor_group: pdns
 powerdns::recursor_file_owner: root
 powerdns::recursor_file_group: "%{lookup('powerdns::recursor_group')}"
+powerdns::recursor_use_yaml: false

data/os/Debian/12.yaml

@@ -0,0 +1,9 @@
+---
+powerdns::mysql_charset: utf8mb3
+powerdns::mysql_collate: utf8mb3_general_ci
+powerdns::authoritative_version: "5.0"
+powerdns::recursor_version: "5.3"
+powerdns::recursor_use_yaml: true
+powerdns::recursor_config_includedir: "%{lookup('powerdns::recursor_configdir')}/recursor.d"
+powerdns::recursor_forward_zones_file: "%{lookup('powerdns::recursor_configdir')}/forward-zones.yml"
+powerdns::recursor_local_config_file: "%{lookup('powerdns::recursor_config_includedir')}/00-local.yml"

data/os/Debian/13.yaml

@@ -0,0 +1,9 @@
+---
+powerdns::mysql_charset: utf8
+powerdns::mysql_collate: utf8_general_ci
+powerdns::authoritative_version: "5.0"
+powerdns::recursor_version: "5.3"
+powerdns::recursor_use_yaml: true
+powerdns::recursor_config_includedir: "%{lookup('powerdns::recursor_configdir')}/recursor.d"
+powerdns::recursor_forward_zones_file: "%{lookup('powerdns::recursor_configdir')}/forward-zones.yml"
+powerdns::recursor_local_config_file: "%{lookup('powerdns::recursor_config_includedir')}/00-local.yml"

data/os/Ubuntu/22.04.yaml

@@ -0,0 +1,7 @@
+---
+powerdns::authoritative_version: "5.0"
+powerdns::recursor_version: "5.3"
+powerdns::recursor_use_yaml: true
+powerdns::recursor_config_includedir: "%{lookup('powerdns::recursor_configdir')}/recursor.d"
+powerdns::recursor_forward_zones_file: "%{lookup('powerdns::recursor_configdir')}/forward-zones.yml"
+powerdns::recursor_local_config_file: "%{lookup('powerdns::recursor_config_includedir')}/00-local.yml"

data/os/Ubuntu/24.04.yaml

@@ -0,0 +1,7 @@
+---
+powerdns::authoritative_version: "5.0"
+powerdns::recursor_version: "5.3"
+powerdns::recursor_use_yaml: true
+powerdns::recursor_config_includedir: "%{lookup('powerdns::recursor_configdir')}/recursor.d"
+powerdns::recursor_forward_zones_file: "%{lookup('powerdns::recursor_configdir')}/forward-zones.yml"
+powerdns::recursor_local_config_file: "%{lookup('powerdns::recursor_config_includedir')}/00-local.yml"

manifests/config.pp

@@ -1,4 +1,5 @@
-# @summary Manage powerdns settings
+# @summary Manage powerdns settings in old format, see https://doc.powerdns.com/recursor/settings.html
+#   Supported up to recursor version 5.2.
 #
 # @param setting
 #   The setting you want to change

manifests/init.pp

@@ -132,7 +132,7 @@
   String[1] $authoritative_service_name,
   Stdlib::Absolutepath $authoritative_configdir,
   Stdlib::Absolutepath $authoritative_config,
-  Pattern[/4\.[0-9]+/] $authoritative_version,
+  Pattern[/[4,5]\.[0-9]+/] $authoritative_version,
   Stdlib::Absolutepath $db_file,
   Stdlib::Absolutepath $mysql_schema_file,
   Stdlib::Absolutepath $pgsql_schema_file,
@@ -157,6 +157,12 @@
   Optional[String[1]] $mysql_collate = undef,
   Boolean $authoritative = true,
   Boolean $recursor = false,
+  Boolean $recursor_use_yaml = false,
+  Optional[Stdlib::Absolutepath] $recursor_config_includedir = undef,
+  Optional[Stdlib::Absolutepath] $recursor_forward_zones_file = undef,
+  Optional[Stdlib::Absolutepath] $recursor_local_config_file = undef,
+  Optional[Hash] $recursor_local_config = undef,
+  Optional[Tuple] $recursor_forward_zones = undef,
   Powerdns::Backends $backend = 'mysql',
   Boolean $backend_install = true,
   Boolean $backend_create_tables = true,
@@ -226,7 +232,9 @@
     # Set up Hiera for the recursor.
     $powerdns_recursor_config = lookup('powerdns::recursor::config', Hash, 'deep', {})
     $powerdns_recursor_defaults = { 'type' => 'recursor' }
-    create_resources(powerdns::config, $powerdns_recursor_config, $powerdns_recursor_defaults)
+    if !($recursor_use_yaml) {
+      create_resources(powerdns::config, $powerdns_recursor_config, $powerdns_recursor_defaults)
+    }
   }
 
   if $purge_autoprimaries {

manifests/recursor.pp

@@ -2,37 +2,89 @@
 #
 # @param forward_zones
 #   Hash containing zone => dns servers pairs
+# @param config recursor config (will be converted to YAML, see https://doc.powerdns.com/recursor/yamlsettings.html)
+#   when powerdns::recursor_use_yaml is set to `true`
 #
 class powerdns::recursor (
   Hash $forward_zones = $powerdns::forward_zones,
+  Hash $config = {},
 ) inherits powerdns {
   package { $powerdns::recursor_package_name:
     ensure => $powerdns::recursor_package_ensure,
   }
 
-  file { $powerdns::recursor_config:
-    ensure  => file,
-    owner   => $powerdns::recursor_file_owner,
-    group   => $powerdns::recursor_file_group,
-    require => Package[$powerdns::recursor_package_name],
-  }
+  if $powerdns::recursor_use_yaml {
+    ## Use New YAML based configuration
+    $forward_block = empty($powerdns::recursor_forward_zones) ? {
+      true  => {},
+      false => { 'forward_zones_file' => $powerdns::recursor_forward_zones_file },
+    }
+
+    $recursor_config = {
+      'recursor' => {
+        'include_dir' => $powerdns::recursor_config_includedir,
+      } + $forward_block + $config,
+    }
+
+    if !empty($powerdns::recursor_forward_zones) {
+      file { $powerdns::recursor_forward_zones_file:
+        ensure  => file,
+        owner   => $powerdns::recursor_file_owner,
+        group   => $powerdns::recursor_file_group,
+        content => stdlib::to_yaml($powerdns::recursor_forward_zones),
+        notify  => Service['pdns-recursor'],
+      }
+    }
+    file { $powerdns::recursor_config_includedir:
+      ensure  => directory,
+      owner   => $powerdns::recursor_file_owner,
+      group   => $powerdns::recursor_file_group,
+      require => Package[$powerdns::recursor_package_name],
+    }
 
-  if !empty($forward_zones) {
-    $zone_config = "${powerdns::recursor_configdir}/forward_zones.conf"
-    file { $zone_config:
+    file { $powerdns::recursor_config:
       ensure  => file,
       owner   => $powerdns::recursor_file_owner,
       group   => $powerdns::recursor_file_group,
-      content => template('powerdns/forward_zones.conf.erb'),
+      content => stdlib::to_yaml($recursor_config),
+      require => Package[$powerdns::recursor_package_name],
       notify  => Service['pdns-recursor'],
     }
 
-    powerdns::config { 'forward-zones-file':
-      value => $zone_config,
-      type  => 'recursor',
+    file { $powerdns::recursor_local_config_file:
+      ensure  => file,
+      owner   => $powerdns::recursor_file_owner,
+      group   => $powerdns::recursor_file_group,
+      content => stdlib::to_yaml(lookup('powerdns::recursor_local_config', Data, 'deep', {})),
+      require => Package[$powerdns::recursor_package_name],
+      notify  => Service['pdns-recursor'],
     }
-  }
+  } else {
+    ## Use Old INI based configuration
 
+    file { $powerdns::recursor_config:
+      ensure  => file,
+      owner   => $powerdns::recursor_file_owner,
+      group   => $powerdns::recursor_file_group,
+      require => Package[$powerdns::recursor_package_name],
+    }
+
+    if !empty($forward_zones) {
+      $zone_config = "${powerdns::recursor_configdir}/forward_zones.conf"
+      file { $zone_config:
+        ensure  => file,
+        owner   => $powerdns::recursor_file_owner,
+        group   => $powerdns::recursor_file_group,
+        content => template('powerdns/forward_zones.conf.erb'),
+        notify  => Service['pdns-recursor'],
+      }
+
+      powerdns::config { 'forward-zones-file':
+        value => $zone_config,
+        type  => 'recursor',
+      }
+    }
+  }
   service { 'pdns-recursor':
     ensure  => running,
     name    => $powerdns::recursor_service_name,

metadata.json

@@ -53,6 +53,7 @@
     {
       "operatingsystem": "Ubuntu",
       "operatingsystemrelease": [
+        "22.04",
         "24.04"
       ]
     },

spec/acceptance/class_spec.rb

@@ -46,7 +46,7 @@ class { 'powerdns':
     end
 
     describe command('/usr/bin/pdns_control version') do
-      its(:stdout) { is_expected.to match %r{^4\.9} }
+      its(:stdout) { is_expected.to match %r{^(4\.9|5\.\d)} }
     end
   end