Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

pdns (38) Versions 4.3.0

Installs/Configures PowerDNS Recursor and Authoritative server

Berkshelf/Librarian
Policyfile
Knife
cookbook 'pdns', '~> 4.3.0'
cookbook 'pdns', '~> 4.3.0', :supermarket
knife cookbook site install pdns
knife cookbook site download pdns
README
Dependencies
Changelog
Quality 89%

PowerDNS Community Cookbook

Provides resources for installing and configuring both PowerDNS authoritative and recursor. It uses the official PowerDNS repositories for packages and installs the appropiate configuration for your platform's init system.

Build Status

Build Status

Requirements

IMPORTANT: Please read the Deprecations and Compatibility Notes sections below since there are breaking changes between versions 2 and 3 of this cookbook.

Deprecations

  • The recipe and attribute based way of setting different PowerDNS installs is completely deprecated, there are no attributes in the newest version of this cookbok neither recipes to add to the run list.
  • pdnsrecord and domainrecord resources have been deprecated since they were coupled with sqlite3 backend.
  • Ubuntu 12.02 support has been removed, if you want this platform to be supported PRs are welcome, see the CONTRIBUTING.md file.

4.x Compatibility Notes

Users of the previous versions of the cookbook may find a few breaking changes. Here are the highlights:

Chef 12.14 or newer

To help clear up additional code and remove the 'yum' cookbook dependency, we have jumped up to Chef 12.14 as the minimum version. We'll look into the potential options of removing the 'apt' cookbook dependency as well.

pdns_authoritative_backend has been removed

This resource has been removed entirely because it would be easier to support allowing the user to select packages appropriate for their platform in the future and ease the burden on the maintainers for keeping what amounted to a massive hash table. To see how we achieved this setup, check out the test cookbook postgresql recipe under the test/ directory.

original instance is the new default

The previous version forced you down the path of creating virtual instances of a resolver or authoritative and left the original in place. This release now assumes you want to modify the original instance or create a virtual one based upon the original instance setup. If you look at the single install recipes, you'll see how this is done as the default case. Any named install or config resources without a name will use the default setup instance that comes with the package.

In most cases you want to only run one instance of PowerDNS Authoritative or Recursor on your system which is why we have now assumed this default for you.

Instance naming scheme

The instance naming schemes between versions of the 3.x cookbook were admittedly very inconsistent. We now directly follow the virtual instance naming scheme documentation at PowerDNS which will cause some breakage for you under the covers. You'll unfortunately have to review what your services are currently named and remove them if they clash with the updated naming scheme. Specifically check for underscores and hyphens in the name.

Speaking of instance naming, we now reject any virtual service name that contains a hypen. You will see a cookbook compile error if that is the case.

socket_dir property for recursor init service has been removed

This was not implemented correctly in the previous versions and it has been removed since it is now implemented via the custom init script

Platforms:

  • Ubuntu 14.04 and newer
  • Debian 8 and newer
  • RHEL 7 and newer
  • CentOS 6.9 and newer

Chef:

  • Chef 12.14 or newer

Init Systems:

  • SysV
  • systemd

Required Cookbooks:

  • apt

Usage

Combine the different resources in order to install, configure, and manage your PowerDNS instances. This is a list of resouces that can be used:

| Resource | Functionality | |-------------------------------------|---------------------------------------------------| | pdns_authoritative_install | Installs an authoritative server | | pdns_authoritative_config | Configures an authoritative instance | | pdns_authoritative_service | Manages an authoritative instance | | pdns_recursor_install | Installs a recusor | | pdns_recursor_config | Configures a recursor instance  | | pdns_recursor_service | Manages a a recursor instance |

To fully configure an authoritative server you need to add at least 3 resources to your recipe, pdns_authoritative_install, pdns_authoritative_config and pdns_authoritative_service. If you want to install any backend other than the default (bind) for the authoritative server you need to install the corresponding packages for the backend you want. There is an example for a postgresql backend in test/cookbooks/pdns_test/recipes/.

For a recursor use the pdns_recursor_install, pdns_recursor_config, and pdns_recursor_service resources in your wrapper cookbooks to install, configure, and define PowerDNS recursors. Set the different properties on the resources according to your install and configuration needs. You can see a good example of this in test/cookbooks/pdns_test/recipes_recursor_install_single.rb

For advanced use it is recommended to take a look at the chef resources themselves.

Properties

A note about instance names

PowerDNS parses the name of the instance by breaking apart the first hyphen it sees so all virtual service names (ones without a blank string) start with the service type and a hyphen. For example:

pdns_authoritative_config 'server_01' do
  action :create
  launch ['gpgsql']
  variables(
    gpgsql_host: '127.0.0.1',
    gpgsql_user: 'pdns',
    gpgsql_port: 5432,
    gpgsql_dbname: 'pdns',
    gpgsql_password: 'wadus'
  )
end

pdns_authoritative_service 'service_01' do
  action [:enable, :start]
end

Will create a file named /etc/powerdns/pdns-server_01.conf:

launch ['gpgsql']
gpgsql-host=127.0.0.1
gpgsql-user=pdns
gpgsql-port=5432
gpgsql-dbname=pdns
gpgsql-password=wadus

And a service named pdns-server_01 which is symbolically linked linked to pdns if you are using SysVinit.

General note about resource properties

Most properties are simple ruby strings, but there is another cases that require special attention. Properties specified as elements in arrays will be split up (see split ruby method) and separated by commas. Boolean properties will be always translated to 'yes' or 'no'. Some properties need to be set consistently accross resources, they will be noted in their specific sections at the top under 'Consistent?'. Most of the properties are optional and have sane defaults, so they are only recommended for customized installs.

pdns_authoritative_install

Installs PowerDNS authoritative server 4.X series using PowerDNS official repository in the supported platforms.

Properties

Name Class Default value Consistent?
instance_name String name_property Yes
version String, nil nil No
debug true, false false No

Usage example

Install a PowerDNS authoritative server package named server-01 with the latest version available in the repository.

pdns_authoritative_install 'server_01' do
  action :install
end

pdns_authoritative_config

Creates a PowerDNS recursor configuration, there is a fixed set of required properties (listed below) but most of the configuration is left to the user freely, every property set in the variables hash property will be rendered in the config template. Remember that using underscores _ for property names is required and it's translated to hyphens - in configuration templates.

Properties

Name Class Default value Consistent?
instance_name String name_property Yes
launch Array, nil ['bind'] No
config_dir String see default_authoritative_config_directory helper method Yes
socket_dir String "/var/run/#{resource.instance_name}" Yes
run_group String see default_authoritative_run_user helper method No
run_user String see default_authoritative_run_user helper method No
run_user_home String see default_user_attributes helper method No
run_user_shell String see default_user_attributes helper method No
setuid String resource.run_user No
setgid String resource.run_group No
source String,nil 'authoritative_service.conf.erb' No
cookbook String,nil 'pdns' No
variables Hash { bind_config: "#{resource.config_dir}/bindbackend.conf" } No

Usage Example

Create a PowerDNS authoritative configuration file named server-01:

pdns_authoritative_config 'server_01' do
  action :create
  launch ['gpgsql']
  variables(
    gpgsql_host: '127.0.0.1',
    gpgsql_user: 'pdns',
    gpgsql_port: 5432,
    gpgsql_dbname: 'pdns',
    gpgsql_password: 'wadus',
    allow_axfr_ips: [ '127.0.0.0/8', '::1', '195.234.23,34'],
    api: true,
    api-_eadonly: true
    )
end

pdns_authoritative_service

Creates a init service to manage a PowerDNS authoritative instance. This service supports all the regular actions (start, stop, restart, etc.). Check the compatibility section to see which init services are supported.

Important: services are not restarted or reloaded automatically on config changes in this cookbook, you need to add this in your wrapper cookbook if you desire this functionality, the pdns_authoritative_service cookbook provides actions to do it.

Properties

Name Class Default value Consistent?
instance_name String name_property Yes
cookbook String 'pdns' No
source String 'authoritative.init.debian.erb' No
config_dir String See default_authoritative_config_directory helper method Yes
socket_dir String "/var/run/#{instance_name}" Yes
variables Hash {} No

Usage example

pdns_authoritative_service 'server_01' do
  action [:enable, :start]
end

pdns_recursor_install

Installs PowerDNS recursor 4.X series using PowerDNS official repository in the supported platforms.

Properties

Name Class Default value Consistent?
version String name_property Yes
debug True, False String, nil No

Usage Example

Install a 4. powerdns instance named 'my_recursor' on ubuntu 14.04:

pdns_recursor_install 'my_recursor' do
  version '4.0.4-1pdns.trusty'
end

pdns_recursor_service

Sets up a PowerDNS recursor instance using the appropiate init system .

Important: services not restarted or reloaded automatically on config changes in this cookbook, you need to add this in your wrapper cookbook if you desire this functionality, the pdns_recursor_service cookbook provides actions to do it.

Properties

Name Class Default value Consistent?
instance_name String name_property Yes
config_dir String see default_recursor_config_directory helper method Yes
cookbook (SysVinit) String,nil 'pdns' No
source (SysVinit) String,nil 'recursor.init.#{node['platform_family']}.erb' No
variables (SysVinit) Hash {} No
  • config_dir: Path of the recursor configuration directory.
  • cookbook: Cookbook for a custom configuration template (Applied only when using SysVinit).
  • source: Name of the recursor custom template (Applied only when using SysVinit).
  • variables: Variables hash to pass to the sysvinit template

Usage Example

Configure a PowerDNS recursor service instance named 'my_recursor' in your wrapper cookbook for Acme Corp with a custom template named my-recursor.erb

pdns_recursor_service 'my_recursor' do
  source 'my-recursor.erb'
  cookbook 'acme-pdns-recursor'
end

pdns_recursor_config

Creates a PowerDNS recursor configuration.

Properties

| | Name | Class | Default value | Consistent? | |----------------|-------------|--------------------------------------------------------|-------------| | instance_name | String | name_property | Yes | | config_dir | String | see default_recursor_config_directory helper method | Yes | | socket_dir | String | /var/run/#{resource.instance_name} | Yes | | run_group | String | see default_recursor_run_user helper method | No | | run_user | String | see default_recursor_run_user helper method | No | | run_user_home | String | see default_user_attributes helper method | No | | run_user_shell | String | see default_user_attributes helper method | No | | setuid | String | resource.run_user | No | | setgid | String | resource.run_group | No | | source | String, nil | 'recursor_service.conf.erb' | No | | cookbook | String, nil | 'pdns' | No | | variables | Hash | {} | No |

  • config_dir (C): Path of the recursor configuration directory.
  • socket_dir (C): Directory where sockets are created.
  • source (C): Name of the recursor custom template.
  • socket_dir (C): Directory where sockets are created.
  • cookbook (C): Cookbook for a custom configuration template
  • variables: Variables for the configuration template.
  • run_group: Unix group that runs the recursor.
  • run_user: Unix user that runs the recursor.
  • run_user_home: Home of the Unix user that runs the recursor.
  • run_user_shell: Shell of the Unix user that runs the recursor.

Usage Example

Create a PowerDNS recursor configuration named 'my_recursor' in your wrapper cookbook for Acme Corp which uses a custom template named my-recursor.erb and a few attributes:

pdns_recursor_config 'my_recursor' do
  source 'my-recursor.erb'
  cookbook 'acme-pdns-recursor'
  variables(client-tcp-timeout: '20', loglevel: '5', network-timeout: '2000')
end

Virtual Hosting

PowerDNS supports virtual hosting: running many instances of PowerDNS on different ports on the same machine. This is done by a few clever hacks on the init scripts that allow to specify different config files for each instance. This cookbook leverages this functionality in both recursor and authoritative.

PowerDNS recommends a specific naming schema authoritative for virtual hosting. Specifically it does not allow hyphens (-) on the init scripts beyond the first which is provided by the init script (/etc/init.d/pdns-).

We have adopted the convention of using underscores (_) in the name attributes of underscores in order to comply with this requirement.

Contributing

There is an specific file for contributing guidelines on this cokbook: CONTRIBUTING.md

Testing

There is an specific file for testing guidelines on this cokbook: TESTING.md

License & Authors

Copyright:: 2010-2014, Chef Software, Inc & 2014-2016 Aetrion, LLC.

Licensed under the Apache License, Version 2.0 (the "License");
you may not use this file except in compliance with the License.
You may obtain a copy of the License at

    http://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software
distributed under the License is distributed on an "AS IS" BASIS,
WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
See the License for the specific language governing permissions and
limitations under the License.

Dependent cookbooks

apt >= 0.0.0

Contingent cookbooks

There are no cookbooks that are contingent upon this one.

Change Log

v4.3.0 (2017-08-16)

Full Changelog

Fixed bugs:

v4.2.0 (2017-08-16)

Full Changelog

Merged pull requests:

v4.1.0 (2017-08-09)

Full Changelog

Fixed bugs:

Closed issues:

  • Allow users to be appended to the pdns unix group #81
  • Drop apt and yum cookbooks #59

v4.0.0 (2017-08-04)

Full Changelog

Implemented enhancements:

  • Refactor resources to match packaging configurations #80 (therobot)

Closed issues:

  • Add Systemd support #58

v3.5.0 (2017-07-13)

Full Changelog

v3.4.1 (2017-06-29)

Full Changelog

Closed issues:

  • pdns_recursor_service_sysvinit behaves different when using Vagrant or Docker as providers #77
  • Recursor refuses to start with custom socket-dir setting #74

Merged pull requests:

  • Stopping default recursor on debian based distros for sysvinit #78 (therobot)
  • Removing DB schema #76 (therobot)

v3.4.0 (2017-06-27)

Full Changelog

Merged pull requests:

v3.3.2 (2017-06-23)

Full Changelog

Merged pull requests:

  • Create PID directory on init start commands #75 (therobot)

v3.3.1 (2017-06-20)

Full Changelog

Merged pull requests:

v3.3.0 (2017-06-14)

Full Changelog

Merged pull requests:

v3.2.0 (2017-06-02)

Full Changelog

Implemented enhancements:

v3.1.0 (2017-06-01)

Full Changelog

Merged pull requests:

  • Enhance and fix matchers #67 (therobot)
  • Add systemd support for recursor and authoritative PowerDNS #66 (jmauro)

v3.0.0 (2017-05-29)

Full Changelog

Implemented enhancements:

  • Improving the way configuration options are handled #24
  • Authoritative Resource #49 (therobot)
  • PowerDNS recursor using Chef 12.5+ resource #48 (therobot)

Fixed bugs:

  • Missing libssl-dev on source installs #44

Closed issues:

  • Add tests for multi recursor-multi #60
  • Add integration test for multi suits #57
  • Virtual hosting for recursor #55
  • Rename cookbook repository and update metadata/README #47
  • Sunset Chef 10.x and possibly 11.x support? #28
  • Switch to bind for the default backend #23
  • converge will fail on centos 6.5 #18
  • Refactor the use of mysql::client #15

Merged pull requests:

v2.5.0 (2017-02-08)

Full Changelog

Merged pull requests:

v2.4.1 (2016-09-14)

Full Changelog

Merged pull requests:

v2.4.0 (2016-09-13)

Full Changelog

Merged pull requests:

  • Change to make the cookbook compatible with CentOS/RHEL #36 (stromp)

v2.3.0 (2016-09-09)

Full Changelog

Closed issues:

  • Bootstrapping fails #35

Merged pull requests:

v2.2.1 (2016-03-04)

Full Changelog

v2.2.0 (2016-03-04)

Full Changelog

v2.1.1 (2016-03-04)

Full Changelog

Closed issues:

  • No pdns-server package #33

v2.1.0 (2016-01-11)

Full Changelog

Merged pull requests:

  • Minimal support for a authoritative bind backend #32 (therobot)

v2.0.0 (2016-01-04)

Full Changelog

Merged pull requests:

  • Building a recursor from source and major cleanup #31 (therobot)

v1.1.1 (2015-12-23)

Full Changelog

Merged pull requests:

  • Cleanup, bug fixes and small improvements. #30 (therobot)

v1.1.0 (2015-12-10)

Full Changelog

v1.0.5 (2015-11-10)

Full Changelog

v1.0.4 (2015-09-02)

Full Changelog

v1.0.3 (2015-05-04)

Full Changelog

v1.0.2 (2015-05-04)

Full Changelog

Merged pull requests:

v1.0.1 (2014-12-17)

Full Changelog

v1.0.0 (2014-12-15)

Full Changelog

Merged pull requests:

v0.3.4 (2014-07-15)

Full Changelog

Merged pull requests:

v0.3.3 (2014-07-14)

Full Changelog

v0.3.2 (2014-07-14)

Full Changelog

Merged pull requests:

v0.3.0 (2014-02-21)

Full Changelog

v0.2.0 (2013-08-28)

Full Changelog

Merged pull requests:

  • [COOK-3106] Build PowerDNS from source #8 (dje)

0.1.2 (2013-05-28)

Merged pull requests:

  • [COOK-2986] Fix foodcritic warnings #7 (stevendanna)
  • [COOK-2604] Configure a PowerDNS server #2 (dje)

* This Change Log was automatically generated by github_changelog_generator

Collaborator Number Metric
            

4.3.0 passed this metric

Contributing File Metric
            

4.3.0 passed this metric

Foodcritic Metric
            

4.3.0 passed this metric

License Metric
            

4.3.0 passed this metric

No Binaries Metric
            

4.3.0 failed this metric

Failure: Cookbook should not contain binaries. Found:
pdns/files/default/powerdns.asc

Publish Metric
            

4.3.0 passed this metric

Supported Platforms Metric
            

4.3.0 passed this metric

Testing File Metric
            

4.3.0 passed this metric

Version Tag Metric
            

4.3.0 passed this metric