Run etcd clusters inside containers

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

    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.

    Trust the CoreOS App Signing Key.

    2. # gpg key fingerprint is: 18AD 5014 C99E F7E3 BA5F  6CE9 50BD D3E0 FC8A 365E

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

    1. sudo rkt run --net=default:IP=${NODE1} quay.io/coreos/etcd:v3.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
    1. etcdctl --endpoints=http://192.168.1.21:2379 member list

    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

    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

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

    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.

    Use the host IP address when configuring etcd:

    1. export NODE1=192.168.1.21
    1. docker volume create --name etcd-data
    2. export DATA_DIR="etcd-data"

    Run the latest version of etcd:

    1. REGISTRY=quay.io/coreos/etcd
    2. # available from v3.2.5
    3. REGISTRY=gcr.io/etcd-development/etcd
    5. docker run \
    6.   -p 2379:2379 \
    7.   -p 2380:2380 \
    8.   --volume=${DATA_DIR}:/etcd-data \
    9.   --name etcd ${REGISTRY}:latest \
    10.   /usr/local/bin/etcd \
    11.   --data-dir=/etcd-data --name node1 \
    12.   --initial-advertise-peer-urls http://${NODE1}:2380 --listen-peer-urls http://0.0.0.0:2380 \
    13.   --advertise-client-urls http://${NODE1}:2379 --listen-client-urls http://0.0.0.0:2379 \
    14.   --initial-cluster node1=http://${NODE1}:2380

    List the cluster member:

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

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

    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. REGISTRY=quay.io/coreos/etcd
    2. # available from v3.2.5
    3. REGISTRY=docker://gcr.io/etcd-development/etcd
    5. rkt run \
    6.   --insecure-options=image \
    7.   --volume etcd-ssl-certs-bundle,kind=host,source=/etc/ssl/certs/ca-certificates.crt \
    8.   --mount volume=etcd-ssl-certs-bundle,target=/etc/ssl/certs/ca-certificates.crt \
    9.   ${REGISTRY}:latest -- --name my-name \
    10.   --initial-advertise-peer-urls http://localhost:2380 --listen-peer-urls http://localhost:2380 \
    11.   --advertise-client-urls http://localhost:2379 --listen-client-urls http://localhost:2379 \
    12.   --discovery https://discovery.etcd.io/c11fbcdc16972e45253491a24fcf45e1
    1. REGISTRY=quay.io/coreos/etcd
    2. # available from v3.2.5
    3. REGISTRY=gcr.io/etcd-development/etcd
    5. docker run \
    6.   -p 2379:2379 \
    7.   -p 2380:2380 \
    8.   --volume=/etc/ssl/certs/ca-certificates.crt:/etc/ssl/certs/ca-certificates.crt \
    9.   ${REGISTRY}:latest \
    10.   /usr/local/bin/etcd --name my-name \
    11.   --initial-advertise-peer-urls http://localhost:2380 --listen-peer-urls http://localhost:2380 \