isabella232 / kvexpress-cookbook

This cookbook installs kvexpress and offers an LWRP to use with Chef.

kvexpress Cookbook

Installs kvexpress and provides an LWRP to use it from within Chef.

Requirements

• Consul
• Ubuntu

If you're not using Ubuntu - you can download binary releases from Github.

Attributes

default['kvexpress']['version'] = '1.9-1'
default['datadog']['url'] = 'https://app.datadoghq.com'

# Where to place the JSON watches.
default['consul']['config_dir'] = '/etc/consul.d'

# If you're using Consul ACLs to protect the 'kvexpress/' KV space and kvexpress::server_config:
# default['consul']['acl']['kvexpress'] = 'acl-goes-here'

# If you're using the Datadog API to send events and kvexpress::server_config:
# default['datadog']['api_key'] = 'api_key_goes_here'
# default['datadog']['application_key'] = 'app_key_goes_here'

# If you're using the Datadog agent:
default['kvexpress']['dogstatsd'] = false

Default Usage with a Consul watch

Use kvexpress::default to install the binary.

Use the LWRP to get configuration from Consul during a Chef run - here's an example kvexpress resource:

kvexpress 'consul_dns_hosts' do
  location '/etc/hosts.consul'
  compress true
  key 'hosts'
  mode '00644'
  command 'sudo pkill -HUP dnsmasq'
  notifies :reload, 'service[consul]', :delayed
end

During the Chef run, that resource will do the following:

1. If there's no file at /etc/hosts.consul, it will try to download the key kvexpress/hosts/data and save it. It will fail silently if there's no key there - that's by design.
2. It will create a Consul watch inside of /etc/consul.d and reload Consul so any updates are automatically replicated.
3. If it saves a new file, it will send a SIGHUP to dnsmasq to reload it.

The Consul watch will look something like this:

{
  "watches": [
    {
      "type": "key",
      "key": "/kvexpress/hosts/checksum",
      "handler": "kvexpress out -k hosts -f /etc/hosts.consul -l 10 -c 00644 -e 'sudo pkill -HUP dnsmasq' -z true"
    }
  ]
}

If you don't use Chef - you can manually create the JSON needed for the Consul watch - use the above as a template.

Ad-Hoc Usage with Consul exec

Detailed here.

Contributing

We love pull requests from anyone. Details are available here.

Code of Conduct

This project adheres to the [Open Code of Conduct][code-of-conduct]. By participating, you are expected to honor this code. [code-of-conduct]: http://todogroup.org/opencodeofconduct/#kvexpress/[email protected]