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 (56) Versions 3.1.1

Installs and configures etcd

cookbook 'etcd', '= 3.1.1'
cookbook 'etcd', '= 3.1.1', :supermarket
knife supermarket install etcd
knife supermarket download etcd
Quality 100%

Etcd Cookbook

Build Status Cookbook Version

The Etcd Cookbook is a library cookbook that provides custom resources for use in recipes.


This cookbook is concerned with the Etcd distributed key/value store as distributed by CoreOS, Inc.


  • Chef 12.0.0 or higher. Chef 11 is NOT SUPPORTED, please do not open issues about it.
  • Ruby 2.1 or higher (preferably, the Chef full-stack installer)
  • Network accessible web server hosting the etcd binary.

Platform Support

The following platforms have been tested with Test Kitchen. It will most likely work on other platforms as well

|              | 2.2.2 |
| debian-8     | X     |
| centos-5     | X     |
| centos-6     | X     |
| centos-7     | X     |
| fedora-21    | X     |
| ubuntu-12.04 | X     |
| ubuntu-14.04 | X     |
| ubuntu-15.10 | X     |

Cookbook Dependencies


  • Add depends 'etcd', '~> 3.0' to your cookbook's metadata.rb
  • Use the resources shipped in cookbook in a recipe, the same way you'd use core Chef resources (file, template, directory, package, etc).
etcd_service 'etcd0' do
  advertise_client_urls ','
  listen_client_urls ','
  initial_advertise_peer_urls ''
  listen_peer_urls ''
  initial_cluster_token 'etcd-cluster-1'
  initial_cluster 'etcd0=,etcd1=,etcd2='
  initial_cluster_state 'new'
  action :start

etcd_service 'etcd1' do
  advertise_client_urls ','
  listen_client_urls ','
  initial_advertise_peer_urls ''
  listen_peer_urls ''
  initial_cluster_token 'etcd-cluster-1'
  initial_cluster 'etcd0=,etcd1=,etcd2='
  initial_cluster_state 'new'
  action :start

etcd_service 'etcd2' do
  advertise_client_urls ','
  listen_client_urls ','
  initial_advertise_peer_urls ''
  listen_peer_urls ''
  initial_cluster_token 'etcd-cluster-1'
  initial_cluster 'etcd0=,etcd1=,etcd2='
  initial_cluster_state 'new'
  action :start

Test Cookbooks as Examples

The cookbooks ran under test-kitchen make excellent usage examples.

The test recipes are found at: ruby test/cookbooks/etcd_test/

Resources Overview

  • etcd_service: composite resource that uses etcd_installation and etcd_service_manager
  • etcd_installation: automatically selects an installation method
  • etcd_service_manager: automatically selects a service manager

  • etcd_installation_binary: copies a pre-compiled etcd binary onto disk

  • etcd_installation_docker: pulls a docker image to the DOCKER_HOST

  • etcd_service_manager_execute: manage etcd daemon with Chef

  • etcd_service_manager_sysvinit: manage etcd daemon with a sysvinit script

  • etcd_service_manager_upstart: manage etcd daemon with upstart script

  • etcd_service_manager_systemd: manage etcd daemon with systemd unit files

  • etcd_service_manager_docker: starts a docker process on the DOCKER_HOST

Resources Details


The etcd_installation resource auto-selects one of the below resources with the provider resolution system. Currently only the binary installation is available. Packages will be supported in the future versions.


etcd_installation 'default' do
  action :create


The etcd_installation_binary resource copies the precompiled Go binary onto the disk. It exists to help run older Etcd versions. It should not be used in production, especially with devicemapper.


etcd_installation_binary 'default' do
  version '2.2.2'
  source ''
  checksum '90aff7364caa43932fd46974825af20e0ecb70fe7e01981e2d3a496106f147e7'
  action :create


The etcd_installation_docker resource uses the docker_image resource to pull an image to the DOCKER_HOST.


  • repo - The image name to pull. Defaults to ''
  • tag - The image tag to pull.
  • version - String used to calculate tag string when tag is ommited. Defaults to '2.2.2'


The etcd_service_manager resource auto-selects one of the below resources with the provider resolution system. The etcd_service family all share a common set of properties, which are listed under the etcd_service composite resource.


etcd_service_manager 'default' do
  action :start



etcd_service_manager_execute 'default' do
  action :start



etcd_service_manager_sysvinit 'default' do
  action :stop



etcd_service_manager_upstart 'default' do
  action :start



etcd_service_manager_systemd 'default' do
  action :start



etcd_service_manager_docker 'default' do
  action :start


  • repo - defaults to ''
  • tag - default calculated from version
  • version - defaults to '2.2.2',
  • container_name - defaults to resource name
  • port - defaults to ['2379/tcp4:2379', '4001/tcp4:4001']


The etcd_service: resource is a composite resource that uses etcd_installation and etcd_service_manager resources.

  • The :create action uses am etcd_installation
  • The :delete action uses anetcd_installation
  • The :start action uses an etcd_service_manager
  • The :stop action uses an etcd_service_manager

The service management strategy for the host platform is dynamically chosen based on platform, but can be overridden.


The etcd_service resource property list corresponds to the options found in

Etcd Configuration Flags documentation

  • Member flags
  • source
  • node_name
  • data_dir
  • wal_dir
  • snapshot_count snapshot to disk.
  • heartbeat_interval
  • election_timeout
  • listen_peer_urls
  • listen_client_urls
  • max_snapshots
  • max_wals
  • cors

  • Clustering Flags

  • initial

  • initial_advertise_peer_urls

  • initial_cluster

  • initial_cluster_state

  • initial_cluster_token

  • advertise_client_urls

  • discovery

  • discovery_srv

  • discovery_fallback

  • discovery_proxy

  • Proxy Flags

  • proxy -

  • proxy_failure_wait

  • proxy_refresh_interval

  • proxy_dial_timeout

  • proxy_write_timeout

  • proxy_read_timeout

  • Security Flags

  • cert_file

  • key_file

  • client_cert_auth

  • trusted_ca_file

  • peer_cert_file

  • peer_key_file

  • peer_client_cert_auth

  • peer_trusted_ca_file

  • Logging Flags

  • debug

  • Unsafe Flags

  • force_new_cluster

  • Experimental Flags

  • experimental_v3demo

  • Misc

  • http_proxy

  • https_proxy

  • no_proxy

  • auto_restart

License and Author

Original Author Jesse Nelson
Contributor Soulou
Contributor Aaron O'Mullan
Contributor Anthony Scalisi
Contributor Robert Coleman
Contributor James Gregory
Contributor Sean OMeara
Copyright Copyright (c) 2013, Jesse Nelson


Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.


  • Adding docker to etcd_service


  • Supporting run_user on service manager resources


  • New major version, non-backwards compatible with 2.x.x
  • Rewritten as Custom Resources
  • Defaulting to etcd version 2.2.2


  • update to etcd 0.4.6
  • adds debian support


  • update to etcd 0.4.5
  • Add centos 7 support
  • Support centos cloud images without tar
  • Dry out compile time recipe
  • Move to berks3


  • update to etcd 0.4.2
  • Removed node[:etcd][:local] No longer needed in new etcd. Etcd will default bind :4001 and :7001. The cookbook default is now to use node[:ipaddress] as the addr and peer_addr.
  • add auto-respawn instruction in upstart config file
  • Fix Gem deps in the ci build


  • add peer and peer_addr support / attributes
  • add name attribute and computation
  • fixup cmdline argument computation
  • ensure cluster members are always sorted
  • fix spec tests


  • fix bug in cluster recipe where Resolv was spelled wrong
  • fix kitchen test on cluster to pickup this issue.
  • add basic chefspec as well to ensure this sort of issue doesn't occur
  • fix bug with name attribute methods
  • fix searching for wrong recipe when using cluster recipe


  • update to etcd 0.3.0
  • Add support for new discovery mode
  • refactor common functions into library methods
  • Add specs
  • Use rubocop to replace tailor/cane
  • Fixup testing (add travis integration)


  • update to etcd 0.2.0
  • remove name_switch attribute. It was marked for deprication in 1.3
  • enable snapshotting by default
  • add optional local listener
  • support chef-solo
  • Add support of explicitely specifying a cluster's nodes


  • silence foodcritic by accessing attributes in a consistent manner,
  • trigger a restart when etcd conf is updated
  • include git if source install
  • metadata depends on git recipe
  • Update Documentation
  • Update contributors


  • fix compile_time to use the right tarball path


  • Bump to etcd 1.2
  • Added source install recipe


  • default binding to node[:ipaddress]


  • update to etcd 0.1.1 release
  • add compile_time recipe that does the whole bit in chef compile time


  • hotfix to add missing node[:etcd][:env_scope] attribute
  • bugfix: use node[:fqdn] instead of hostname when matching local machine name


  • add cluster recipe for setting up clusters of etcd nodes
  • re-add seed-node attribute


  • fix the startup args so it is easier to specify custom args
  • supports release version and current master on git
  • add in tests for both release and git versions of etcd


  • Make everything work with release 0.1.0 of etcd
  • fixup some syntax issues


  • move binary install to using coreos/etcd releases from github
  • for now the install locattion is fixed to /usr/local and links in /usr/local/bin
  • Use ark for managing tarballs
  • move bats tests to using etcdctl instead of curl

Foodcritic Metric

3.1.1 passed this metric