Installs and configures Consul client, server and UI.

• CentOS 5.10, 6.5, 7.0
• RHEL 5.10, 6.5, 7.0
• Ubuntu 10.04, 12.04, 14.04

Following attributes, if exist in the encrypted databag, override the node attributes

The easiest way to bootstrap a cluster is to use the cluster recipe and use Chef provisioning which is a relatively new extension. This extension allows you to use any driver and easily stand up a cluster. Once the Chef Development Kit has been installed you can run the following command to provision a cluster.

gem install chef-provisioning chef-provisioning-fog
export CHEF_DRIVER=fog:AWS
chef-client -z cluster.rb

Please follow the Chef provisioning README which provides more detailed information about provisioning. You'll need to configure your credentials prior to provisioning.

The default recipe will install the Consul agent using the consul::install_binary recipe. It will also configure and start consul at the machine boot.

If you only wish to simply install the binary from the official mirror you simply include consul::install_binary in your node's run_list:

{
  "run_list": [
    "recipe[consul::install_binary]"
  ]
}

Instead if you wish to install Consul from source you simply need to include consul::install_source in your node's run_list. This will also configure the Go language framework on the node to build the application.

{
  "run_list": [
    "recipe[consul::install_source]"
  ]
}

Installing the separate Consul UI simply requires you to include the consul::ui recipe in your node's run_list.

{
  "run_list": [
    "recipe[consul::ui]"
  ]
}

consul_key_watch_def 'key-watch-name' do
  key "/key/path"
  handler "chef-client"
end

consul_event_watch_def 'event-name' do
  handler "chef-client"
end

consul_service_watch_def 'service-name' do
	  passingonly true
  handler "chef-client"
end

consul_service_def 'voice1' do
  port 5060
  tags ['_sip._udp']
  notifies :reload, 'service[consul]'
end

consul_service_def 'voice1' do
  port 5060
  tags ['_sip._udp']
  check(
    interval: '10s',
    script: 'echo ok'
  )
  notifies :reload, 'service[consul]'
end

consul_service_def 'voice1' do
  action :delete
  notifies :reload, 'service[consul]'
end

Be sure to notify the Consul resource to restart when your service def changes.

To bootstrap a consul cluster follow the following steps: 0. Make sure that ports 8300-8302 (by default, if you configured differnt ones open those) UDP/TCP are all open.

1. Bootstrap a few (preferablly 3 nodes) to be your consul servers, these will be the KV masters.
2. Put node['consul']['servers'] =["Array of the bootstrapped servers ips or dns names"] in your environment.
3. Apply the consul cookbook to these nodes with node['consul']['service_mode'] = 'cluster' (I put this in this in a CONSUL_MASTER role).
4. Let these machines converge, once you can run consul members and get a list of all of the servers your ready to move on
5. Apply the consul cookbook to the rest of your nodes with node['consul']['service_mode'] = 'client' (I put this in the environment)
6. Start added services and checks to your cookbooks.
7. If you want to get values out of consul to power your chef, curl localhost:8500/v1/kv/key/path?raw in your cookbook.

Created and maintained by John Bellone @johnbellone ([email protected]) and a growing community of contributors.