Puppet Class: ntp

Inherits:
ntp::params
Defined in:
manifests/init.pp

Overview

Class: ntp

This module manages ntp

Parameters:

[*server_list*]
  List of NTP servers to use.
  Default: [
    '0.pool.ntp.org',
    '1.pool.ntp.org',
    '2.pool.ntp.org',
    '3.pool.ntp.org',
    ],

[*server_options*]
  Pass options to all servers listed in server_list
  Default: ''

[*pool_list*]
  List of NTP pools to use.
  Default: []

[*pool_options*]
  Pass options to all pools listed in pool_list
  Default: ''

[*server_enabled*]
  Enable ntp server mode.
  Default: false

[*query_networks*]
  List of networks which have unlimited access.
  Default: []

[*interface_ignore*]
  Ignore these interfaces.
  Default: []

[*interface_listen*]
  Listen on these interfaces.
  Default: []

[*enable_statistics*]
  Enable statistics.
  Default: []

[*statsdir*]
  Directory to write statistics.
  Default: undef

[*ensure*]
  Ensure if present or absent.
  Default: present

[*autoupgrade*]
  Upgrade package automatically, if there is a newer version.
  Default: false

[*package*]
  Name of the package.
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*config_file*]
  Main configuration file.
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*config_file_replace*]
  Replace configuration file with that one delivered with this module
  Default: true

[*driftfile*]
  Driftfile to use
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*service_ensure*]
  Ensure if service is running or stopped
  Default: running

[*service_name*]
  Name of NTP service
  Only set this, if your platform is not supported or you know,
  what you're doing.
  Default: auto-set, platform specific

[*service_enable*]
  Start service at boot
  Default: true

[*service_hasstatus*]
  Service has status command
  Default: true

[*service_hasrestart*]
  Service has restart command
  Default: true

[*defaults_file*]
  Init script configuration file.
  Default: auto-set, platform specific

[*ntpd_start_options*]
  Options to pass to the ntpd command.
  Default: auto-set, platform specific

Actions:

Installs ntp package and configures it

Requires:

Nothing

Sample Usage:

class { 'ntp':
  server_enabled = true,
}
Remember: No empty lines between comments and class definition

Parameters:

  • server_list (Any) (defaults to: [ '0.pool.ntp.org', '1.pool.ntp.org', '2.pool.ntp.org', '3.pool.ntp.org', ])
  • server_options (Any) (defaults to: '')
  • pool_list (Any) (defaults to: [])
  • pool_options (Any) (defaults to: '')
  • server_enabled (Any) (defaults to: false)
  • query_networks (Any) (defaults to: [])
  • interface_ignore (Any) (defaults to: [])
  • interface_listen (Any) (defaults to: [])
  • enable_statistics (Any) (defaults to: false)
  • statsdir (Any) (defaults to: '')
  • ensure (Any) (defaults to: 'present')
  • autoupgrade (Any) (defaults to: false)
  • package (Any) (defaults to: $ntp::params::package)
  • config_file (Any) (defaults to: $ntp::params::config_file)
  • config_file_replace (Any) (defaults to: true)
  • driftfile (Any) (defaults to: $ntp::params::driftfile)
  • service_ensure (Any) (defaults to: 'running')
  • service_name (Any) (defaults to: $ntp::params::service_name)
  • service_enable (Any) (defaults to: true)
  • service_hasstatus (Any) (defaults to: true)
  • service_hasrestart (Any) (defaults to: true)
  • defaults_file (Any) (defaults to: $ntp::params::defaults_file)
  • ntpd_start_options (Any) (defaults to: $ntp::params::ntpd_start_options) 


123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
 
# File 'manifests/init.pp', line 123

class ntp(
  $server_list = [
    '0.pool.ntp.org',
    '1.pool.ntp.org',
    '2.pool.ntp.org',
    '3.pool.ntp.org',
  ],
  $server_options = '',
  $pool_list = [],
  $pool_options = '',
  $server_enabled = false,
  $query_networks = [],
  $interface_ignore = [],
  $interface_listen = [],
  $enable_statistics = false,
  $statsdir = '',
  $ensure = 'present',
  $autoupgrade = false,
  $package = $ntp::params::package,
  $config_file = $ntp::params::config_file,
  $config_file_replace = true,
  $driftfile = $ntp::params::driftfile,
  $service_ensure = 'running',
  $service_name = $ntp::params::service_name,
  $service_enable = true,
  $service_hasstatus = true,
  $service_hasrestart = true,
  $defaults_file = $ntp::params::defaults_file,
  $ntpd_start_options = $ntp::params::ntpd_start_options
) inherits ntp::params {

  case $ensure {
    /(present)/: {
      if $autoupgrade == true {
        $package_ensure = 'latest'
      } else {
        $package_ensure = 'present'
      }

      if $service_ensure == 'running' {
        $service_ensure_real = $service_ensure
      } elsif $service_ensure == 'stopped' {
        $service_ensure_real = $service_ensure
      } else {
        fail('service_ensure parameter must be running or stopped')
      }

      if $server_enabled == false {
        $interface_ignore_real = [ 'all', ]
        $interface_listen_real = [ 'lo', ]
      } elsif $server_enabled == true {
        $interface_ignore_real = $interface_ignore
        $interface_listen_real = $interface_listen
      } else {
        fail('server_enabled parameter must be true or false')
      }

      if $enable_statistics == true {
        if ! $statsdir {
          fail('statsdir parameter must be set, if enable_statistics is true')
        }
      }
    }
    /(absent)/: {
      $package_ensure = 'absent'
      $service_ensure_real = 'stopped'
    }
    default: {
      fail('ensure parameter must be present or absent')
    }
  }

  package { $package:
    ensure => $package_ensure,
  }

  file { $config_file:
    ensure  => $ensure,
    owner   => 0,
    group   => 0,
    mode    => '0644',
    content => template('ntp/ntp.conf.erb'),
    require => Package[$package],
  }

  if $defaults_file {
    file { $defaults_file:
      ensure  => $ensure,
      owner   => 0,
      group   => 0,
      mode    => '0644',
      content => template("${module_name}/${ntp::params::defaults_file_tpl}"),
      require => Package[$package],
    }
  }

  if $ensure != 'absent' {
    $service_subscribe = $defaults_file ? {
      true    => [ File[$config_file], File[$defaults_file], ],
      default => File[$config_file],
    }

    service { $service_name:
      ensure     => $service_ensure_real,
      enable     => $service_enable,
      hasstatus  => $service_hasstatus,
      hasrestart => $service_hasrestart,
      require    => File[$config_file],
      subscribe  => $service_subscribe,
    }
  }
}