Puppet Class: puppet::agent

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

Overview

Class: puppet::agent

Install, configure, and run a puppet agent instance.

Parameters

ensure

The package ensure value. Default: present

server

The puppet server to use for fetching catalogs. Default: puppet

ca_server

The puppet server to use for certificate requests and similar actions. Default: puppet::agent::server

report

The report variable in puppet.conf, whether to send reports or not Default: true

report_server

The puppet server to send reports. Default: puppet::agent::server

manage_repos

Whether to manage Puppet Labs APT or YUM package repos. Default: false

environment

What environment the agent should be part of. Default: $::environment

pluginsync

The pluginsync variable in puppet.conf Default: true

certname

The certname variable in puppet.conf Default: $::clientcert

show_diff

The show_diff variable in puppet.conf Default: false

splay

The splay variable in puppet.conf Default: false

configtimeout

The configtimeout variable in puppet.conf Default: 360

usecacheonfailure

The usecacheonfailure variable in puppet.conf Default: true

runinterval

The runinterval variable in puppet.conf Default: 1800

method

The mechanism for performing puppet runs. Supported methods: [cron, service, only_service, none] Default: platform dependent

manage_package

Whether to manage the puppet agent package or not Default: true

package

The puppet agent package name Default: platform dependent

Example:

 class { 'puppet::agent':
   server        => 'puppet.example.com',
   report_server => 'puppet_reports.example.com',
   method        => 'service',
}

Parameters:

  • ensure (Any) (defaults to: 'present')
  • server (Any) (defaults to: 'puppet')
  • ca_server (Any) (defaults to: undef)
  • report (Any) (defaults to: true)
  • report_server (Any) (defaults to: undef)
  • manage_repos (Any) (defaults to: false)
  • environment (Any) (defaults to: $::environment)
  • pluginsync (Any) (defaults to: true)
  • certname (Any) (defaults to: $::clientcert)
  • show_diff (Any) (defaults to: false)
  • splay (Any) (defaults to: false)
  • configtimeout (Any) (defaults to: 360)
  • usecacheonfailure (Any) (defaults to: true)
  • runinterval (Any) (defaults to: undef)
  • method (Any) (defaults to: $puppet::params::default_method)
  • manage_package (Any) (defaults to: true)
  • package (Any) (defaults to: $puppet::params::agent_package) 


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
 
# File 'manifests/agent.pp', line 84

class puppet::agent (
  $ensure            = 'present',
  $server            = 'puppet',
  $ca_server         = undef,
  $report            = true,
  $report_server     = undef,
  $manage_repos      = false,
  $environment       = $::environment,
  $pluginsync        = true,
  $certname          = $::clientcert,
  $show_diff         = false,
  $splay             = false,
  $configtimeout     = 360,
  $usecacheonfailure = true,
  $runinterval       = undef,
  $method            = $puppet::params::default_method,
  $manage_package    = true,
  $package           = $puppet::params::agent_package,
) inherits puppet::params {

  validate_bool($report)
  validate_bool($manage_repos)
  validate_bool($pluginsync)
  validate_bool($show_diff)
  validate_bool($splay)
  validate_bool($usecacheonfailure)
  validate_bool($manage_package)

  include puppet

  if $manage_package {
    include puppet::package
  }

  if $ensure != 'absent' {
    include puppet::agent::config
  }

  case $method {
    cron: {
      include puppet::agent::cron
      class { 'puppet::agent::service': enable => false }
    }
    service: {
      include puppet::agent::service
      class { 'puppet::agent::cron': enable => false }
    }
    only_service: {
      include puppet::agent::service
    }
    none: {
      class { 'puppet::agent::service': enable => false }
      class { 'puppet::agent::cron': enable => false }
    }
    default: {
      notify { "Agent run method \"${method}\" is not supported by ${module_name}, defaulting to cron": loglevel => warning }
      include puppet::agent::cron
      class { 'puppet::agent::service': enable => false }
    }
  }
}