Puppet Class: consul

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

Summary

Installs, configures and manages consul

Overview

Examples:

simple consul setup

class { 'consul':
  config_hash => {
    'datacenter'   => 'east-aws',
    'node_name'    => $facts['fqdn'],
    'pretty_config => true,
    'retry-join'   => ['172.16.0.1'],
  },
}

Parameters:

  • acls (Hash) (defaults to: {})

    Hash of consul_acl resources to create.

  • tokens (Hash[String[1], Consul::TokenStruct]) (defaults to: {})

    Hash of consul_token resources to create.

  • policies (Hash[String[1], Consul::PolicyStruct]) (defaults to: {})

    Hash of consul_policy resources to create.

  • acl_api_hostname (String[1]) (defaults to: 'localhost')

    Global hostname of ACL API, will be merged with consul_token resources

  • acl_api_protocol (String[1]) (defaults to: 'http')

    Global protocl of ACL API, will be merged with consul_token resources

  • acl_api_port (Integer[1, 65535]) (defaults to: 8500)

    Global port of ACL API, will be merged with consul_token resources

  • acl_api_tries (Integer[1]) (defaults to: 3)

    Global max. tries of ACL API, will be merged with consul_token resources

  • acl_api_token (String[0]) (defaults to: '')

    Global token of ACL API, will be merged with consul_token resources

  • arch (String[1]) (defaults to: $consul::params::arch)

    Architecture of consul binary to download

  • archive_path (Optional[Stdlib::Absolutepath]) (defaults to: undef)

    Path used when installing consul via the url

  • bin_dir (Stdlib::Absolutepath) (defaults to: $consul::params::bin_dir)

    Directory to create the symlink to the consul binary in.

  • binary_group (Optional[String[1]]) (defaults to: $consul::params::binary_group)

    The group that the file belongs to.

  • binary_mode (String[1]) (defaults to: $consul::params::binary_mode)

    Permissions mode for the file.

  • binary_name (String[1]) (defaults to: $consul::params::binary_name)

    The binary name file.

  • binary_owner (String[1]) (defaults to: $consul::params::binary_owner)

    The user that owns the file.

  • checks (Hash) (defaults to: {})

    Hash of consul::check resources to create.

  • config_defaults (Hash) (defaults to: $consul::params::config_defaults)

    Configuration defaults hash. Gets merged with config_hash.

  • config_dir (Stdlib::Absolutepath) (defaults to: $consul::params::config_dir)

    Directory to place consul configuration files in.

  • config_name (String[1]) (defaults to: 'config.json')

    Name of the consul configuration file.

  • config_hash (Variant[Hash,Sensitive[Hash]]) (defaults to: {})

    Use this to populate the JSON config file for consul.

  • config_mode (String[1]) (defaults to: '0664')

    Use this to set the JSON config file mode for consul.

  • config_owner (Optional[String[1]]) (defaults to: undef)

    The user that owns the config_dir directory and its files.

  • data_dir_mode (String[1]) (defaults to: $consul::params::data_dir_mode)

    Use this to set the data_dir directory mode for consul.

  • docker_image (String[1]) (defaults to: 'consul')

    Only valid when the install_method == docker. Defaults to ‘consul`.

  • download_extension (String[1]) (defaults to: 'zip')

    The extension of the archive file containing the consul binary to download.

  • download_url (Optional[Stdlib::Filesource]) (defaults to: undef)

    Fully qualified url, puppet uri or absolute path to the location of the archive file containing the consul binary.

  • download_url_base (String[1]) (defaults to: 'https://releases.hashicorp.com/consul/')

    Base url to the location of the archive file containing the consul binary.

  • extra_groups (Array) (defaults to: [])

    Extra groups to add the consul system user to.

  • extra_options (Optional[String[1]]) (defaults to: undef)

    Extra arguments to be passed to the consul agent

  • group (String[1]) (defaults to: $consul::params::group)

    Name of the group that should own the consul configuration files.

  • init_style (String[1]) (defaults to: $consul::params::init_style)

    What style of init system your system uses. Set to ‘unmanaged’ to disable managing init system files for the consul service entirely. This is ignored when install_method == ‘docker’

  • install_method (String[1]) (defaults to: 'url')

    Valid strings: ‘docker` - install via docker container

    `package` - install via system package
    `url`     - download and extract from a url. Defaults to `url`.
    `none`    - disable install.
    
  • join_wan (Optional[String[1]]) (defaults to: undef)

    The wan to join on service start (e.g. ‘wan.foo.com’). Defaults to undef (i.e. won’t join a wan).

  • manage_group (Boolean) (defaults to: $consul::params::manage_group)

    Whether to create/manage the group that should own the consul configuration files.

  • manage_repo (Boolean) (defaults to: false)

    Configure the upstream HashiCorp repository. Only relevant when $consul::install_method = ‘package’.

  • manage_service (Boolean) (defaults to: true)

    Whether to manage the consul service.

  • manage_user (Boolean) (defaults to: $consul::params::manage_user)

    Whether to create/manage the user that should own consul’s configuration files.

  • manage_user_home_location (Boolean) (defaults to: false)

    Whether to explicitly set the location of the consul user’s home directory when this modules manages the creation of the user (aka ‘manage_user = true`). If the consul user already exists and this is enabled, puppet tries to change the consul user’s home to the new location. This will cause the puppet run to fail if the consul service is currently running.

  • manage_data_dir (Boolean) (defaults to: true)

    Whether to manage the consul storage data directory.

  • os (String[1]) (defaults to: $facts['kernel'].downcase)

    OS component in the name of the archive file containing the consul binary.

  • package_ensure (String[1]) (defaults to: 'latest')

    Only valid when the install_method == package. Defaults to ‘latest`.

  • package_name (String[1]) (defaults to: 'consul')

    Only valid when the install_method == package. Defaults to ‘consul`.

  • pretty_config (Boolean) (defaults to: false)

    Generates a human readable JSON config file. Defaults to ‘false`.

  • pretty_config_indent (Integer) (defaults to: 4)

    Toggle indentation for human readable JSON file. Defaults to ‘4`.

  • proxy_server (Optional[Stdlib::HTTPUrl]) (defaults to: undef)

    Specify a proxy server, with port number if needed. ie: example.com:8080.

  • purge_config_dir (Boolean) (defaults to: true)

    Purge config files no longer generated by Puppet

  • restart_on_change (Boolean) (defaults to: true)

    Determines whether to restart consul agent on $config_hash changes. This will not affect reloads when service, check or watch configs change.

  • service_enable (Boolean) (defaults to: true)

    Whether to enable the consul service to start at boot.

  • service_ensure (Enum['stopped', 'running']) (defaults to: 'running')

    Whether the consul service should be running or not.

  • services (Hash) (defaults to: {})

    Hash of consul::service resources to create.

  • user (String[1]) (defaults to: $consul::params::user)

    Name of the user that should own the consul configuration files.

  • version (String[1]) (defaults to: '1.20.0')

    Specify version of consul binary to download.

  • watches (Hash) (defaults to: {})

    Hash of consul::watch resources to create.

  • shell (Optional[String[1]]) (defaults to: $consul::params::shell)

    The shell for the consul user. Defaults to something that prohibits login, like /usr/sbin/nologin

  • enable_beta_ui (Boolean) (defaults to: false)

    consul 1.1.0 introduced a new UI, which is currently (2018-05-12) in beta status. You can enable it by setting this variable to true. Defaults to false

  • allow_binding_to_root_ports (Boolean) (defaults to: false)

    enables CAP_NET_BIND_SERVICE if true. This is currently only implemented on systemd nodes

  • log_file (Stdlib::Absolutepath) (defaults to: '/var/log/consul')

    where should the log file be located

  • comment (Optional[String[1]]) (defaults to: undef)

    the comment for the consul user, will be added to /etc/passwd

  • uid (Optional[Integer[1]]) (defaults to: undef)

    the ID for the consul user

  • gid (Optional[Integer[1]]) (defaults to: undef)

    the ID for the consul group



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

class consul (
  Hash                                  $acls                        = {},
  Hash[String[1], Consul::TokenStruct]  $tokens                      = {},
  Hash[String[1], Consul::PolicyStruct] $policies                    = {},
  String[1]                             $acl_api_hostname            = 'localhost',
  String[1]                             $acl_api_protocol            = 'http',
  Integer[1, 65535]                     $acl_api_port                = 8500,
  Integer[1]                            $acl_api_tries               = 3,
  String[0]                             $acl_api_token               = '', # lint:ignore:params_empty_string_assignment
  String[1]                             $arch                        = $consul::params::arch,
  Optional[Stdlib::Absolutepath]        $archive_path                = undef,
  Stdlib::Absolutepath                  $bin_dir                     = $consul::params::bin_dir,
  Optional[String[1]]                   $binary_group                = $consul::params::binary_group,
  String[1]                             $binary_mode                 = $consul::params::binary_mode,
  String[1]                             $binary_name                 = $consul::params::binary_name,
  String[1]                             $binary_owner                = $consul::params::binary_owner,
  Hash                                  $checks                      = {},
  Hash                                  $config_defaults             = $consul::params::config_defaults,
  Stdlib::Absolutepath                  $config_dir                  = $consul::params::config_dir,
  String[1]                             $config_name                 = 'config.json',
  Variant[Hash,Sensitive[Hash]]         $config_hash                 = {},
  String[1]                             $config_mode                 = '0664',
  Optional[String[1]]                   $config_owner                = undef,
  String[1]                             $data_dir_mode               = $consul::params::data_dir_mode,
  String[1]                             $docker_image                = 'consul',
  String[1]                             $download_extension          = 'zip',
  Optional[Stdlib::Filesource]          $download_url                = undef,
  String[1]                             $download_url_base           = 'https://releases.hashicorp.com/consul/',
  Array                                 $extra_groups                = [],
  Optional[String[1]]                   $extra_options               = undef,
  String[1]                             $group                       = $consul::params::group,
  Stdlib::Absolutepath                  $log_file                    = '/var/log/consul',
  String[1]                             $init_style                  = $consul::params::init_style,
  String[1]                             $install_method              = 'url',
  Optional[String[1]]                   $join_wan                    = undef,
  Boolean                               $manage_group                = $consul::params::manage_group,
  Boolean                               $manage_repo                 = false,
  Boolean                               $manage_service              = true,
  Boolean                               $manage_user                 = $consul::params::manage_user,
  Boolean                               $manage_user_home_location   = false,
  Boolean                               $manage_data_dir             = true,
  String[1]                             $os                          = $facts['kernel'].downcase,
  String[1]                             $package_ensure              = 'latest',
  String[1]                             $package_name                = 'consul',
  Boolean                               $pretty_config               = false,
  Integer                               $pretty_config_indent        = 4,
  Optional[Stdlib::HTTPUrl]             $proxy_server                = undef,
  Boolean                               $purge_config_dir            = true,
  Boolean                               $restart_on_change           = true,
  Boolean                               $service_enable              = true,
  Enum['stopped', 'running']            $service_ensure              = 'running',
  Hash                                  $services                    = {},
  String[1]                             $user                        = $consul::params::user,
  String[1]                             $version                     = '1.20.0',
  Hash                                  $watches                     = {},
  Optional[String[1]]                   $shell                       = $consul::params::shell,
  Boolean                               $enable_beta_ui              = false,
  Boolean                               $allow_binding_to_root_ports = false,
  Optional[String[1]]                   $comment                     = undef,
  Optional[Integer[1]]                  $uid                         = undef,
  Optional[Integer[1]]                  $gid                         = undef,
) inherits consul::params {
  $real_download_url = pick(
    $download_url,
    "${download_url_base}${version}/${package_name}_${version}_${os}_${arch}.${download_extension}",
  )

  $_config_hash = $config_hash ? {
    Sensitive => $config_hash.unwrap,
    default   => $config_hash
  }
  $config_hash_real = deep_merge($config_defaults, $config_hash)

  if $install_method == 'docker' {
    $user_real         = undef
    $group_real        = undef
    $config_owner_real = undef
    $init_style_real   = 'unmanaged'
  } else {
    $user_real         = $user
    $group_real        = $group
    if $config_owner {
      $config_owner_real = $config_owner
    } else {
      $config_owner_real = $user
    }
    $init_style_real   = $init_style
  }

  if $config_hash_real['data_dir'] {
    $data_dir = $config_hash_real['data_dir']
  } else {
    $data_dir = undef
  }

  if dig($config_hash_real,'ports','http') {
    $http_port = $config_hash_real['ports']['http']
  } else {
    $http_port = 8500
  }

  if dig($config_hash_real,'ports','https') {
    $https_port = $config_hash_real['ports']['https']
  } else {
    $https_port = Undef
  }

  if dig($config_hash_real,'addresses','http') {
    $http_addr = split($config_hash_real['addresses']['http'], ' ')[0]
  } elsif ($config_hash_real['client_addr']) {
    $http_addr = split($config_hash_real['client_addr'], ' ')[0]
  } else {
    $http_addr = '127.0.0.1'
  }

  if dig($config_hash_real,'verify_incoming') {
    $verify_incoming = $config_hash_real['verify_incoming']
  } else {
    $verify_incoming = false
  }

  if dig($config_hash_real,'cert_file') {
    $cert_file = $config_hash_real['cert_file']
  } else {
    $cert_file = Undef
  }

  if dig($config_hash_real,'key_file') {
    $key_file = $config_hash_real['key_file']
  } else {
    $key_file = Undef
  }

  if $services {
    create_resources(consul::service, $services)
  }

  if $watches {
    create_resources(consul::watch, $watches)
  }

  if $checks {
    create_resources(consul::check, $checks)
  }

  if $acls {
    create_resources(consul_acl, $acls)
  }

  contain 'consul::install'
  contain 'consul::config'
  contain 'consul::run_service'
  contain 'consul::reload_service'

  Class['consul::install']
  -> Class['consul::config']
  -> Class['consul::run_service']
  -> Class['consul::reload_service']

  if $restart_on_change {
    Class['consul::config']
    ~> Class['consul::run_service']
  }

  $global_acl_config = {
    'hostname'      => $acl_api_hostname,
    'protocol'      => $acl_api_protocol,
    'port'          => $acl_api_port,
    'api_tries'     => $acl_api_tries,
    'acl_api_token' => $acl_api_token,
  }

  $policies.each | $name, $policy_config | {
    $merges_policy_config = $global_acl_config + $policy_config
    create_resources(consul_policy, { $name => $merges_policy_config })
  }

  $tokens.each | $name, $token_config | {
    $merged_token_config = $global_acl_config + $token_config
    create_resources(consul_token, { $name => $merged_token_config })
  }
}