Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Added support to modify service startup #130

Merged
merged 11 commits into from
Aug 5, 2015
5 changes: 5 additions & 0 deletions manifests/server/params.pp
Original file line number Diff line number Diff line change
Expand Up @@ -14,7 +14,10 @@
$package = 'bind9'
$service = 'bind9'
$necessary_packages = [ 'bind9', 'dnssec-tools' ]
$startup_file = '/etc/default/bind9'
$startup_template = 'startup.debian.erb'
$default_dnssec_validation = 'auto'

}
'RedHat': {
$cfg_dir = '/etc/named'
Expand All @@ -28,6 +31,8 @@
$package = 'bind'
$service = 'named'
$necessary_packages = [ 'bind', ]
$startup_file = '/etc/sysconfig/named'
$startup_template = 'startup.redhat.erb'
if $::operatingsystemmajrelease =~ /^[1-5]$/ {
$default_dnssec_validation = 'absent'
} else {
Expand Down
90 changes: 90 additions & 0 deletions manifests/server/startup.pp
Original file line number Diff line number Diff line change
@@ -0,0 +1,90 @@
# == Define: dns::server::startup
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think we are ready to need this. I don't really like the name "startup" though, it makes me think it handles init script.

How about class: dns::server::defaults_file ?

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

How about class dns::server::defaults? The definition of defaults_file will be used in the code to set the filename.

Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

That sounds fine

#
# BIND server template-based configuration definition.
#
# === Parameters
#
# $startup_file
# Must be an absolute path to the bind9 file as title
#
# [*resolvconf*]
# Set string "yes" or "no". Default: no
#
# [*options*]
# String to set user and IPv4/IPv& Support. Default: -u bind
#
# [*rootdir*]
# Must be an absolute path to set up the chroot environment
#
# [*enable_zone_write*]
# If SELinux is disabled, then allow named to write its zone files
# Set string "yes", "no" or leave empty. Default: empty
#
# [*enable_sdb]
# Enables use of 'named_sdb', which has support for the ldap
# Set string "yes", "no" or leave empty. Default: empty
#
# [*keytab_file*]
# Must be an absolute path to set up the keytab file
#
# [*disable_zone_checking*]
# If you set this option to 'yes' then initscript doesn't perform named-checkzone
# Set string "yes", "no" or leave empty. Default: empty
#
# === Examples
#
# dns::server::startup { '/etc/default/bind9':
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I don't want to make the same mistake as the options file. This shouldn't be a defined type that users have to "remember" to add to their manifest. init.pp should include this.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It isn't a defined type, so i have to correct the documentation. Thanks for the hint.

# resolvconf => 'no',
# options => '-u bind'
# }
#
class dns::server::startup (
Copy link
Collaborator

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

Is it a define or a class? Should be a class, we only have one o them.

Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

It is a class, the documentation is wrong. I correct it immediately.


$startup_file = $dns::server::params::startup_file,
$startup_template = $dns::server::params::startup_template,

$resolvconf = undef,
$options = undef,
$rootdir = undef,
$enable_zone_write = undef,
$enable_sdb = undef,
$disable_named_dbus = undef,
$keytab_file = undef,
$disable_zone_checking = undef,

) inherits dns::server::params {

if ! defined(Class['::dns::server']) {
fail('You must include the ::dns::server base class before using any dns default defined resources')
}

validate_absolute_path( $startup_file )

if $resolvconf != '' {
validate_re( $resolvconf, '^(yes|no)$', 'The resolvconf value is not type of a string yes / no.' )
}

if $rootdir != '' {
validate_absolute_path( $rootdir )
}

validate_re( $enable_zone_write, '^(yes|no|\s*)$', 'The enable_zone_write value is not type of a string yes / no or empty.' )

validate_re( $enable_sdb, '^(yes|no|1|0|\s*)$', 'The enable_sdb value is not type of a string yes / no / 1 / 0 or empty.' )

if $keytab_file != '' {
validate_absolute_path( $keytab_file )
}

validate_re( $disable_zone_checking, '^(yes|no|\s*)$', 'The disable_zone_checking value is not type of a string yes / no or empty.' )

file { $startup_file:
ensure => present,
owner => $::dns::server::params::owner,
group => $::dns::server::params::group,
mode => '0644',
content => template("${module_name}/${startup_template}"),
notify => Class['dns::server::service'],
}

}
3 changes: 2 additions & 1 deletion spec/classes/dns__server__config_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -22,7 +22,8 @@
context "on a RedHat OS" do
let :facts do
{
:osfamily => 'RedHat'
:osfamily => 'RedHat',
:concat_basedir => '/dne',
}
end
it { should contain_file('/etc/named.conf').with_owner('named') }
Expand Down
156 changes: 156 additions & 0 deletions spec/classes/server/startup_spec.rb
Original file line number Diff line number Diff line change
@@ -0,0 +1,156 @@
require 'spec_helper'

describe 'dns::server::startup', :type => :type do

let :pre_condition do
'class { "::dns::server": }'
end

context "on an unsupported OS" do
it{ should raise_error(/dns::server is incompatible with this osfamily/) }
end

context 'by default on debian' do

let(:facts) {{ :osfamily => 'Debian', :concat_basedir => '/tmp' }}

context "passing correct values and paths" do

context 'passing `no` to resolvconf' do
let(:params) {{ :resolvconf => 'no' }}
it { should contain_file('/etc/default/bind9').with_content(/RESOLVCONF=no/) }
end

context 'passing `yes` to resolvconf' do
let(:params) {{ :resolvconf => 'yes' }}
it { should contain_file('/etc/default/bind9').with_content(/RESOLVCONF=yes/) }
end

context 'passing `-u bind -4` to options' do
let(:params) {{ :options => '-u bind -4' }}
it { should contain_file('/etc/default/bind9').with_content(/OPTIONS="-u bind -4"/) }
end

context 'passing `-u bind -6` to options' do
let(:params) {{ :options => '-u bind -6' }}
it { should contain_file('/etc/default/bind9').with_content(/OPTIONS="-u bind -6"/) }
end

end

context "passing wrong values and paths" do

context 'passing wrong value to resolvconf for hit an error' do
let(:params) {{ :resolvconf => 'WrongValue' }}
it{ should raise_error(/The resolvconf value is not type of a string yes \/ no./)}
end

end

end

context 'by default on redhat' do

let(:facts) {{ :osfamily => 'RedHat', :concat_basedir => '/tmp' }}

context "passing correct values and paths" do

context 'passing path `/chroot` to rootdir' do
let(:params) {{ :rootdir => '/chroot' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ROOTDIR="\/chroot"/) }
end

context 'passing `-u named` to options' do
let(:params) {{ :options => '-u named' }}
it { should contain_file('/etc/sysconfig/named').with_content(/OPTIONS="-u named"/) }
end

context 'passing `yes` to enable_zone_write' do
let(:params) {{ :enable_zone_write => 'yes' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ENABLE_ZONE_WRITE=yes/) }
end

context 'passing `no` to enable_zone_write' do
let(:params) {{ :enable_zone_write => 'no' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ENABLE_ZONE_WRITE=no/) }
end

context 'passing `yes` to enable_sdb' do
let(:params) {{ :enable_sdb => 'yes' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ENABLE_SDB=yes/) }
end

context 'passing `no` to enable_sdb' do
let(:params) {{ :enable_sdb => 'no' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ENABLE_SDB=no/) }
end

context 'passing `1` to enable_sdb' do
let(:params) {{ :enable_sdb => '1' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ENABLE_SDB=1/) }
end

context 'passing `0` to enable_sdb' do
let(:params) {{ :enable_sdb => '0' }}
it { should contain_file('/etc/sysconfig/named').with_content(/ENABLE_SDB=0/) }
end

context 'passing `yes` to disable_named_dbus' do
let(:params) {{ :disable_named_dbus => 'yes' }}
it { should contain_file('/etc/sysconfig/named').with_content(/DISABLE_NAMED_DBUS=yes/) }
end

context 'passing `no` to disable_named_dbus' do
let(:params) {{ :disable_named_dbus => 'no' }}
it { should contain_file('/etc/sysconfig/named').with_content(/DISABLE_NAMED_DBUS=no/) }
end

context 'passing path `/usr/local/samba/private/dns.keytab` to keytab_file' do
let(:params) {{ :keytab_file => '/usr/local/samba/private/dns.keytab' }}
it { should contain_file('/etc/sysconfig/named').with_content(/KEYTAB_FILE="\/usr\/local\/samba\/private\/dns.keytab/) }
end

context 'passing `yes` to disable_zone_checking' do
let(:params) {{ :disable_zone_checking => 'yes' }}
it { should contain_file('/etc/sysconfig/named').with_content(/DISABLE_ZONE_CHECKING=yes/) }
end

context 'passing `no` to disable_zone_checking' do
let(:params) {{ :disable_zone_checking => 'no' }}
it { should contain_file('/etc/sysconfig/named').with_content(/DISABLE_ZONE_CHECKING=no/) }
end

end

context "passing wrong values and paths" do

context 'passing wrong value to rootdir for hit an error' do
let(:params) {{ :rootdir => 'chroot' }}
it{ should raise_error(/"chroot" is not an absolute path./)}
end

context 'passing wrong value to enable_zone_write for hit an error' do
let(:params) {{ :enable_zone_write => 'WrongValue' }}
it{ should raise_error(/The enable_zone_write value is not type of a string yes \/ no./)}
end

context 'passing wrong value to enable_sdb for hit an error' do
let(:params) {{ :enable_sdb => 'WrongValue' }}
it{ should raise_error(/The enable_sdb value is not type of a string yes \/ no \/ 1 \/ 0 or empty./)}
end

context 'passing wrong value to keytab_file for hit an error' do
let(:params) {{ :keytab_file => 'usr/local/samba/private/dns.keytab' }}
it{ should raise_error(/"usr\/local\/samba\/private\/dns.keytab" is not an absolute path./)}
end

context 'passing wrong value to disable_zone_checking for hit an error' do
let(:params) {{ :disable_zone_checking => 'chroot' }}
it{ should raise_error(/The disable_zone_checking value is not type of a string yes \/ no or empty./)}
end

end

end

end
6 changes: 3 additions & 3 deletions spec/defines/dns__server__options_spec.rb
Original file line number Diff line number Diff line change
Expand Up @@ -222,21 +222,21 @@

context 'default value of dnssec_validation on RedHat 5' do
let :facts do
{ :osfamily => 'RedHat', :operatingsystemmajrelease => '5' }
{ :osfamily => 'RedHat', :operatingsystemmajrelease => '5', :concat_basedir => '/tmp' }
end
it { should contain_file('/etc/bind/named.conf.options').without_content(/dnssec-validation/) }
end

context 'default value of dnssec_validation on RedHat 6' do
let :facts do
{ :osfamily => 'RedHat', :operatingsystemmajrelease => '6' }
{ :osfamily => 'RedHat', :operatingsystemmajrelease => '6', :concat_basedir => '/tmp' }
end
it { should contain_file('/etc/bind/named.conf.options').with_content(/dnssec-validation auto/) }
end

context 'default value of dnssec_validation on Debian' do
let :facts do
{ :osfamily => 'Debian' }
{ :osfamily => 'Debian', :concat_basedir => '/tmp' }
end
it { should contain_file('/etc/bind/named.conf.options').with_content(/dnssec-validation auto/) }
end
Expand Down
13 changes: 13 additions & 0 deletions templates/startup.debian.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,13 @@
# run resolvconf?
<% if @resolvconf -%>
RESOLVCONF=<%= @resolvconf %>
<% else %>
RESOLVCONF= no
<% end -%>

# startup options for the server
<% if @options -%>
OPTIONS="<%= @options %>"
<% else %>
OPTIONS="-u bind"
<% end -%>
62 changes: 62 additions & 0 deletions templates/startup.redhat.erb
Original file line number Diff line number Diff line change
@@ -0,0 +1,62 @@
# BIND named process options
# ~~~~~~~~~~~~~~~~~~~~~~~~~~
# Currently, you can use the following options:
#
# ROOTDIR="/some/where" -- will run named in a chroot environment.
# you must set up the chroot environment
# (install the bind-chroot package) before
# doing this.
#
# OPTIONS="whatever" -- These additional options will be passed to named
# at startup. Don't add -t here, use ROOTDIR instead.
#
# ENABLE_ZONE_WRITE=yes -- If SELinux is disabled, then allow named to write
# its zone files and create files in its $ROOTDIR/var/named
# directory, necessary for DDNS and slave zone transfers.
# Slave zones should reside in the $ROOTDIR/var/named/slaves
# directory, in which case you would not need to enable zone
# writes. If SELinux is enabled, you must use only the
# 'named_write_master_zones' variable to enable zone writes.
#
# ENABLE_SDB=yes -- This enables use of 'named_sdb', which has support
# -- for the ldap, pgsql and dir zone database backends
# -- compiled in, to be used instead of named.
#
# DISABLE_NAMED_DBUS=[1y]-- If NetworkManager is enabled in any runlevel, then
# the initscript will by default enable named's D-BUS
# support with the named -D option. This setting disables
# this behavior.
#
# KEYTAB_FILE="/dir/file" -- Specify named service keytab file (for GSS-TSIG)
#
# DISABLE_ZONE_CHECKING -- By default, initscript calls named-checkzone
# utility for every zone to ensure all zones are
# valid before named starts. If you set this option
# to 'yes' then initscript doesn't perform those checks.
<% if @rootdir -%>
ROOTDIR="<%= @rootdir %>"
<% end -%>

<% if @options -%>
OPTIONS="<%= @options %>"
<% end -%>

<% if @enable_zone_write -%>
ENABLE_ZONE_WRITE=<%= @enable_zone_write %>
<% end -%>

<% if @enable_sdb -%>
ENABLE_SDB=<%= @enable_sdb %>
<% end -%>

<% if @disable_named_dbus -%>
DISABLE_NAMED_DBUS=<%= @disable_named_dbus %>
<% end -%>

<% if @keytab_file -%>
KEYTAB_FILE="<%= @keytab_file %>"
<% end -%>

<% if @disable_zone_checking -%>
DISABLE_ZONE_CHECKING=<%= @disable_zone_checking %>
<% end -%>