This is the documentation for etcd2 releases. Read etcd3 doc for etcd3 releases.

The following guide will show you how to run etcd under Docker using the static bootstrap process.

Running etcd in standalone mode

In order to expose the etcd API to clients outside of the Docker host you’ll need use the host IP address when configuring etcd.

  1. export HostIP="192.168.12.50"

The following docker run command will expose the etcd client API over ports 4001 and 2379, and expose the peer port over 2380.

This will run the latest release version of etcd. You can specify version if needed (e.g. quay.io/coreos/etcd:v2.2.0).

  1. docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  2.  --name etcd quay.io/coreos/etcd:v2.3.8 \
  3.  -name etcd0 \
  4.  -advertise-client-urls http://${HostIP}:2379,http://${HostIP}:4001 \
  5.  -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
  6.  -initial-advertise-peer-urls http://${HostIP}:2380 \
  7.  -listen-peer-urls http://0.0.0.0:2380 \
  8.  -initial-cluster-token etcd-cluster-1 \
  9.  -initial-cluster etcd0=http://${HostIP}:2380 \
  10.  -initial-cluster-state new

Configure etcd clients to use the Docker host IP and one of the listening ports from above.

  1. etcdctl -C http://192.168.12.50:2379 member list
  1. etcdctl -C http://192.168.12.50:4001 member list

Running a 3 node etcd cluster

Using Docker to setup a multi-node cluster is very similar to the standalone mode configuration.The main difference being the value used for the -initial-cluster flag, which must contain the peer urls for each etcd member in the cluster.

Although the following commands look very similar, note that -name, -advertise-client-urls and -initial-advertise-peer-urls differ for each cluster member

etcd0

  1. docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  2.  --name etcd quay.io/coreos/etcd:v2.3.8 \
  3.  -name etcd0 \
  4.  -advertise-client-urls http://192.168.12.50:2379,http://192.168.12.50:4001 \
  5.  -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
  6.  -initial-advertise-peer-urls http://192.168.12.50:2380 \
  7.  -listen-peer-urls http://0.0.0.0:2380 \
  8.  -initial-cluster-token etcd-cluster-1 \
  9.  -initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
  10.  -initial-cluster-state new

etcd1

  1. docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  2.  --name etcd quay.io/coreos/etcd:v2.3.8 \
  3.  -name etcd1 \
  4.  -advertise-client-urls http://192.168.12.51:2379,http://192.168.12.51:4001 \
  5.  -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
  6.  -initial-advertise-peer-urls http://192.168.12.51:2380 \
  7.  -listen-peer-urls http://0.0.0.0:2380 \
  8.  -initial-cluster-token etcd-cluster-1 \
  9.  -initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
  10.  -initial-cluster-state new

etcd2

  1. docker run -d -v /usr/share/ca-certificates/:/etc/ssl/certs -p 4001:4001 -p 2380:2380 -p 2379:2379 \
  2.  --name etcd quay.io/coreos/etcd:v2.3.8 \
  3.  -name etcd2 \
  4.  -advertise-client-urls http://192.168.12.52:2379,http://192.168.12.52:4001 \
  5.  -listen-client-urls http://0.0.0.0:2379,http://0.0.0.0:4001 \
  6.  -initial-advertise-peer-urls http://192.168.12.52:2380 \
  7.  -listen-peer-urls http://0.0.0.0:2380 \
  8.  -initial-cluster-token etcd-cluster-1 \
  9.  -initial-cluster etcd0=http://192.168.12.50:2380,etcd1=http://192.168.12.51:2380,etcd2=http://192.168.12.52:2380 \
  10.  -initial-cluster-state new

Once the cluster has been bootstrapped etcd clients can be configured with a list of etcd members:

  1. etcdctl -C http://192.168.12.50:2379,http://192.168.12.51:2379,http://192.168.12.52:2379 member list