Puppet Class: hosts

Inherits:
hosts::params
Inherited by:
hosts::spec
Defined in:
manifests/init.pp

Overview

Class: hosts

This is the main hosts class

Parameters

dynamic_mode

Define if you want to enable dynamic mode (requires storedconfigs) where all the nodes of the Puppet infrastructure are automatically added in /etc/hosts. Note that if you set this to true you can’t use the source or template parameters. Default: false

dynamic_magicvar

Name of a variable you can use to collect dynamically only the nodes that share the same value for tha variable. For example: if dynamic_magicvar=environment you will see in /etc/hosts only the nodes of the same environment. Default: ”

dynamic_template

Path to a template that you can use as common header for the /etc/hosts By default new hosts are added to the existing /etc/hosts, here you can set a common and custom template. Default: ”

dynamic_ip

Ip address to use in /etc/hosts entries. It can (should) be a variable Default: $::ip_address Example: dynamic_ip => $::ec2_public_ipv4

dynamic_alias

Aliases to add to the /etc/hosts line. Default: [ $::hostname ] Should be an array

dynamic_exclude

Define if you want to exclude the current host from being automatically collected by the other nodes (May be used, for example for puppetmaster or cluster nodes, in certain situations)

my_class

Name of a custom class to autoload to manage module’s customizations If defined, hosts class will automatically “include $my_class” Can be defined also by the (top scope) variable $hosts_myclass

source

Sets the content of source parameter for main configuration file If defined, hosts main config file will have the param: source => $source Can be defined also by the (top scope) variable $hosts_source

template

Sets the path to the template to use as content for main configuration file If defined, hosts main config file has: content => content(“$template”) Note source and template parameters are mutually exclusive: don’t use both Can be defined also by the (top scope) variable $hosts_template

audit_only

Set to ‘true’ if you don’t intend to override existing configuration files and want to audit the difference between existing files and the ones managed by Puppet. Can be defined also by the (top scope) variables $hosts_audit_only and $audit_only

noops

Set noop metaparameter to true for all the resources managed by the module. Basically you can run a dryrun for this specific module if you set this to true. Default: undef

Default class params - As defined in hosts::params. Note that these variables are mostly defined and used in the module itself, overriding the default values might not affected all the involved components. Set and override them only if you know what you’re doing. Note also that you can’t override/set them via top scope variables.

config_file

Main configuration file path

Examples

You can use this class in 2 ways:

  • Set variables (at top scope level on in a ENC) and “include hosts”

  • Call hosts as a parametrized class

See README for details.

Parameters:

  • dynamic_mode (Any) (defaults to: params_lookup( 'dynamic_mode' ))
  • dynamic_magicvar (Any) (defaults to: params_lookup( 'dynamic_magicvar' ))
  • dynamic_template (Any) (defaults to: params_lookup( 'dynamic_template' ))
  • dynamic_ip (Any) (defaults to: params_lookup( 'dynamic_ip' ))
  • dynamic_alias (Any) (defaults to: params_lookup( 'dynamic_alias' ))
  • dynamic_exclude (Any) (defaults to: params_lookup( 'dynamic_exclude' ))
  • my_class (Any) (defaults to: params_lookup( 'my_class' ))
  • source (Any) (defaults to: params_lookup( 'source' ))
  • template (Any) (defaults to: params_lookup( 'template' ))
  • content (Any) (defaults to: params_lookup( 'content' ))
  • audit_only (Any) (defaults to: params_lookup( 'audit_only' , 'global' ))
  • noops (Any) (defaults to: params_lookup( 'noops' ))
  • config_file (Any) (defaults to: params_lookup( 'config_file' )) 


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

class hosts (
  $dynamic_mode        = params_lookup( 'dynamic_mode' ),
  $dynamic_magicvar    = params_lookup( 'dynamic_magicvar' ),
  $dynamic_template    = params_lookup( 'dynamic_template' ),
  $dynamic_ip          = params_lookup( 'dynamic_ip' ),
  $dynamic_alias       = params_lookup( 'dynamic_alias' ),
  $dynamic_exclude     = params_lookup( 'dynamic_exclude' ),
  $my_class            = params_lookup( 'my_class' ),
  $source              = params_lookup( 'source' ),
  $template            = params_lookup( 'template' ),
  $content             = params_lookup( 'content' ),
  $audit_only          = params_lookup( 'audit_only' , 'global' ),
  $noops               = params_lookup( 'noops' ),
  $config_file         = params_lookup( 'config_file' )
  ) inherits hosts::params {

  $config_file_mode=$hosts::params::config_file_mode
  $config_file_owner=$hosts::params::config_file_owner
  $config_file_group=$hosts::params::config_file_group

  $bool_dynamic_mode=any2bool($dynamic_mode)
  $bool_dynamic_exclude=any2bool($dynamic_exclude)
  $bool_audit_only=any2bool($audit_only)

  ### Definition of some variables used in the module
  $manage_audit = $hosts::bool_audit_only ? {
    true  => 'all',
    false => undef,
  }

  $manage_file_replace = $hosts::bool_audit_only ? {
    true  => false,
    false => true,
  }

  $manage_file_source = $hosts::source ? {
    ''        => undef,
    default   => $hosts::source,
  }

  $manage_file_content = $hosts::content ? {
    ''        => $hosts::template ? {
      ''        => $hosts::dynamic_template ? {
        ''      => undef,
        default => $hosts::dynamic_template,
      },
      default   => template($hosts::template),
    },
    default   => $hosts::content,
  }

  ### Managed resources
  file { 'hosts.conf':
    ensure  => present,
    path    => $hosts::config_file,
    mode    => $hosts::config_file_mode,
    owner   => $hosts::config_file_owner,
    group   => $hosts::config_file_group,
    source  => $hosts::manage_file_source,
    content => $hosts::manage_file_content,
    replace => $hosts::manage_file_replace,
    audit   => $hosts::manage_audit,
    noop    => $hosts::noops,
  }

  ### Include custom class if $my_class is set
  if $hosts::my_class {
    include $hosts::my_class
  }

  ### Manage hosts dynamically
  if $bool_dynamic_mode == true {
    include hosts::dynamic
  }

}