The following guide shows how to run etcd with rkt and Docker using the static bootstrap process.

rkt

Running a single node etcd

The following rkt run command will expose the etcd client API on port 2379 and expose the peer API on port 2380.

Use the host IP address when configuring etcd.

  1. export NODE1=192.168.1.21

Trust the CoreOS App Signing Key.

  1. sudo rkt trust --prefix coreos.com/etcd
  2. # gpg key fingerprint is: 18AD 5014 C99E F7E3 BA5F  6CE9 50BD D3E0 FC8A 365E

Run the v3.1.2 version of etcd or specify another release version.

  1. sudo rkt run --net=default:IP=${NODE1} coreos.com/etcd:v3.1.2 -- -name=node1 -advertise-client-urls=http://${NODE1}:2379 -initial-advertise-peer-urls=http://${NODE1}:2380 -listen-client-urls=http://0.0.0.0:2379 -listen-peer-urls=http://${NODE1}:2380 -initial-cluster=node1=http://${NODE1}:2380

List the cluster member.

  1. etcdctl --endpoints=http://192.168.1.21:2379 member list

Running a 3 node etcd cluster

Setup a 3 node cluster with rkt locally, using the -initial-cluster flag.

  1. export NODE1=172.16.28.21
  2. export NODE2=172.16.28.22
  3. export NODE3=172.16.28.23
  1. # node 1
  2. sudo rkt run --net=default:IP=${NODE1} coreos.com/etcd:v3.1.2 -- -name=node1 -advertise-client-urls=http://${NODE1}:2379 -initial-advertise-peer-urls=http://${NODE1}:2380 -listen-client-urls=http://0.0.0.0:2379 -listen-peer-urls=http://${NODE1}:2380 -initial-cluster=node1=http://${NODE1}:2380,node2=http://${NODE2}:2380,node3=http://${NODE3}:2380
  4. # node 2
  5. sudo rkt run --net=default:IP=${NODE2} coreos.com/etcd:v3.1.2 -- -name=node2 -advertise-client-urls=http://${NODE2}:2379 -initial-advertise-peer-urls=http://${NODE2}:2380 -listen-client-urls=http://0.0.0.0:2379 -listen-peer-urls=http://${NODE2}:2380 -initial-cluster=node1=http://${NODE1}:2380,node2=http://${NODE2}:2380,node3=http://${NODE3}:2380
  7. # node 3
  8. sudo rkt run --net=default:IP=${NODE3} coreos.com/etcd:v3.1.2 -- -name=node3 -advertise-client-urls=http://${NODE3}:2379 -initial-advertise-peer-urls=http://${NODE3}:2380 -listen-client-urls=http://0.0.0.0:2379 -listen-peer-urls=http://${NODE3}:2380 -initial-cluster=node1=http://${NODE1}:2380,node2=http://${NODE2}:2380,node3=http://${NODE3}:2380

Verify the cluster is healthy and can be reached.

  1. ETCDCTL_API=3 etcdctl --endpoints=http://172.16.28.21:2379,http://172.16.28.22:2379,http://172.16.28.23:2379 endpoint health

DNS

Production clusters which refer to peers by DNS name known to the local resolver must mount the host’s DNS configuration.

Docker

In order to expose the etcd API to clients outside of Docker host, use the host IP address of the container. Please see docker inspect for more detail on how to get the IP address. Alternatively, specify --net=host flag to docker run command to skip placing the container inside of a separate network stack.

Running a single node etcd

Use the host IP address when configuring etcd:

  1. export NODE1=192.168.1.21

Run the latest version of etcd:

  1. docker run \
  2.   -p 2379:2379 \
  3.   -p 2380:2380 \
  4.   --volume=${DATA_DIR}:/etcd-data \
  5.   --name etcd quay.io/coreos/etcd:latest \
  6.   /usr/local/bin/etcd \
  7.   --data-dir=/etcd-data --name node1 \
  8.   --initial-advertise-peer-urls http://${NODE1}:2380 --listen-peer-urls http://${NODE1}:2380 \
  9.   --advertise-client-urls http://${NODE1}:2379 --listen-client-urls http://${NODE1}:2379 \
  10.   --initial-cluster node1=http://${NODE1}:2380

List the cluster member:

  1. etcdctl --endpoints=http://${NODE1}:2379 member list

Running a 3 node etcd cluster

  1. # For each machine
  2. ETCD_VERSION=latest
  3. TOKEN=my-etcd-token
  4. CLUSTER_STATE=new
  5. NAME_1=etcd-node-0
  6. NAME_2=etcd-node-1
  7. NAME_3=etcd-node-2
  8. HOST_1=10.20.30.1
  9. HOST_2=10.20.30.2
  10. HOST_3=10.20.30.3
  11. CLUSTER=${NAME_1}=http://${HOST_1}:2380,${NAME_2}=http://${HOST_2}:2380,${NAME_3}=http://${HOST_3}:2380
  12. DATA_DIR=/var/lib/etcd
  14. # For node 1
  15. THIS_NAME=${NAME_1}
  16. THIS_IP=${HOST_1}
  17. docker run \
  18.   -p 2379:2379 \
  19.   -p 2380:2380 \
  20.   --volume=${DATA_DIR}:/etcd-data \
  21.   --name etcd quay.io/coreos/etcd:${ETCD_VERSION} \
  22.   /usr/local/bin/etcd \
  23.   --data-dir=/etcd-data --name ${THIS_NAME} \
  24.   --initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://${THIS_IP}:2380 \
  25.   --advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://${THIS_IP}:2379 \
  26.   --initial-cluster ${CLUSTER} \
  27.   --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
  29. # For node 2
  30. THIS_NAME=${NAME_2}
  31. THIS_IP=${HOST_2}
  32. docker run \
  33.   -p 2379:2379 \
  34.   -p 2380:2380 \
  35.   --volume=${DATA_DIR}:/etcd-data \
  36.   --name etcd quay.io/coreos/etcd:${ETCD_VERSION} \
  37.   /usr/local/bin/etcd \
  38.   --data-dir=/etcd-data --name ${THIS_NAME} \
  39.   --initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://${THIS_IP}:2380 \
  40.   --advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://${THIS_IP}:2379 \
  41.   --initial-cluster ${CLUSTER} \
  42.   --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
  44. # For node 3
  45. THIS_NAME=${NAME_3}
  46. THIS_IP=${HOST_3}
  47. docker run \
  48.   -p 2379:2379 \
  49.   -p 2380:2380 \
  50.   --volume=${DATA_DIR}:/etcd-data \
  51.   --name etcd quay.io/coreos/etcd:${ETCD_VERSION} \
  52.   /usr/local/bin/etcd \
  53.   --data-dir=/etcd-data --name ${THIS_NAME} \
  54.   --initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://${THIS_IP}:2380 \
  55.   --advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://${THIS_IP}:2379 \
  56.   --initial-cluster ${CLUSTER} \
  57.   --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

To run etcdctl using API version 3:

  1. docker exec etcd /bin/sh -c "export ETCDCTL_API=3 && /usr/local/bin/etcdctl put foo bar"

Bare Metal

To provision a 3 node etcd cluster on bare-metal, the examples in the baremetal repo may be useful.

Mounting a certificate volume

The etcd release container does not include default root certificates. To use HTTPS with certificates trusted by a root authority (e.g., for discovery), mount a certificate directory into the etcd container:

  1. rkt run \
  2.   --volume etcd-ssl-certs-bundle,kind=host,source=/etc/ssl/certs/ca-certificates.crt \
  3.   --mount volume=etcd-ssl-certs-bundle,target=/etc/ssl/certs/ca-certificates.crt \
  4.   quay.io/coreos/etcd:latest -- --name my-name \
  5.   --initial-advertise-peer-urls http://localhost:2380 --listen-peer-urls http://localhost:2380 \
  6.   --advertise-client-urls http://localhost:2379 --listen-client-urls http://localhost:2379 \
  7.   --discovery https://discovery.etcd.io/c11fbcdc16972e45253491a24fcf45e1
  1. docker run \
  2.   -p 2379:2379 \
  3.   -p 2380:2380 \
  4.   --volume=/etc/ssl/certs/ca-certificates.crt:/etc/ssl/certs/ca-certificates.crt \
  5.   quay.io/coreos/etcd:latest \
  6.   /usr/local/bin/etcd --name my-name \
  7.   --initial-advertise-peer-urls http://localhost:2380 --listen-peer-urls http://localhost:2380 \
  8.   --advertise-client-urls http://localhost:2379 --listen-client-urls http://localhost:2379 \
  9.   --discovery https://discovery.etcd.io/86a9ff6c8cb8b4c4544c1a2f88f8b801