Puppet Class: puppet::agent

Inherits:
puppet::params
Defined in:
manifests/agent.pp

Overview

Class: puppet::agent

This class installs and configures the puppet agent

Parameters:

['puppet_server']         - The dns name of the puppet master
['puppet_server_port']    - The Port the puppet master is running on
['puppet_agent_service']  - The service the puppet agent runs under
['puppet_agent_package']  - The name of the package providing the puppet agent
['version']               - The version of the puppet agent to install
['puppet_run_style']      - The run style of the agent either 'service', 'cron', 'external' or 'manual'
['puppet_run_interval']   - The run interval of the puppet agent in minutes, default is 30 minutes
['puppet_run_command']    - The command that will be executed for puppet agent run
['user_id']               - The userid of the puppet user
['group_id']              - The groupid of the puppet group
['splay']                 - If splay should be enable defaults to false
['environment']           - The environment of the puppet agent
['report']                - Whether to return reports
['pluginsync']            - Whethere to have pluginsync
['use_srv_records']       - Whethere to use srv records
['srv_domain']            - Domain to request the srv records
['ordering']              - The way the agent processes resources. New feature in puppet 3.3.0
['trusted_node_data']     - Enable the trusted facts hash
['listen']                - If puppet agent should listen for connections
['reportserver']          - The server to send transaction reports to.
['digest_algorithm']      - The algorithm to use for file digests.
['templatedir']           - Template dir, if unset it will remove the setting.
['configtimeout']         - How long the client should wait for the configuration to be retrieved before considering it a failure
['stringify_facts']       - Wether puppet transforms structured facts in strings or no. Defaults to true in puppet < 4, deprecated in puppet >=4 (and will default to false)

Actions:

  • Install and configures the puppet agent

Requires:

  • Inifile

Sample Usage:

class { 'puppet::agent':
    puppet_server             => master.puppetlabs.vm,
    environment               => production,
    splay                     => true,
}

Parameters:

  • puppet_server (Any) (defaults to: $::puppet::params::puppet_server)
  • puppet_server_port (Any) (defaults to: $::puppet::params::puppet_server_port)
  • puppet_agent_service (Any) (defaults to: $::puppet::params::puppet_agent_service)
  • puppet_agent_package (Any) (defaults to: $::puppet::params::puppet_agent_package)
  • version (Any) (defaults to: 'present')
  • puppet_run_style (Any) (defaults to: 'service')
  • puppet_run_interval (Any) (defaults to: 30)
  • puppet_run_command (Any) (defaults to: '/usr/bin/puppet agent --no-daemonize --onetime --logdest syslog > /dev/null 2>&1')
  • user_id (Any) (defaults to: undef)
  • group_id (Any) (defaults to: undef)
  • splay (Any) (defaults to: false)
  • environment (Any) (defaults to: 'production')
  • report (Any) (defaults to: true)
  • pluginsync (Any) (defaults to: true)
  • use_srv_records (Any) (defaults to: false)
  • srv_domain (Any) (defaults to: undef)
  • ordering (Any) (defaults to: undef)
  • templatedir (Any) (defaults to: undef)
  • trusted_node_data (Any) (defaults to: undef)
  • listen (Any) (defaults to: false)
  • reportserver (Any) (defaults to: '$server')
  • digest_algorithm (Any) (defaults to: $::puppet::params::digest_algorithm)
  • configtimeout (Any) (defaults to: '2m')
  • stringify_facts (Any) (defaults to: undef) 


44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
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
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
 
# File 'manifests/agent.pp', line 44

class puppet::agent(
  $puppet_server          = $::puppet::params::puppet_server,
  $puppet_server_port     = $::puppet::params::puppet_server_port,
  $puppet_agent_service   = $::puppet::params::puppet_agent_service,
  $puppet_agent_package   = $::puppet::params::puppet_agent_package,
  $version                = 'present',
  $puppet_run_style       = 'service',
  $puppet_run_interval    = 30,
  $puppet_run_command     = '/usr/bin/puppet agent --no-daemonize --onetime --logdest syslog > /dev/null 2>&1',
  $user_id                = undef,
  $group_id               = undef,
  $splay                  = false,
  $environment            = 'production',
  $report                 = true,
  $pluginsync             = true,
  $use_srv_records        = false,
  $srv_domain             = undef,
  $ordering               = undef,
  $templatedir            = undef,
  $trusted_node_data      = undef,
  $listen                 = false,
  $reportserver           = '$server',
  $digest_algorithm       = $::puppet::params::digest_algorithm,
  $configtimeout          = '2m',
  $stringify_facts        = undef,
) inherits puppet::params {

  if ! defined(User[$::puppet::params::puppet_user]) {
    user { $::puppet::params::puppet_user:
      ensure => present,
      uid    => $user_id,
      gid    => $::puppet::params::puppet_group,
    }
  }

  if ! defined(Group[$::puppet::params::puppet_group]) {
    group { $::puppet::params::puppet_group:
      ensure => present,
      gid    => $group_id,
    }
  }
  package { $puppet_agent_package:
    ensure   => $version,
  }

  if $puppet_run_style == 'service' {
    $startonboot = 'yes'
  }
  else {
    $startonboot = 'no'
  }

  if ($::osfamily == 'Debian' and $puppet_run_style != 'manual') or ($::osfamily == 'Redhat') {
    file { $puppet::params::puppet_defaults:
      mode    => '0644',
      owner   => 'root',
      group   => 'root',
      require => Package[$puppet_agent_package],
      content => template("puppet/${puppet::params::puppet_defaults}.erb"),
    }
  }

  if ! defined(File[$::puppet::params::confdir]) {
    file { $::puppet::params::confdir:
      ensure  => directory,
      require => Package[$puppet_agent_package],
      owner   => $::puppet::params::puppet_user,
      group   => $::puppet::params::puppet_group,
      mode    => '0655',
    }
  }

  case $puppet_run_style {
    'service': {
      $service_ensure = 'running'
      $service_enable = true
    }
    'cron': {
      # ensure that puppet is not running and will start up on boot
      $service_ensure = 'stopped'
      $service_enable = false

      # Run puppet as a cron - this saves memory and avoids the whole problem
      # where puppet locks up for no reason. Also spreads out the run intervals
      # more uniformly.
      $time1  =  fqdn_rand($puppet_run_interval)
      $time2  =  fqdn_rand($puppet_run_interval) + 30

      cron { 'puppet-client':
        command => $puppet_run_command,
        user    => 'root',
        # run twice an hour, at a random minute in order not to collectively stress the puppetmaster
        hour    => '*',
        minute  => [ $time1, $time2 ],
      }
    }
    # Run Puppet through external tooling, like MCollective
    'external': {
      $service_ensure = 'stopped'
      $service_enable = false
    }
    # Do not manage the Puppet service and don't touch Debian's defaults file.
    manual: {
      $service_ensure = undef
      $service_enable = undef
    }
    default: {
      err('Unsupported puppet run style in Class[\'puppet::agent\']')
    }
  }

  if $puppet_run_style != 'manual' {
    service { $puppet_agent_service:
      ensure     => $service_ensure,
      enable     => $service_enable,
      hasstatus  => true,
      hasrestart => true,
      subscribe  => [File[$::puppet::params::puppet_conf], File[$::puppet::params::confdir]],
      require    => Package[$puppet_agent_package],
    }
  }

  if ! defined(File[$::puppet::params::puppet_conf]) {
      file { $::puppet::params::puppet_conf:
        ensure  => 'file',
        mode    => '0644',
        require => File[$::puppet::params::confdir],
        owner   => $::puppet::params::puppet_user,
        group   => $::puppet::params::puppet_group,
      }
    }
    else {
      if $puppet_run_style == 'service' {
        File<| title == $::puppet::params::puppet_conf |> {
          notify  +> Service[$puppet_agent_service],
        }
      }
    }

  #run interval in seconds
  $runinterval = $puppet_run_interval * 60

  Ini_setting {
      path    => $::puppet::params::puppet_conf,
      require => File[$::puppet::params::puppet_conf],
      section => 'agent',
  }

  if (($use_srv_records == true) and ($srv_domain == undef))
  {
    fail("${module_name} has attribute use_srv_records set but has srv_domain unset")
  }
  elsif (($use_srv_records == true) and ($srv_domain != undef))
  {
    ini_setting {'puppetagentsrv_domain':
      ensure  => present,
      setting => 'srv_domain',
      value   => $srv_domain,
    }
  }
  elsif($use_srv_records == false)
  {
    ini_setting {'puppetagentsrv_domain':
      ensure  => absent,
      setting => 'srv_domain',
    }
  }

  if $ordering != undef
  {
    $orderign_ensure = 'present'
  }else {
    $orderign_ensure = 'absent'
  }
  ini_setting {'puppetagentordering':
    ensure  => $orderign_ensure,
    setting => 'ordering',
    value   => $ordering,
  }
  if $trusted_node_data != undef
  {
    $trusted_node_data_ensure = 'present'
  }else {
    $trusted_node_data_ensure = 'absent'
  }
  ini_setting {'puppetagenttrusted_node_data':
    ensure  => $trusted_node_data_ensure,
    setting => 'trusted_node_data',
    value   => $trusted_node_data,
  }

  ini_setting {'puppetagentenvironment':
    ensure  => present,
    setting => 'environment',
    value   => $environment,
  }

  ini_setting {'puppetagentmaster':
    ensure  => present,
    setting => 'server',
    value   => $puppet_server,
  }

  ini_setting {'puppetagentuse_srv_records':
    ensure  => present,
    setting => 'use_srv_records',
    value   => $use_srv_records,
  }

  ini_setting {'puppetagentruninterval':
    ensure  => present,
    setting => 'runinterval',
    value   => $runinterval,
  }

  ini_setting {'puppetagentsplay':
    ensure  => present,
    setting => 'splay',
    value   => $splay,
  }

  ini_setting {'puppetmasterport':
    ensure  => present,
    setting => 'masterport',
    value   => $puppet_server_port,
  }
  ini_setting {'puppetagentreport':
    ensure  => present,
    setting => 'report',
    value   => $report,
  }
  ini_setting {'puppetagentpluginsync':
    ensure  => present,
    setting => 'pluginsync',
    value   => $pluginsync,
  }
  ini_setting {'puppetagentlisten':
    ensure  => present,
    setting => 'listen',
    value   => $listen,
  }
  ini_setting {'puppetagentreportserver':
    ensure  => present,
    setting => 'reportserver',
    value   => $reportserver,
  }
  ini_setting {'puppetagentdigestalgorithm':
    ensure  => present,
    setting => 'digest_algorithm',
    value   => $digest_algorithm,
  }
  if ($templatedir != undef) and ($templatedir != 'undef')
  {
    ini_setting {'puppetagenttemplatedir':
      ensure  => present,
      setting => 'templatedir',
      section => 'main',
      value   => $templatedir,
    }
  }
  else
  {
    ini_setting {'puppetagenttemplatedir':
      ensure  => absent,
      setting => 'templatedir',
      section => 'main',
    }
  }
  ini_setting {'puppetagentconfigtimeout':
    ensure  => present,
    setting => 'configtimeout',
    value   => $configtimeout,
  }
  if $stringify_facts != undef {
    ini_setting {'puppetagentstringifyfacts':
      ensure  => present,
      setting => 'stringify_facts',
      value   => $stringify_facts,
    }
  }
}