puppet-consul

Compatibility

Consul Version	Recommended Puppet Module Version
>= 0.6.0	latest
0.5.x	1.0.3
0.4.x	0.4.6
0.3.x	0.3.0

What This Module Affects

• Installs the consul daemon (via url or package)
  • If installing from zip, you must ensure the unzip utility is available.
• Optionally installs a user to run it under
• Installs a configuration file (/etc/consul/config.json)
• Manages the consul service via upstart, sysv, or systemd
• Optionally installs the Web UI

Usage

To set up a single consul server, with several agents attached: On the server:

class { '::consul':
  config_hash => {
    'bootstrap_expect' => 1,
    'data_dir'         => '/opt/consul',
    'datacenter'       => 'east-aws',
    'log_level'        => 'INFO',
    'node_name'        => 'server',
    'server'           => true,
  }
}

On the agent(s):

class { '::consul':
  config_hash => {
    'data_dir'   => '/opt/consul',
    'datacenter' => 'east-aws',
    'log_level'  => 'INFO',
    'node_name'  => 'agent',
    'retry_join' => ['172.16.0.1'],
  }
}

Disable install and service components:

class { '::consul':
  install_method => 'none',
  init_style     => false,
  manage_service => false,
  config_hash => {
    'data_dir'   => '/opt/consul',
    'datacenter' => 'east-aws',
    'log_level'  => 'INFO',
    'node_name'  => 'agent',
    'retry_join' => ['172.16.0.1'],
  }
}

Web UI

To install and run the Web UI on the server, include ui_dir in the config_hash. You may also want to change the client_addr to 0.0.0.0 from the default 127.0.0.1, for example:

class { '::consul':
  config_hash => {
    'bootstrap_expect' => 1,
    'client_addr'      => '0.0.0.0',
    'data_dir'         => '/opt/consul',
    'datacenter'       => 'east-aws',
    'log_level'        => 'INFO',
    'node_name'        => 'server',
    'server'           => true,
    'ui_dir'           => '/opt/consul/ui',
  }
}

For more security options, consider leaving the client_addr set to 127.0.0.1 and use with a reverse proxy:

$aliases = ['consul', 'consul.example.com']

# Reverse proxy for Web interface
include 'nginx'

$server_names = [$::fqdn, $aliases]

nginx::resource::vhost { $::fqdn:
  proxy       => 'http://localhost:8500',
  server_name => $server_names,
}

Service Definition

To declare the availability of a service, you can use the service define. This will register the service through the local consul client agent and optionally configure a health check to monitor its availability.

::consul::service { 'redis':
  checks  => [
    {
      script   => '/usr/local/bin/check_redis.py',
      interval => '10s'
    }
  ],
  port    => 6379,
  tags    => ['master']
}

See the service.pp docstrings for all available inputs.

You can also use consul::services which accepts a hash of services, and makes it easy to declare in hiera. For example:

consul::services:
  service1:
    address: "%{::ipaddress}"
    checks:
      - http: http://localhost:42/status
        interval: 5s
    port: 42
    tags:
      - "foo:%{::bar}"
  service2:
    address: "%{::ipaddress}"
    checks:
      - http: http://localhost:43/status
        interval: 5s
    port: 43
    tags:
      - "foo:%{::baz}"

Watch Definitions

::consul::watch { 'my_watch':
  handler     => 'handler_path',
  passingonly => true,
  service     => 'serviceName',
  service_tag => 'serviceTagName',
  type        => 'service',
}

See the watch.pp docstrings for all available inputs.

You can also use consul::watches which accepts a hash of watches, and makes it easy to declare in hiera.

Check Definitions

::consul::check { 'true_check':
  interval => '30s',
  script   => '/bin/true',
}

See the check.pp docstrings for all available inputs.

You can also use consul::checks which accepts a hash of checks, and makes it easy to declare in hiera.

Removing Service, Check and Watch definitions

Do ensure => absent while removing existing service, check and watch definitions. This ensures consul will be reloaded via SIGHUP. If you have purge_config_dir set to true and simply remove the definition it will cause consul to restart.

ACL Definitions

consul_acl { 'ctoken':
  ensure => 'present',
  rules  => {'key' => {'test' => {'policy' => 'read'}}},
  type   => 'client',
}

Do not use duplicate names, and remember that the ACL ID (a read-only property for this type) is used as the token for requests, not the name

Optionally, you may supply an acl_api_token. This will allow you to create ACLs if the anonymous token doesn't permit ACL changes (which is likely). The api token may be the master token, another management token, or any client token with sufficient privileges.

Limitations

Depends on the JSON gem, or a modern ruby. (Ruby 1.8.7 is not officially supported)

Consul Template

Consul Template is a piece of software to dynamically write out config files using templates that are populated with values from Consul. This module does not configure consul template. See gdhbashton/consul_template for a module that can do that.

Development

Open an issue or fork and open a Pull Request

Change Log

v1.0.8 (2016-04-13)

Full Changelog

Closed issues:

• Switch from using staging module to archive #242
• Service start is broken on Debian > 8.0 #232
• Services variable not working with hiera hash. Expects an array of hashes it seems. #230
• ensure_packages unzip with 'before' breaks interoperability #187
• Setting consul::version in hiera does not change the download_url #129
• add maintenance mode option to init scripts #124
• Watches key in config_hash should expect an array of hashes? #83

v1.0.6 (2016-03-24)

Full Changelog

Closed issues:

• Master broken on EL6 due to "Invalid service provider 'sysv'" #240
• Service reload too quick #231
• Systemd limits issue #225
• Encryption #224
• Duplicate declaration: Class[Staging] with puppet/mysql mysqltuner #223
• Consul reload fails when rpc_addr is 0.0.0.0 #220
• Support creating ACLs while talking to a hostname other than localhost #216
• Release version 1.0.5 #215

Merged pull requests:

• Switching from staging to archive module #243 (split3)
• EL \< 7 uses init service provider, not sysv. #241 (fatmcgav)
• Update reload_service.pp #235 (nvtkaszpir)
• add support for arm (Raspberry pi's ARM here) architecture #234 (gibre)
• Added custom init style "custom" #233 (ph0enix49)
• lazily return nil when consul client isn't installed #227 (roobert)
• add NOFILE limit to systemd template #226 (DjxDeaf)
• Debian init script should depend on networking, resolution and syslog #222 (chrisboulton)
• When reloading consul, use 127.0.0.1 as rpc_addr when rpc_addr was set to 0.0.0.0 #221 (danielbenzvi)
• Add hostname proprety for ACL operations, defaults to localhost, like before #219 (gozer)
• Consul Version Fact #209 (robrankin)
• Set provider on consul service #125 (albustax)

v1.0.5 (2016-01-08)

Full Changelog

Fixed bugs:

• umask feature breaks CentOS init scripts #107

Closed issues:

• If $install_method = 'url', won't upgrade consul #103

Merged pull requests:

• ACL fixes - idempotentcy and port bug. #214 (sigerber)
• Fix port property #213 (horsehay)
• Add support of OpenSuSE and SLED #212 (kscherer)
• Fix web_ui installation on Consul 0.6.0 and greater #208 (dbeckham)
• mitigate .to_json segfaults on Ruby 1.8.7 #205 (duritong)

v1.0.4 (2015-12-15)

Full Changelog

Merged pull requests:

• Added support for TCP checks (available in Consul 0.6.x) #206 (split3)

v1.0.3 (2015-12-10)

Full Changelog

Closed issues:

• Default mode on config.json and service files is too permissive #199
• Wrong number of arguments given #194
• metadata.json - needs at least 4.6.0 of stdlib #190
• Strange (probably unnecessary) behavior in sysv stop script #174

Merged pull requests:

• Updating staging file download to use the version and symlink #202 (split3)
• Updated download_urls used to be the new releases.hashicorp.com location #201 (split3)
• parameterize config file mode #200 (aj-jester)
• Add parameter for setting port to custom acl type #197 (horsehay)
• Allow ACL ID to be writeable #196 (robrankin)
• need at least 4.6.0 of puppetlabs/stdlib #191 (gdhbashton)
• Remove management of unzip package #189 (danieldreier)
• consul init sysv: lower stop priority #188 (koendc)
• actually we want to escape / globally for filenames #186 (duritong)
• Fixed chuid / consul executed as root #183 (sw0x2A)
• Rework sysv stop script to fix issues #181 (pforman)
• explicitly define ownership of config directory, installation breaks for hardened Linux boxes with default umask of 0077 - this fixes the problem #168 (proletaryo)

v1.0.2 (2015-09-05)

Full Changelog

Closed issues:

• Log rotation? #182
• Staging missing dependency on Package\['unzip'\] #164
• Documentation #161
• Ruby 1.8 support #148
• GOMAXPROCS discarded by upstart init due to sudo's env_reset option #126
• Module should have a CHANGELOG #122
• Debian: /var/run/consul/consul.pid user affinity inconsistent #120
• config_hash converts strings to integers => breaks port mappings #119
• Invalid resource type staging::file #117
• Need to add -data-dir option to startup scripts. #115
• Meta stuff Not up to snuff #76
• Send SIGHUP to consul agent when new checks/services are detected #43
• Support consul-template #36

Merged pull requests:

• Update beaker tests + travis integration #180 (solarkennedy)
• fix 'consul reload' on custom rpc port #179 (mdelagrange)
• More rpc port support for debian/upstart #177 (solarkennedy)
• Archlinux support #176 (vdloo)
• pretty config (that properly sorts) #175 (aj-jester)
• prevent unnecessary consul restarts on puppet runs #173 (mdelagrange)
• Add a check for $service_ensure in reload_service #172 (pforman)
• deep_merge to support nested objects #171 (aj-jester)
• parameterize restart on change for the main config #169 (aj-jester)
• unzip depedency for staging #166 (aj-jester)
• Adding support for Ubuntu 15.04 #163 (asasfu)
• Ensure all network interfaces are up before starting in upstart config #162 (jbarbuto)
• UI dir symlink should depend on the dist existing #158 (jsok)
• remove string casting to int #157 (aj-jester)
• convert quoted integers to int object #156 (aj-jester)
• Update the gemfile, hopefully to something beaker and puppet-rspec can tolerate #154 (solarkennedy)
• travis update #153 (jlambert121)
• reload on service, checks and watch changes #152 (aj-jester)
• acl token support for services and checks #151 (aj-jester)
• Modify consul_validate_checks to work with ruby 1.8 #149 (solarnz)
• Adding groups parameter to user definition #147 (robrankin)
• upstart: Agents should gracefully leave cluster on stop #146 (jsok)
• explicitly set depedencies for package install #145 (jlambert121)
• Use strict vars all the time, and future parser for later versions #144 (solarkennedy)
• add puppet 4 testing to travis #143 (jlambert121)
• create user/group as system accounts #142 (jlambert121)
• correct links for consul template #140 (jlambert121)
• compatibiliy fix: ensure variables are defined #139 (mklette)
• Pass ensure to service definition file #138 (mklette)
• Fix debian init #137 (dizzythinks)
• update default consul version #136 (jlambert121)
• Make consul::install optional #135 (potto007)
• Add an exec to daemon-reload systemctl when the unit-file changes #134 (robrankin)
• Fix issue #129 - https://github.com/solarkennedy/puppet-consul/issues/129 #133 (potto007)
• Escape the ID & make fixtures useable more widely #132 (duritong)
• Change name of File['config.json'] to File['consul config.json'] #131 (EvanKrall)
• Switch to using start-stop-daemon for consul upstart init script #130 (bdellegrazie)
• Supply optional token for ACL changes #128 (mdelagrange)
• Fix pidfile handling on Debian #121 (weitzj)

v1.0.0 (2015-04-30)

Full Changelog

Closed issues:

• README for consul::service is out of date #110
• delete_undef_values required stdlib 4.2.0, dependency not set properly #109
• init script doesn't have data-dir (0.5.0) #100
• passingonly needs to be a boolean for watch type #97
• Dependency cycle using consul::services #90
• consul should not 'leave' for init script 'stop' action #85
• Cycling dependancy in Hiera-based config #81
• Support for Consul 0.5.0 and multiple check configuration #73
• Path to /home/kyle is hard coded, somewhere #65

Merged pull requests:

• Debian 8.0+ uses systemd #113 (CyBeRoni)
• Update README, ensure passingonly is a bool #112 (zxjinn)
• Update puppetlabs-stdlib dependency to 4.2.0 for the delete_undef_values function #111 (zxjinn)
• Revert "Allow setting of the umask for the consul daemon." #108 (sjoeboo)
• Allow setting of the umask for the consul daemon. #106 (EvanKrall)
• Respect user and group in launchd. #105 (EvanKrall)
• Anchor the consul install/config/run_service classes #102 (koendc)
• Added support for consul 0.5.0 features: #99 (split3)
• make module work with future parser #92 (duritong)
• Add consul_acl type and provider #91 (michaeltchapman)
• Consul expects prefix rather than keyprefix in watch config #89 (codesplicer)
• Expose id parameter for service definitions #88 (codesplicer)
• sysv & debian init updates to kill or leave #87 (runswithd6s)
• Updated the params for OracleLinux Support #84 (MarsuperMammal)
• Fixes #81 bugfix cycle dependency when specifying a service #82 (tayzlor)
• Added compatibility for Scientific Linux #78 (tracyde)
• More lint fixes #77 (solarkennedy)
• Support for Amazon OS #68 (dcoxall)

v0.4.6 (2015-01-23)

Full Changelog

Closed issues:

• Consul init scripts sometimes not installed in the correct order #74

Merged pull requests:

• Move init script to config.pp to ensure it gets set AFTER the package gets installed #75 (tayzlor)
• Add support for providing watches/checks/services via hiera #72 (tayzlor)
• Fix Puppet 3.7.3 giving evaluation error in run_service.pp #71 (tayzlor)
• Update install.pp #69 (ianlunam)
• Adding ability to disable managing of the service #67 (sedan07)
• Some linting fixes and resolves joining wan not actually joining the wan #66 (justicel)
• Better OS support for init_style #63 (avishai-ish-shalom)

v0.4.5 (2015-01-16)

Full Changelog

v0.4.4 (2015-01-16)

Full Changelog

Closed issues:

• Allow Consul clients to join cluster #61
• new function sorted_json does not work if keys are set to undef #59
• Bump to hashicorp/consul GitHub version e9615c50e6 #58
• cannot generate right retry_join string #57
• join_cluster not working on agents #56
• Multiple consul::service with same name causes ArgumentError #46
• service definition file will be changed frequently #45
• cut a new release? #41
• join_cluster doesn't seem to work in some cases #31
• Tests need ruby >= 1.9.2 #7

Merged pull requests:

• Adding "status" to the debian init script #64 (paulhamby)
• Allow hash keys to be set to undef #60 (bodepd)
• Add config_defaults hash parameter #54 (michaeltchapman)
• Make init_style can be disabled #53 (TieWei)
• Make rake spec running #52 (TieWei)
• use versioncmp to compare versions #49 (jfroche)
• Allow overriding a service's name #47 (jsok)
• Make puppet-consul install on OS X #44 (EvanKrall)

v0.4.2 (2014-10-28)

Full Changelog

v0.4.1 (2014-10-28)

Full Changelog

Closed issues:

• Add support for joining multiple datacenters #34
• Configuring consul client nodes #26
• Add support for the new "watch" resource exposed in Consul 0.4.0 #23
• Install ui broken ? #19

Merged pull requests:

• Set default of GOMAXPROCS=2 for SLES #40 (tehranian)
• Fix the GOMAXPROCS warning for Upstart-based systems #39 (tehranian)
• bump to version 0.4.1 #38 (kennyg)
• Add sysconfig support for sysv #37 (dblessing)
• Add join_wan feature #35 (dblessing)
• Version bump; Download Consul 0.4.0 #33 (tehranian)
• Add support for SLES #32 (tehranian)
• Add option to purge config dir #30 (sorenh)
• Changed cluster join code #29 (hkumarmk)
• (retry) Service Definition documentation and fix #28 (benschw)
• Adding in explicit support for "watches" #24 (jrnt30)
• Added join_cluster param to have consul join a cluster after (re)starting service #21 (tylerwalts)
• Fixing gui_package install #20 (KrisBuytaert)
• Added upstart link for old init.d functionality on upstart jobs #18 (lynxman)
• bump to version 0.3.1 #17 (kennyg)
• Install the consul web ui #15 (croomes)
• Adds systemd support #14 (croomes)
• Update CONTRIBUTORS #12 (kennyg)
• bumped to version 0.3.0 #11 (kennyg)

v0.3.0 (2014-06-20)

Closed issues:

• Upstart script does not work on Lucid #5
• Debian support #1

Merged pull requests:

• Add extra_options parameter, to allow extra arguments to the consul agent #9 (EvanKrall)
• Define consul::service and consul::check types #8 (EvanKrall)
• Convert from setuid/setgid to sudo for Lucid support. Allow for group management. #6 (EvanKrall)
• Make download actually work #3 (nberlee)
• Make example config parseable #2 (nberlee)

* This Change Log was automatically generated by github_changelog_generator