Language visual index

Resource declaration

file {'ntp.conf':
  path    => '/etc/ntp.conf',
  ensure  => file,
  content => template('ntp/ntp.conf'),
  owner   => 'root',
  mode    => '0644',
}

Resource relationship metaparameters

Two resource declarations establishing relationships with the before and subscribe metaparameters, which accept resource references.

package {'ntp':
  ensure => installed,
  before => File['ntp.conf'],
}
service {'ntpd':
  ensure    => running,
  subscribe => File['ntp.conf'],
}

For details about relationships usage and syntax, see Relationships and ordering. For details about resource references, see Resource and class references.

Resource relationship chaining arrows

Chaining arrows forming relationships between three resources, using resource references.In this example, the ntp package must be installed before the ntp.conf file is created; after the file is created, the ntpd service is notified.

Package['ntp'] -> File['ntp.conf'] ~> Service['ntpd']

For details about relationships usage and syntax, see Relationships and ordering. For details about resource references, see Resource and class references.

Variable assigned an array value

A variable being assigned a set of values as an array.

$package_list = ['ntp', 'apache2', 'vim-nox', 'wget']

For details about assigning values to variables, see Variables.

Variable assigned a hash value

A variable being assigned a set of values as a hash.

$myhash = { key => { subkey => 'b' }      

For details about assigning values to variables, see Variables.

Interpolated variable

A built-in variable provided by the master being interpolated into a double-quoted string.

...
content => "Managed by puppet master version ${serverversion}"

For details about built-in variables usage and syntax, see Facts and built-in variables. For information about strings and interpolation, see Strings.

Class definition

A class definition, which makes a class available for later use.

class ntp {
  package {'ntp':
    ...
  }
  ...
}

For details about class usage and syntax, see Classes.

Class declarations

include ntp

require ntp

class {'ntp':}

For details about class usage and syntax, see Classes.

Defined resource type definition

Defining a type creates a new defined resource type. The name of this defined type has two namespace segments, comprising the name of the module containing the defined type, apache, and the name of the defined type itself, vhost.

define apache::vhost ($port, $docroot, $servername = $title, $vhost_name = '*') {
  include apache
  include apache::params
  $vhost_dir = $apache::params::vhost_dir
  file { "${vhost_dir}/${servername}.conf":
    content => template('apache/vhost-default.conf.erb'),
    owner   => 'www',
    group   => 'www',
    mode    => '644',
    require => Package['httpd'],
    notify  => Service['httpd'],
  }

For details about defined type usage and syntax, see Defined resource types.

Defined type resource declaration

Declarations of an instance, or resource, of a defined type are similar to other resource declarations. This example declares a instance of the apache::vhost defined type, with a title of "homepages" and the port and docroot attributes specified.

apache::vhost {'homepages':
  port       => 8081,
  docroot => '/var/www-testhost',
} 

For details about defined type usage and syntax, see Defined resource types.

Defined type resource reference

A resource reference to an instance of the apache::vhost defined resource. Every namespace segment in a resource reference must be capitalized.

Apache::Vhost['homepages']

For details about defined type usage and syntax, see Defined resource types. For details about resource references, see Resource and class references.

Node definition

A node definition or node statement is a block of Puppet code that is included only in matching nodes’ catalogs. This allows you to assign specific configurations to specific nodes.

node 'www1.example.com' {
  include common
  include apache
  include squid
}

Node names in node definitions can also be given as regular expressions.

node /^www\d+$/ {
  include common
}

For details about node definition usage and syntax, see Node definitions.

if statement, using expressions and facts

if $is_virtual {
  warning( 'Tried to include class ntp on virtual machine; this node might be misclassified.' )
}
elsif $operatingsystem == 'Darwin' {
  warning( 'This NTP module does not yet work on our Mac laptops.' )
else {
  include ntp
}

For details about if statements, see Conditional statements and expressions.

if statement, with in expression

if 'www' in $hostname {
  ...
}

For details about if statements, see Conditional statements and expressions.

Case statement

case $operatingsystem {
  'Solaris':          { include role::solaris }
  'RedHat', 'CentOS': { include role::redhat  }
  /^(Debian|Ubuntu)$/:{ include role::debian  }
  default:            { include role::generic }
}

For details about case statements, see Conditional statements and expressions.

Selector statement

$rootgroup = $osfamily ? {
    'Solaris'          => 'wheel',
    /(Darwin|FreeBSD)/ => 'wheel',
    default            => 'root',
}

For details about selector statements, see Conditional statements and expressions.

Resource default for the exec type

Exec {
  path        => '/usr/bin:/bin:/usr/sbin:/sbin',
  environment => 'RUBYLIB=/opt/puppetlabs/puppet/lib/ruby/site_ruby/2.1.0/',
  logoutput   => true,
  timeout     => 180,
}

For details about default statement usage and syntax, see Resource defaults.

Resource collector

User <| groups == 'admin' |>

For details about resource collector usage and syntax, see Resource collectors.

Exported resource collector

Concat::Fragment <<| tag == "bacula-storage-dir-${bacula_director}" |>>

For details about resource collector usage and syntax, see Resource collectors. For information about declaring and collecting exported resources, see Exported resources.

Exported resource declaration

@@nagios_service { "check_zfs${hostname}":
  use                 => 'generic-service',
  host_name           => "$fqdn",
  check_command       => 'check_nrpe_1arg!check_zfs',
  service_description => "check_zfs${hostname}",
  target              => '/etc/nagios3/conf.d/nagios_service.cfg',
  notify              => Service[$nagios::params::nagios_service],
}

For information about declaring and collecting exported resources, see Exported resources.

Virtual resource

@user {'deploy':
  uid     => 2004,
  comment => 'Deployment User',
  group   => www-data,
  groups  => ["enterprise"],
  tag     => [deploy, web],
}

For details about virtual resource usage and syntax, see Virtual resources.