etcd 是云原生架构中重要的基础组件,由 CNCF 孵化托管。etcd 在微服务和 Kubernates 集群中不只能够做为服务注册与发现,还能够做为 key-value 存储的中间件。php
《完全搞懂 etcd 系列文章》将会从 etcd 的基本功能实践、API 接口、实现原理、源码分析,以及实现中的踩坑经验等几方面具体展开介绍 etcd。预计会有 20 篇左右的文章,笔者将会每周持续更新,欢迎关注。css
在生产环境中,为了整个集群的高可用,etcd 正常都会集群部署,避免单点故障。本节将会介绍如何进行 etcd 集群部署。引导 etcd 集群的启动有如下三种机制:node
静态启动 etcd 集群要求每一个成员都知道集群中的另外一个成员。 在许多状况下,群集成员的 IP 可能会提早未知。在这些状况下,能够在发现服务的帮助下引导 etcd 群集。nginx
下面咱们将会分别介绍这几种方式。git
若是想要在一台机器上实践 etcd 集群的搭建,能够经过 goreman 工具。github
goreman 是一个 Go 语言编写的多进程管理工具,是对 Ruby 下普遍使用的 foreman 的重写(foreman 原做者也实现了一个 Go 版本:forego,不过没有 goreman 好用)。sql
咱们须要确认 Go 安装环境,而后直接执行:docker
go get github.com/mattn/goreman
编译后的文件放在 $GOPATH/bin
中,$GOPATH/bin
目录已经添加到了系统 $PATH
中,因此咱们能够方便执行命令 goreman
命令。下面就是编写 Procfile 脚本,咱们启动三个 etcd,具体对应以下:数据库
HostName | ip | 客户端交互端口 | peer 通讯端口
:-: | :-: | :-: | :-:
infra1 | 127.0.0.1 | 12379 | 12380 |
infra2 | 127.0.0.1| 22379 | 22380 |
infra3 | 127.0.0.1| 32379 | 32380 |vim
Procfile 脚本以下:
etcd1: etcd --name infra1 --listen-client-urls http://127.0.0.1:12379 --advertise-client-urls http://127.0.0.1:12379 --listen-peer-urls http://127.0.0.1:12380 --initial-advertise-peer-urls http://127.0.0.1:12380 --initial-cluster-token etcd-cluster-1 --initial-cluster 'infra1=http://127.0.0.1:12380,infra2=http://127.0.0.1:22380,infra3=http://127.0.0.1:32380' --initial-cluster-state new --enable-pprof --logger=zap --log-outputs=stderr
etcd2: etcd --name infra2 --listen-client-urls http://127.0.0.1:22379 --advertise-client-urls http://127.0.0.1:22379 --listen-peer-urls http://127.0.0.1:22380 --initial-advertise-peer-urls http://127.0.0.1:22380 --initial-cluster-token etcd-cluster-1 --initial-cluster 'infra1=http://127.0.0.1:12380,infra2=http://127.0.0.1:22380,infra3=http://127.0.0.1:32380' --initial-cluster-state new --enable-pprof --logger=zap --log-outputs=stderr
etcd3: etcd --name infra3 --listen-client-urls http://127.0.0.1:32379 --advertise-client-urls http://127.0.0.1:32379 --listen-peer-urls http://127.0.0.1:32380 --initial-advertise-peer-urls http://127.0.0.1:32380 --initial-cluster-token etcd-cluster-1 --initial-cluster 'infra1=http://127.0.0.1:12380,infra2=http://127.0.0.1:22380,infra3=http://127.0.0.1:32380' --initial-cluster-state new --enable-pprof --logger=zap --log-outputs=stderr
配置项说明:
注意上面的脚本,etcd 命令执行时须要根据本地实际的安装地址进行配置。下面咱们启动 etcd 集群。
goreman -f /opt/procfile start
使用如上的命令启动启动 etcd 集群,启动完成以后查看集群内的成员。
$ etcdctl --endpoints=http://localhost:22379 member list
8211f1d0f64f3269, started, infra1, http://127.0.0.1:12380, http://127.0.0.1:12379, false
91bc3c398fb3c146, started, infra2, http://127.0.0.1:22380, http://127.0.0.1:22379, false
fd422379fda50e48, started, infra3, http://127.0.0.1:32380, http://127.0.0.1:32379, false
咱们在单机搭建的伪集群成功,须要注意的是在集群启动时,咱们是经过静态的方式指定集群的成员,在实际环境中,集群成员的 ip 可能不会提早知道。这时候就须要采用动态发现的机制。
etcd 使用 gcr.io/etcd-development/etcd 做为容器的主要加速器, quay.io/coreos/etcd 做为辅助的加速器。惋惜这两个加速器咱们都无法访问,若是下载不了,可使用笔者提供的地址:
docker pull bitnami/etcd:3.4.7
而后将拉取的镜像从新 tag:
docker image tag bitnami/etcd:3.4.7 quay.io/coreos/etcd:3.4.7
镜像设置好以后,咱们启动 3 个节点的 etcd 集群,脚本命令以下:
REGISTRY=quay.io/coreos/etcd
# For each machine
ETCD_VERSION=3.4.7
TOKEN=my-etcd-token
CLUSTER_STATE=new
NAME_1=etcd-node-0
NAME_2=etcd-node-1
NAME_3=etcd-node-2
HOST_1= 192.168.202.128
HOST_2= 192.168.202.129
HOST_3= 192.168.202.130
CLUSTER=${NAME_1}=http://${HOST_1}:2380,${NAME_2}=http://${HOST_2}:2380,${NAME_3}=http://${HOST_3}:2380
DATA_DIR=/var/lib/etcd
# For node 1
THIS_NAME=${NAME_1}
THIS_IP=${HOST_1}
docker run \
-p 2379:2379 \
-p 2380:2380 \
--volume=${DATA_DIR}:/etcd-data \
--name etcd ${REGISTRY}:${ETCD_VERSION} \
/usr/local/bin/etcd \
--data-dir=/etcd-data --name ${THIS_NAME} \
--initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://0.0.0.0:2380 \
--advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://0.0.0.0:2379 \
--initial-cluster ${CLUSTER} \
--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
# For node 2
THIS_NAME=${NAME_2}
THIS_IP=${HOST_2}
docker run \
-p 2379:2379 \
-p 2380:2380 \
--volume=${DATA_DIR}:/etcd-data \
--name etcd ${REGISTRY}:${ETCD_VERSION} \
/usr/local/bin/etcd \
--data-dir=/etcd-data --name ${THIS_NAME} \
--initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://0.0.0.0:2380 \
--advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://0.0.0.0:2379 \
--initial-cluster ${CLUSTER} \
--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
# For node 3
THIS_NAME=${NAME_3}
THIS_IP=${HOST_3}
docker run \
-p 2379:2379 \
-p 2380:2380 \
--volume=${DATA_DIR}:/etcd-data \
--name etcd ${REGISTRY}:${ETCD_VERSION} \
/usr/local/bin/etcd \
--data-dir=/etcd-data --name ${THIS_NAME} \
--initial-advertise-peer-urls http://${THIS_IP}:2380 --listen-peer-urls http://0.0.0.0:2380 \
--advertise-client-urls http://${THIS_IP}:2379 --listen-client-urls http://0.0.0.0:2379 \
--initial-cluster ${CLUSTER} \
--initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
注意,上面的脚本是部署在三台机器上面,每台机器执行对应的脚本便可。在运行时能够指定 API 版本:
docker exec etcd /bin/sh -c "export ETCDCTL_API=3 && /usr/local/bin/etcdctl put foo bar"
docker 的安装方式比较简单,读者根据须要能够定制一些配置。
如前面所述,在实际环境中,集群成员的 ip 可能不会提早知道。在这种状况下,须要使用自动发现来引导 etcd 集群,而不是指定静态配置,这个过程被称为发现。咱们启动三个 etcd,具体对应以下:
HostName | ip | 客户端交互端口 | peer 通讯端口
:-: | :-: | :-: | :-:
etcd1 | 192.168.202.128 | 2379 | 2380 |
etcd2 | 192.168.202.129| 2379 | 2380 |
etcd3 | 192.168.202.130| 2379 | 2380 |
Discovery service protocol 帮助新的 etcd 成员使用共享 URL 在集群引导阶段发现全部其余成员。
该协议使用新的发现令牌来引导一个惟一的 etcd 集群。一个发现令牌只能表明一个 etcd 集群。只要此令牌上的发现协议启动,即便它中途失败,也不能用于引导另外一个 etcd 集群。
提示:Discovery service protocol 仅用于集群引导阶段,不能用于运行时从新配置或集群监视。
Discovery protocol 使用内部 etcd 集群来协调新集群的引导程序。首先,全部新成员都与发现服务交互,并帮助生成预期的成员列表。以后,每一个新成员使用此列表引导其服务器,该列表执行与 --initial-cluster
标志相同的功能,即设置全部集群的成员信息。
生成将标识新集群的惟一令牌。 在如下步骤中,它将用做发现键空间中的惟一前缀。 一种简单的方法是使用uuidgen:
UUID=$(uuidgen)
获取令牌时,必须指定群集大小。 发现服务使用该大小来了解什么时候发现了最初将组成集群的全部成员。
curl -X PUT http://10.0.10.10:2379/v2/keys/discovery/6c007a14875d53d9bf0ef5a6fc0257c817f0fb83/_config/size -d value=3
咱们须要把该 url 地址 http://10.0.10.10:2379/v2/keys/discovery/6c007a14875d53d9bf0ef5a6fc0257c817f0fb83 做为 --discovery
参数来启动 etcd。
节点会自动使用 http://10.0.10.10:2379/v2/keys/discovery/6c007a14875d53d9bf0ef5a6fc0257c817f0fb83 目录进行 etcd 的注册和发现服务。
当咱们本地没有可用的 etcd 集群,etcd 官网提供了一个能够公网访问的 etcd 存储地址。咱们能够经过以下命令获得 etcd 服务的目录,并把它做为 --discovery
参数使用。
公共发现服务 discovery.etcd.io
以相同的方式工做,可是有一层修饰,能够提取丑陋的 URL,自动生成 UUID,并提供针对过多请求的保护。公共发现服务在其上仍然使用 etcd 群集做为数据存储。
$ curl http://discovery.etcd.io/new?size=3
http://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de
etcd 发现模式下,启动 etcd 的命令以下:
# etcd1 启动
$ /opt/etcd/bin/etcd --name etcd1 --initial-advertise-peer-urls http://192.168.202.128:2380 \
--listen-peer-urls http://192.168.202.128:2380 \
--data-dir /opt/etcd/data \
--listen-client-urls http://192.168.202.128:2379,http://127.0.0.1:2379 \
--advertise-client-urls http://192.168.202.128:2379 \
--discovery https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de
# etcd2 启动
/opt/etcd/bin/etcd --name etcd2 --initial-advertise-peer-urls http://192.168.202.129:2380 \
--listen-peer-urls http://192.168.202.129:2380 \
--data-dir /opt/etcd/data \
--listen-client-urls http://192.168.202.129:2379,http://127.0.0.1:2379 \
--advertise-client-urls http://192.168.202.129:2379 \
--discovery https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de
# etcd3 启动
/opt/etcd/bin/etcd --name etcd3 --initial-advertise-peer-urls http://192.168.202.130:2380 \
--listen-peer-urls http://192.168.202.130:2380 \
--data-dir /opt/etcd/data \
--listen-client-urls http://192.168.202.130:2379,http://127.0.0.1:2379 \
--advertise-client-urls http://192.168.202.130:2379 \
--discovery https://discovery.etcd.io/3e86b59982e49066c5d813af1c2e2579cbf573de
须要注意的是,在咱们完成了集群的初始化后,这些信息就失去了做用。当须要增长节点时,须要使用 etcdctl 进行操做。为了安全,每次启动新 etcd 集群时,都使用新的 discovery token 进行注册。另外,若是初始化时启动的节点超过了指定的数量,多余的节点会自动转化为 Proxy 模式的 etcd。
集群启动好以后,进行验证,咱们看一下集群的成员:
$ /opt/etcd/bin/etcdctl member list
# 结果以下
40e2ac06ca1674a7, started, etcd3, http://192.168.202.130:2380, http://192.168.202.130:2379, false
c532c5cedfe84d3c, started, etcd1, http://192.168.202.128:2380, http://192.168.202.128:2379, false
db75d3022049742a, started, etcd2, http://192.168.202.129:2380, http://192.168.202.129:2379, false
结果符合预期,再看下节点的健康状态:
$ /opt/etcd/bin/etcdctl --endpoints="http://192.168.202.128:2379,http://192.168.202.129:2379,http://192.168.202.130:2379" endpoint health
# 结果以下
http://192.168.202.128:2379 is healthy: successfully committed proposal: took = 3.157068ms
http://192.168.202.130:2379 is healthy: successfully committed proposal: took = 3.300984ms
http://192.168.202.129:2379 is healthy: successfully committed proposal: took = 3.263923ms
能够看到,集群中的三个节点都是健康的正常状态。以动态发现方式启动集群成功。
etcd 还支持使用 DNS SRV 记录进行启动。其实是利用 DNS 的 SRV 记录不断轮训查询实现。DNS SRV 是 DNS 数据库中支持的一种资源记录的类型,它记录了计算机与所提供服务信息的对应关系。
这里使用 Dnsmasq 建立 DNS 服务。Dnsmasq 提供 DNS 缓存和 DHCP 服务、Tftp 服务功能。做为域名解析服务器,Dnsmasq 能够经过缓存 DNS 请求来提升对访问过的网址的链接速度。Dnsmasq 轻量且易配置,适用于我的用户或少于 50 台主机的网络。此外它还自带了一个 PXE 服务器。
当接受到一个 DNS 请求时,Dnsmasq 首先会查找 /etc/hosts 这个文件,而后查找 /etc/resolv.conf 中定义的外部 DNS。配置 Dnsmasq 为 DNS 缓存服务器,同时在 /etc/hosts 文件中加入本地内网解析,这样使得内网机器查询时就会优先查询 hosts 文件,这就等于将 /etc/hosts 共享给全内网机器使用,从而解决内网机器互相识别的问题。相比逐台机器编辑 hosts 文件或者添加 Bind DNS 记录,能够只编辑一个 hosts 文件。
基于笔者使用的 Centos 7 的主机,首先安装 Dnsmasq:
yum install dnsmasq
安装好以后,进行配置,全部的配置都在一个文件中完成 /etc/dnsmasq.conf。咱们也能够在 /etc/dnsmasq.d 中本身写任意名字的配置文件。
resolv-file 配置 Dnsmasq 额外的上游的 DNS 服务器,若是不开启就使用 Linux 主机默认的 /etc/resolv.conf 里的 nameserver。
$ vim /etc/dnsmasq.conf
# 增长以下的内容:
resolv-file=/etc/resolv.dnsmasq.conf
srv-host=_etcd-server._tcp.blueskykong.com,etcd1.blueskykong.com,2380,0,100
srv-host=_etcd-server._tcp.blueskykong.com,etcd2.blueskykong.com,2380,0,100
srv-host=_etcd-server._tcp.blueskykong.com,etcd3.blueskykong.com,2380,0,100
在 dnsmasq.conf 中相应的域名记录,配置了咱们所涉及的三台服务器,分别对应 etcd1,etcd2,etcd3。
$ vim /etc/resolv.dnsmasq.conf
nameserver 8.8.8.8
nameserver 8.8.4.4
这两个免费的 DNS服务,你们应该不陌生。读者能够根据本地实际网络进行配置。
$ vim /etc/resolv.conf
nameserver 127.0.0.1
将 Dnsmasq 解析配置到本地,这很好理解。
分别为各个域名配置相关的 A 记录指向 etcd 核心节点对应的机器 IP。添加解析记录有三种方式:使用系统默认 hosts、使用自定义 hosts 文件、使用自定义 conf。这里咱们使用比较简单的第一种方式。
$ vim /etc/hosts
# 增长以下的内容解析
192.168.202.128 etcd1.blueskykong.com
192.168.202.129 etcd2.blueskykong.com
192.168.202.130 etcd3.blueskykong.com
启动服务
service dnsmasq start
启动好以后,咱们进行验证:
DNS 服务器上 SRV 记录查询,查询到的结果以下:
$ dig @192.168.202.128 +noall +answer SRV _etcd-server._tcp.blueskykong.com
_etcd-server._tcp.blueskykong.com. 0 IN SRV 0 100 2380 etcd2.blueskykong.com.
_etcd-server._tcp.blueskykong.com. 0 IN SRV 0 100 2380 etcd1.blueskykong.com.
_etcd-server._tcp.blueskykong.com. 0 IN SRV 0 100 2380 etcd3.blueskykong.com.
查询域名解析结果
$ dig @192.168.202.128 +noall +answer etcd1.blueskykong.com etcd2.blueskykong.com etcd3.blueskykong.com
etcd1.blueskykong.com. 0 IN A 192.168.202.128
etcd2.blueskykong.com. 0 IN A 192.168.202.129
etcd3.blueskykong.com. 0 IN A 192.168.202.130
至此,咱们已成功安装好 Dnsmasq。下面咱们基于 DNS 发现启动 etcd 集群。
作好了上述两步 DNS 的配置,就可使用 DNS 启动 etcd 集群了。须要删除ETCD_INITIAL_CLUSTER 配置(用于静态服务发现),并指定 DNS SRV 域名(ETCD_DISCOVERY_SRV)。配置 DNS 解析的 url 参数为 -discovery-srv
,其中 etcd1 节点地启动命令以下:
$ /opt/etcd/bin/etcd --name etcd1 \
--discovery-srv blueskykong.com \
--initial-advertise-peer-urls http://etcd1.blueskykong.com:2380 \
--initial-cluster-token etcd-cluster-1 \
--data-dir /opt/etcd/data \
--initial-cluster-state new \
--advertise-client-urls http://etcd1.blueskykong.com:2379 \
--listen-client-urls http://0.0.0.0:2379 \
--listen-peer-urls http://0.0.0.0:2380
etcd 群集成员可使用域名或 IP 地址进行广播,启动的过程将解析 DNS 记录。--initial-advertise-peer-urls 中的解析地址必须与 SRV 目标中的解析地址匹配。etcd 成员读取解析的地址,以查找其是否属于 SRV 记录中定义的群集。
咱们验证基于 DNS 发现启动集群的正确性,查看集群的成员列表:
$ /opt/etcd/bin/etcdctl member list
# 结果以下:
40e2ac06ca1674a7, started, etcd3, http://192.168.202.130:2380, http://etcd3.blueskykong.com:2379, false
c532c5cedfe84d3c, started, etcd1, http://192.168.202.128:2380, http://etcd1.blueskykong.com:2379, false
db75d3022049742a, started, etcd2, http://192.168.202.129:2380, http://etcd2.blueskykong.com:2379, false
能够看到,结果输出 etcd 集群有三个成员,符合预期。下面咱们使用 IP 地址的方式,继续验证集群节点的状态。
$ /opt/etcd/bin/etcdctl --endpoints="http://192.168.202.128:2379,http://192.168.202.129:2379,http://192.168.202.130:2379" endpoint health
# 结果以下:
http://192.168.202.129:2379 is healthy: successfully committed proposal: took = 2.933555ms
http://192.168.202.128:2379 is healthy: successfully committed proposal: took = 7.252799ms
http://192.168.202.130:2379 is healthy: successfully committed proposal: took = 7.415843ms
更多的 etcd 集群操做,读者能够自行尝试,笔者不在此一一展开。
本文在上一篇文章单机安装 etcd 的基础上进行了补充,主要介绍了 etcd 集群的多种安装启动方式:静态单体,静态 docker,动态发现以及 DNS 发现的启动方式。这么多的安装姿式,都是为了咱们实际的使用,下一篇咱们将具体进入 etcdctl 的使用讲解。