etcd cookbook - installs coreos/etcd on centos/ubuntu boxen

Supported Platforms

Centos/rhat 6+ & ubuntu with upstart

Recipes

Name	Description
default	Install and setup the service
binary_install	Installs the binary of etcd from github release tarballs
cluster	Recipe to aide in the building of multi-node etcd clusters
compile_time	Install and configure etcd during chef compile phase
source_install	Compiles the binary of etcd from a specificed github repo/revision
_service	Recipe used by default for setting up the service

Attributes

attribute	default setting	description
default[:etcd][:install_method]	binary	Right now only binary and source are supported. In the future this will probably go away as there are actual distro packages
default[:etcd][:version]	0.3.0	The release versions to install. binary install will assemble a github url to grab this version
default[:etcd][:sha256]	726bd3..	The Sha256 hash of the tarball specified by the version or URL attribute
default[:etcd][:url]	nil	override the internal generated url to specify your own binary tarball. see the .kitchen.yml for example override
default[:etcd][:state_dir]	/var/cache/etcd/state	Where etcd will store its state
default[:etcd][:search_cook]	'etcd\:\:cluster'	The cookbook that should be searched for on the nodes recipes to detect if it is also running etcd
default[:etcd][:trigger_restart]	true	Make etcd restart if the init config is updated
default[:etcd][:trigger_start]	true	Make etcd start during this run
default[:etcd][:upstart][:start_on]	started networking	When to start the etcd service using upstart
default[:etcd][:upstart][:stop_on]	shutdown	When to stop the etcd service using upstart

These attributes control the startup/cmdline args for etcd:

attribute	default setting	description
default[:etcd][:name]	nil	The name etcd uses inthe cluster. By default we use the first available value from node[:fqdn], node[:hostname], or node[:name]. Set this to something else to override.
default[:etcd][:snapshot]	true	(deprecated in etcd v2.0 and above) This is really important to get good memory usage. If you're running this in product, you probably want this set to true
default[:etcd][:seed_node]	nil	The seed node for initial cluster setup. This node will start as the master, but restarts will rejoin the raft cluster. This needs to be set when using cluster recipe otherwise the cluster will not initialize.
default[:etcd][:nodes]	[]	Array of hostnames in cluster. This provides an alternative method to using Chef's partial_search for specifying nodes in cluster (useful if using chef-solo)
default[:etcd][:addr]	node.ipaddress:4001	The address that etcd uses publicly. defaults to node.ipaddress:4001
default[:etcd][:peer_addr]	node.ipaddress:7001	address to announce to peers specified as ip:port or ip when empty string it will set to node.ipaddress:7001
default[:etcd][:discovery]	''	Discovery address/token see: https://coreos.com/docs/cluster-management/setup/etcd-cluster-discovery/ for more info
default[:etcd][:env_scope]	true	Set the search in cluster recipe to restrict to nodes in the same environment
default[:etcd][:args]	''	Extra arguments to pass to etcd when starting the service. if you specify something that is computed they will be passed twice. This is here to handle where you want to setup other things.

Usage

Default single instance single node:

Simply add etcd to your runlist

run_list[etcd]

Setup a cluster

NOTE: setting node[:etcd][:addr] and [:etcd][:peer_addr] is important when using a cluster where nodes might have many addresses. Make sure they advertise an address that is reachable by other members.

Using Seed node

In a role or wrapper cookbook setup the seed_node attribute and add the cluster recipe to each node in the cluster. If you use a wrapper cookbook set node[:etcd][:search_cook] to the wrapper cookboks name

run_list[etcd::cluster]

example wrapper can be seen here

Using Discovery

To use discovery simply goto https://discovery.etcd.io/new and get a url then set node[:etcd][:discovery] to that url. This can also be your own etcd instance and a key.

Then use etcd::cluster recipe to build out the cluster.

License and Author

Original Author	Jesse Nelson
Contributor	Soulou
Contributor	Aaron O'Mullan
Contributor	Anthony Scalisi
Contributor	Robert Coleman
Contributor	James Gregory
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

http://www.apache.org/licenses/LICENSE-2.0

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.