Adoptable Cookbooks List

Looking for a cookbook to adopt? You can now see a list of cookbooks available for adoption!
List of Adoptable Cookbooks

Supermarket Belongs to the Community

Supermarket belongs to the community. While Chef has the responsibility to keep it running and be stewards of its functionality, what it does and how it works is driven by the community. The chef/supermarket repository will continue to be where development of the Supermarket application takes place. Come be part of shaping the direction of Supermarket by opening issues and pull requests or by joining us on the Chef Mailing List.

Select Badges

Select Supported Platforms

RSS

consul (41) Versions 2.2.0

Application cookbook which installs and configures Consul.

Berkshelf/Librarian
Policyfile
Knife
cookbook 'consul', '= 2.2.0'
cookbook 'consul', '= 2.2.0', :supermarket
knife cookbook site install consul
knife cookbook site download consul
README
Dependencies
Changelog
Quality 67%

consul-cookbook

Build Status Code Quality Test Coverage Cookbook Version License

Application cookbook which installs and configures Consul.

Consul is a tool for discovering and configuring services within your infrastructure. This is an application cookbook which takes a simplified approach to configuring and installing Consul. Additionally, it provides Chef primitives for more advanced configuration.

Basic Usage

For most infrastructure we suggest first starting with the default recipe. This installs and configures Consul from the latest supported release. It is also what is used to certify platform support through the use of our integration tests.

This cookbook provides node attributes which are used to fine tune the default recipe which installs and configures Consul. These values are passed directly into the Chef resource/providers which are exposed for more advanced configuration.

Out of the box the following platforms are certified to work and are tested using our [Test Kitchen][8 ] configuration. Additional platforms may work, but your mileage may vary.

  • CentOS (RHEL) 5.11, 6.7, 7.2
  • Ubuntu 12.04, 14.04
  • Windows 2012r2
  • Debian 7.9, 8.2
  • FreeBSD 10.2

Client

Out of the box the default recipe installs and configures the Consul agent to run as a service in client mode. The intent here is that your infrastructure already has a quorum of servers. In order to configure Consul to connect to your cluster you would supply an array of addresses for the Consul agent to join. This would be done in your wrapper cookbook: ruby node.default['consul']['config']['start_join'] = %w{c1.internal.corporate.com c2.internal.corporate.com c3.internal.corporate.com}

Server

This cookbook is designed to allow for the flexibility to bootstrap a new cluster. The best way to do this is through the use of a wrapper cookbook which tunes specific node attributes for a production server deployment.

The Consul cluster cookbook is provided as an example.

Advanced Usage

As explained above this cookbook provides Chef primitives in the form of resource/provider to further manage the install and configuration of Consul. These primitives are what is used in the default recipe, and should be used in your own wrapper cookbooks for more advanced configurations.

Configuration

It is very important to understand that each resource/provider has defaults for some properties. Any changes to a resource's default properties may need to be also changed in other resources. The best example is the Consul configuration directory.

In the example below we're going to change the configuration file from the default (/etc/consul.json) to one that may be on a special volume. It is obvious that we need to change the path where consul_config writes its file to, but it is less obvious that this needs to be passed into consul_service.

Inside of a recipe in your wrapper cookbook you'll want to do something like the following block of code. It uses the validated input from the configuration resource and passes it into the service resource. This ensures that we're using the same data. ruby config = consul_config '/data/consul/default.json' consul_service 'consul' do config_file config.path end

Security

The default recipe makes the Consul configuration writable by the consul service user to avoid breaking existing implementations. You can make this more secure by setting the node['consul']['config'] attribute to root, or set the owner property of consul_config explicitly:

# attributes file
default['consul']['config']['owner'] = 'root'

or ```ruby

recipe file

consul_config '/etc/consul/consul.json' do owner 'root' end ```

Watches/Definitions

In order to provide an idempotent implementation of Consul watches and definitions. We write these out as a separate configuration file in the JSON file format. The provider for both of these resources are identical in functionality.

Below is an example of writing a Consul service definition for the master instance of Redis. We pass in several parameters and tell the resource to notify the proper instance of the Consul service to reload. ruby consul_definition 'redis' do type 'service' parameters(tags: %w{master}, address: '127.0.0.1', port: 6379) notifies :reload, 'consul_service[consul]', :delayed end

A check definition can easily be added as well. You simply have to change the type and pass in the correct parameters. The definition below checks memory utilization using a script on a ten second interval. ruby consul_definition 'mem-util' do type 'check' parameters(script: '/usr/local/bin/check_mem.py', interval: '10s') notifies :reload, 'consul_service[consul]', :delayed end

A service definition with an integrated check can also be created. You will have to define a regular service and then add a check as a an additional parameter. The definition below checks if the vault service is healthy on a 10 second interval and 5 second timeout. ruby consul_definition 'vault' do type 'service' parameters( port: 8200, address: '127.0.0.1', tags: ['vault', 'http'], check: { interval: '10s', timeout: '5s', http: 'http://127.0.0.1:8200/v1/sys/health' } ) notifies :reload, 'consul_service[consul]', :delayed end

Finally, a watch is created below to tell the agent to monitor to see if an application has been deployed. Once that application is deployed a script is run locally. This can be used, for example, as a lazy way to clear a HTTP disk cache. ruby consul_watch 'app-deploy' do type 'event' parameters(handler: '/usr/local/bin/clear-disk-cache.sh') notifies :reload, 'consul_service[consul]', :delayed end

A keen eye would notice that we are delaying the reload of the Consul service instance. The reason we do this is to minimize the number of times we need to tell Consul to actually reload configurations. If there are several definitions this may save a little time off your Chef run.

ACLs

The consul_acl resource allows management of Consul ACL rules. Supported actions are :create and :delete. The :create action will update/insert as necessary.

The consul_acl resource requires the Diplomat Ruby API gem to be installed and available to Chef before using the resource. This can be accomplished by including consul::client_gem recipe in your run list.

In order to make the resource idempotent and only notify when necessary, the id field is always required (defaults to the name of the resource). If type is not provided, it will default to "client". The acl_name and rules attributes are also optional; if not included they will be empty in the resulting ACL.

The example below will create a client ACL token with an ID of the given UUID, Name of "AwesomeApp Token", and Rules of the given string. ruby consul_acl '49f06aa9-782f-465a-becf-44f0aaefd335' do acl_name 'AwesomeApp Token' type 'client' rules <<-EOS.gsub(/^\s{4}/, '') key "" { policy = "read" } service "" { policy = "write" } EOS auth_token node['consul']['config']['acl_master_token'] end

Execute

The command-line agent provides a mechanism to facilitate remote execution. For example, this can be used to run the uptime command across your fleet of nodes which are hosting a particular API service. ruby consul_execute 'uptime' do options(service: 'api') end

All of the options available on the command-line can be passed into the resource. This could potentially be a very dangerous operation. You should absolutely understand what you are doing. By the nature of this command it is impossible for it to be idempotent.

Change Log

v2.1.1

Full Changelog

Closed issues:

  • Documentation for Data Bag Setup #238

Merged pull requests:

v2.1.0 (2016-03-18)

Full Changelog

Closed issues:

  • no more web ui? #297
  • Windows 2012 R2 Issue #295

Merged pull requests:

v2.0.0 (2016-03-17)

Full Changelog

Implemented enhancements:

  • sysvinit.service.erb has the consul service log to /dev/null #284
  • Refactor the population of TLS files to wrapper cookbooks? #247
  • Removed consul_ui resource as Consul 0.6.1+ config option "ui" enables a built-in Web UI #301

Fixed bugs:

  • Updating consul version does not restart consul #251

Closed issues:

  • Key not found: "consul_0.6.3_linux_amd64" #294
  • where does consul installed through this cookbook write its logs #290
  • restart_on_update considered harmful #288
  • Use 'system' attribute when adding consul user & group #287
  • client config not being created #217
  • AWS Autoscaling #192

Merged pull requests:

v1.5.0 (2016-03-07)

Full Changelog

Closed issues:

  • consul_acl (or Diplomat gem) misbehaving #283
  • Service definition with an integrated check #280
  • Atlas Integration go away with v1? #277
  • default['consul']['config']['bag_name'] broke consul_config #276

Merged pull requests:

  • changing the consul_definition tags to an array #286 (fstradiotti)
  • GH-277 - Adding in atlas centric configuration options #285 (jrnt30)
  • adding service definition with integrated check to readme #281 (fstradiotti)
  • Fix "ConsulAcl" provider when specified "id" doesn't exist #278 (legal90)

v1.4.3 (2016-02-08)

Full Changelog

Merged pull requests:

v1.4.2 (2016-02-08)

Full Changelog

Fixed bugs:

  • Windows Consul service does not start up #273

Merged pull requests:

v1.4.1 (2016-02-05)

Full Changelog

Fixed bugs:

  • consul service user /bin/false shell ? #271

Closed issues:

  • New version? #258
  • consul_ui resource does not work #255

v1.4.0 (2016-02-03)

Full Changelog

Implemented enhancements:

  • Basis for selinux set to disabled #242
  • Consul ACL custom resource #240
  • Windows install on 64-bit fails #236
  • Added Windows Support #259 (Ginja)

Fixed bugs:

  • libarchive error when installing consul on Ubuntu 14.04 #241
  • Unable to override databag attributes #239
  • does not start at boot on CentOS 6 #235
  • Consul systemd unit should wait for network #226

Closed issues:

  • Idempotency #262
  • retry_interval should be a string #244
  • Configuring TLS for RPC #230
  • Question: Configuring Consul #229
  • Update README with what has changed #201

Merged pull requests:

v1.3.1 (2015-10-07)

Full Changelog

Closed issues:

  • Cut a new release? #225

v1.3.0 (2015-10-07)

Full Changelog

Implemented enhancements:

  • web UI install missing since 1.0 #215

Merged pull requests:

v1.2.0 (2015-08-24)

Full Changelog

Closed issues:

  • How to pass extra options since refactor? #209
  • golang upgrade? #207

Merged pull requests:

v1.1.1 (2015-08-13)

Full Changelog

v1.1.0 (2015-08-13)

Full Changelog

Closed issues:

  • regression of allowing http checks #206
  • Write more comprehensive unit tests. #202
  • Update README with new, detailed examples. #200

v1.0.0 (2015-08-06)

Full Changelog

Implemented enhancements:

  • Multiple checks for one service #173
  • Add HWRPs for installing and managing consul. #126 (johnbellone)

Merged pull requests:

  • Fix directory permissions on config_dir and data_dir #205 (ewr)
  • Remove references to "quicks_mode" in JSON generation #204 (ewr)

v0.11.1 (2015-07-25)

Full Changelog

Merged pull requests:

v0.11.0 (2015-07-23)

Full Changelog

Implemented enhancements:

  • Windows: resolved merge conflicts and added tests #196 (gdavison)

Fixed bugs:

  • chown resource executes every run, even when not changing anything #191
  • Sensitivity to HUP during launch #125

Closed issues:

  • Anything chef-brigade can do to help? #197
  • Kitchen tests failing on master (commit a8d3060) #194

Merged pull requests:

v0.10.1 (2015-07-10)

Full Changelog

Implemented enhancements:

  • consul systemd hangs at 'create symlink at /etc/service/consul to /etc/sv/consul' on Centos70 #168
  • ui-dir not in config template #131
  • Add support for Consul 0.5.0 and Atlas auto-join #135 (shanesveller)

Fixed bugs:

  • Error executing action extract on resource 'libarchive_file[consul.zip]' #170
  • Missing package on RHEL7 AWS #165
  • Databag item 'ca_file' misnamed #124
  • Wrong user used for services when using upstart #96

Closed issues:

  • Release Tag for 0.10.0 #187
  • HTML tables are garbage, use markdown #186
  • Missing checksum for 0.5.2 #185
  • Windows support #184
  • Question - How to use consul_check #182
  • Gossip/TLS encryption node attributes still requires consul data_bag, encrypt item, secret #151
  • server v cluster semantics unclear to new user / "Getting Started" under-discoverable #149

Merged pull requests:

v0.10 (2015-06-04)

Full Changelog

v0.10.0 (2015-06-04)

Full Changelog

Implemented enhancements:

Closed issues:

  • Question - How to do different configs on different servers #177
  • consul::ui doesn't start with UI process #175
  • Broken SysVinit script -- Consul fails to start on RHEL platforms (Amazon Linux, CentOS, etc.) #150

Merged pull requests:

v0.9.1 (2015-03-30)

Full Changelog

Merged pull requests:

  • Lock libarchive cookbook version to maintain Chef 11 compatibility #156 (agperson)

0.9.0 (2015-03-17)

Full Changelog

Implemented enhancements:

Closed issues:

  • Consul fails to restart with access denied error if the consul user is change #140
  • Is the chef-provisioning cookbook a dependency? #139
  • chef-provisioning should not be a dependency #137
  • Add 0.5.0 checksums #136
  • consul::ui recipe is failing to converge with Errno::EISDIR #133

Merged pull requests:

v0.8.3 (2015-02-14)

Full Changelog

Merged pull requests:

v0.8.2 (2015-02-11)

Full Changelog

Closed issues:

  • Kill on incomplete shutdown #128
  • Add support for dnsmasq #89

Merged pull requests:

v0.8.1 (2015-02-06)

Full Changelog

Merged pull requests:

  • correction to EL init template for active binary and config dir argument... #123 (paulysullivan)

v0.8.0 (2015-02-06)

Full Changelog

Closed issues:

  • install_binary breaks upgrade #116
  • extra_params doesn't merge #111

Merged pull requests:

  • remove unit tests which describe exactly what the code describes #122 (reset)
  • Upgradeable Consul Binary #121 (reset)
  • Fix quoting of bootstrap_expect in README #112 (jhmartin)
  • Make upstart script respawn consul on crash #108 (tgwizard)

v0.7.1 (2015-01-24)

Full Changelog

Merged pull requests:

v0.7.0 (2015-01-23)

Full Changelog

Implemented enhancements:

  • Create a new provider "check_def" #66
  • Implementing bootstrap-expect #31

Fixed bugs:

  • Should check_def create the file using the id property instead of name? #99
  • Install from source fails integration tests #41

Closed issues:

  • Every NEW node will fail at first chef-client #97
  • Allow to use retry_join instead of start_join #93

Merged pull requests:

v0.6.0 (2014-12-11)

Full Changelog

Implemented enhancements:

Closed issues:

  • Interest in Key/Value LWRP #77
  • /etc/sysconfig does not exist on Ubuntu 14.04 #63
  • Write HOWTO #49

Merged pull requests:

0.5.1 (2014-11-06)

Full Changelog

Implemented enhancements:

  • GOMAXPROCS picks number of CPUs using sysconfig - Also updated Serverspec to 2.0 #52 (goncalopereira)

Closed issues:

  • The service consul is not present and restart fail #76
  • Doesn't restart on configuration change #72
  • Stop Consul With SIGINT #47
  • Create consul_directories in install_* recipes #40

Merged pull requests:

0.4.3 (2014-09-19)

Full Changelog

v0.4.3 (2014-09-19)

Full Changelog

Closed issues:

  • Publish v0.4.2 #45
  • Installation fails with ERROR: service[consul] (consul::_service line 112) had an error: Chef::Exceptions::Service: service[consul]: unable to locate the init.d script! #33
  • Add service LWRP example #23

Merged pull requests:

v0.4.2 (2014-09-15)

Full Changelog

Merged pull requests:

  • Correct LWRP examples #44 (johntdyer)
  • Recipe names in readme were wrong #43 (johntdyer)
  • Update for 0.4.0 #42 (johntdyer)
  • fix for #31 , implements support for bootstrap-expect and now creates the data_dir #39 (ravaa)
  • Fix resource order to suppress error when service start before create default.json. #38 (Sheile)

v0.3.1 (2014-08-29)

Full Changelog

Closed issues:

  • Repoforge dependency #30
  • Ark version #28

Merged pull requests:

v0.3.0 (2014-07-04)

Full Changelog

Merged pull requests:

  • add service_def LWRP #20 (reset)
  • bump binary installed version of consul to 0.3.0 #19 (reset)
  • minor refactorings #18 (reset)
  • Fix service_group attribute reference in README #17 (databus23)
  • Add support for runit #16 (webcoyote)
  • support more configuration parameters #15 (bkw)
  • Reload on changes #14 (bkw)
  • support reload via init #13 (bkw)
  • use configfile instead of hardcoding values into init file #12 (bkw)
  • remove superfluous subdir consol_ui #11 (bkw)
  • Remove 0.2 #10 (bkw)

v0.2.2 (2014-05-31)

Full Changelog

Fixed bugs:

  • Source installs are broken #1

Merged pull requests:

v0.2.0 (2014-05-09)

Closed issues:

  • Binary installs broken on centos #2

Merged pull requests:

  • Fix a wrong attribute definition #6 (jemiam)
  • Fix issues with source install #5 (jemiam)
  • Add default recipe which installs and starts consul as a service #4 (kevinreedy)
  • Update README.md #3 (ijin)

* This Change Log was automatically generated by github_changelog_generator

Collaborator Number Metric
            

2.2.0 passed this metric

Collaborator Number Metric
            

2.2.0 passed this metric

Foodcritic Metric
            

2.2.0 failed this metric

FC009: Resource attribute not recognised: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_installation_package.rb:38
FC028: Incorrect #platform? usage: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_config.rb:121
FC028: Incorrect #platform? usage: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_config.rb:131
FC028: Incorrect #platform? usage: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_definition.rb:48
FC028: Incorrect #platform? usage: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_definition.rb:60
FC028: Incorrect #platform? usage: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_watch.rb:46
FC028: Incorrect #platform? usage: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_watch.rb:55
FC038: Invalid resource action: /tmp/2834547ad3c2a0bbe8373197/consul/libraries/consul_installation_package.rb:49
Run with Foodcritic Version 8.1.0 with tags metadata,correctness ~FC031 ~FC045 and failure tags any

Foodcritic Metric
            

2.2.0 failed this metric

FC009: Resource attribute not recognised: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_installation_package.rb:38
FC019: Access node attributes in a consistent manner: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_installation_binary.rb:36
FC019: Access node attributes in a consistent manner: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_service.rb:93
FC023: Prefer conditional attributes: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_service_windows.rb:57
FC028: Incorrect #platform? usage: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_config.rb:121
FC028: Incorrect #platform? usage: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_config.rb:131
FC028: Incorrect #platform? usage: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_definition.rb:48
FC028: Incorrect #platform? usage: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_definition.rb:60
FC028: Incorrect #platform? usage: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_watch.rb:46
FC028: Incorrect #platform? usage: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_watch.rb:55
FC038: Invalid resource action: /tmp/1727337b94cb516881da6a8c/consul/libraries/consul_installation_package.rb:49
FC044: Avoid bare attribute keys: /tmp/1727337b94cb516881da6a8c/consul/attributes/default.rb:15

License Metric
            

2.2.0 passed this metric

Publish Metric
            

2.2.0 passed this metric