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


etcd-v2 (5) Versions 1.0.3

Install and configure etcd

cookbook 'etcd-v2', '= 1.0.3'
cookbook 'etcd-v2', '= 1.0.3', :supermarket
knife cookbook site install etcd-v2
knife cookbook site download etcd-v2

etcd-v2 Cookbook

This cookbook manages etcd version 2. It provides resources for installation from both binaries and source, and for management of one or more etcd service instnaces.

What even is all of this for?!

This cookbook aims to provide a feature complete utility to install and configure one or more instances of etcd for both production and development/testing proposes.

The etcd_service resource allows multiple etcd processes to run on the same system to: * Test client libraries with actual clusters. Not just the one node you brew installd and started in another terminal. * Test discovery configurations and failovers before doing it live. * Figure out how to actually add/remove nodes to/from your cluster safely before you do this.

Similarly, the etcd_binary and etcd_source resources ensure that their respecitve installations are vendored so as to allow mutliple versions/builds of etcd to coexist on a single system. etcd_service resources each map to an installation, allowing you to test arbitrary compatability scenarios both within a cluster and with client libraries.


  • etcd-v2::aws Create a simple cluster using the :aws discovery method
  • etcd-v2::default Install base dependencies. Must be included before using resources.
  • etcd-v2::node Create a standalone node
  • etcd-v2::testing Create a cluster of three nodes on the same host for testing



Install etcd from a compiled release, by default from coreos/etcd on GitHub.

etcd_binary 'default' will install etcd in /opt and link to etcd and etcdctl from /usr/local/bin.

etcd_binary 'name' do
  version 'v2.0.10'       # Default set in node['etcd_v2']['version'], currently 'v2.0.10'
  platform 'linux-amd64'  # Default set in node['etcd_v2']['platform']
  path '/opt'             # Install root. Unpacked into <path>/etcd-<version>-<platform>
  srv_bin 'etcd'          # Name of etcd binary in package
  ctl_bin 'etcdctl'       # Name of etcd control binary in package
  bin_path '/usr/local/bin' # Path to link to binaries from. Set to nil or false to disable linking
  from :github            # Package source. Currently only :github is supported
  repository '/coreos/etcd' # GitHub repo to fetch release from. Default node['etcd_v2']['bin_repository']


Fetch and build etcd from a git repository. This resource does not install golang. The golang cookbook should do the needful for you.

etcd_source 'name' do
  version 'v2.0.10'       # Default set in node['etcd_v2']['version'], currently 'v2.0.10'
  path '/opt'             # Install root. Unpacked into <path>/etcd-<version>-<platform>-<name>
  srv_bin 'etcd'          # Name of etcd binary
  ctl_bin 'etcdctl'       # Name of etcd control binary
  bin_path '/usr/local/bin' # Path to link to binaries from. Set to nil or false to disable linking
  repository '' # Git repo to fetch source from. Default node['etcd_v2']['source_repository']


Configure and run an installation (etcd_binary or etcd_source) as a service. The only required attributes in the following are name_node (name attribute) and instance. Other values have sane defaults for running a single node cluster.

While most configuration parameters are exposed directly, several abstractions are provided to capture some of the more confusing or repetitive parts of the etcd v2 configuration spec:

client_port, peer_port, client_listen, peer_listen, client_host, and peer_host attributes are used to simplify the composition of various *-url arguments. Arrays passed to these attributes will result in geometric compositions, including the protocol arrtibute in the respective argument:


Static peers are added using the peer(name, protocol, host, client_port, peer_port) method. The node's -initial-cluster argument will be composed from a merge of protocol, host, and peer_port parameters as well as the nodes own 'peer_host:peer_port' set.

The discovery attribute enables different configuration arguments specific to the respecive clustering method. :static, :etcd, and :dns are features of etcd. The :aws discovery method is implemented by this cookbook. It uses the EC2 tags API to find peers for cluster bootstrapping.

etcd_service 'node_name' do
  node_name 'node0'       # Name attribute. etcd node name

  ## Required: Installed version of etcd to use. Can be a string/hash reference or an instance
  ## of the `etcd_binary` or `etcd_source` resource (e.g. inherits Chef::Resource::Etcd).
  instance 'etcd_binary[default]'

  ## Service operator. User/group will be created if missing. Default 'etcd'
  user 'etcd'
  group 'etcd'

  ## Passed to unterlying `service` resource
  service_action [:start, :enable]

  ## Node configuration/tuning
  client_host 'localhost' # One or more advertised client hosts (String, Array). Default `node['ipaddress']`
  client_listen '' # One or more client bind addresses (String, Array). Default ``
  client_port 2379        # One or more client listen ports (Integer, Array). Default 2379
  peer_host 'localhost'   # One or more advertised peer hosts. Default `node['ipaddress']`
  peer_listen ''   # One or more peer bind addresses. Default ``
  peer_port 2380          # One or more peer listen ports. Default 2380

  ## See
  data_dir '/var/data/etcd'
  snapshot_count 10_000
  max_snapshots 5
  max_wals 5
  heartbeat_interval 100
  election_timeout 1000

  cors '' # CORS origins allowed by client API (String, Array).
  proxy :off              # One of :on, :readonly, :off. See

  ## SSL
  protocol :http          # Transport protocol. One of :http, :https. Default :http

  ## See
  cert_file 'client-cert.pem'
  key_file 'client-key.pem'
  client_cert_auth true
  trusted_ca_file 'client-ca.pem'
  peer_cert_file 'peer-cert.pem'
  peer_key_file 'peer-key.pem'
  peer_client_cert_auth true
  peer_trusted_ca_file 'peer-ca.pem'

  ## Cluster configuration See for specifics
  discovery :static       # One of :static, :etcd, :dns, :aws.
  quorum 3                # Resource will wait for a quorum to be available before configuring and starting etcd. Currently only used by `:aws` discovery
  state :new              # initial-cluster-state: One of :new, :existing. Default :new
  token 'etcd-cluster'    # initial-cluster-token: Default 'etcd-cluster'

  ## Define a peer node for :static configuration.
  peer 'node1', :http, 'localhost', 2381, 2382

  discovery_service '' # An etcd discovery node
  discovery_proxy '' # HTTP(S) Proxy to etcd discovery servuce
  discovery_domain '' # Domain inwhich to query DNS SRV record etcd-server[-ssl]
  discovery_fallback :exit # One of :exit, :proxy. See

  ## AWS Discovery parameters
  aws_tags :service => 'foo', :cluster => 'production' # Tags used to discover peers
  aws_host_attribute :private_dns_name # AWS-SDK Instance key to be used as hostnames See [The Docs](

  ## AWS key attributes are provided for compatability with the Opscode AWS cookbook;
  ## however, **you should be using IAM instance profiles ಠ_ಠ**
  aws_access_key ''
  aws_secret_access_key ''

Using the :aws discovery method

The :aws discovery method uses AWS tags and etcd APIs to bootstrap a new cluster, join an exizting cluster, or fail back to a proxy node if a cluster of the desired size exists.

  • The :aws discovery method requires the aws cookbook. You must add it to your downstream dependencies and include the aws::default recipe before defining resources that use the :aws discovery method! The aws::ec2_hints recipe may be necessary to coerce ohai into populating node['ec2']
  • node_name will be set to node['ec2']['instance_id']. The same transport protocol and peer_port must be used across the cluster.
  • Due to the serial nature of Chef, multiple etcd_service resources should not be defined in the same run_list for the same cluster when using the :aws discovery method. One resource will block the Chef run until the desired quorum of peers is discovered. Note that the :aws method uses the same underlying configuration as the :static method. For simple testing scenarios, they should be functionally equivalent.
  • The instance will need the following authorizations. They should be configured in an IAM role and applied with an instance profile:
    • ec2:CreateTags
    • ec2:DeleteTags
    • ec2:DescribeTags
    • ec2:DescribeInstances


The included Vagrant file uses the vagrant-secret and vagrant-aws plugins. If you would like to provision EC2 nodes, install both plugins and create a .vagrant/secret.yaml file. Run vagrant secret-init and edit the resulting file:

# Account-specific AWS configurations
access_key_id: 'xxx'
secret_access_key: 'xxx'
keypair_name: 'xxx'

subnet_id: 'subnet-xxx'
  - 'sg-xxx'

# IAM Profile ARN. Associated role must have the actions, listed above, allowed.
iam_instance_profile_arn: 'arn:aws:iam::xxx:instance-profile/xxx'

Foodcritic Metric

1.0.3 passed this metric