etcd是近几年比较火热的一个开源的、分布式的键值对数据存储系统,提供共享配置、服务的注册和发现,本文主要介绍etcd的安装和使用。

etcd介绍

etcd是使用Go语言开发的一个开源的、高可用的分布式key-value存储系统,可以用于配置共享和服务的注册和发现。
类似项目有zookeeper和consul。
etcd具有以下特点:

  • 完全复制:集群中的每个节点都可以使用完整的存档
  • 高可用性:Etcd可用于避免硬件的单点故障或网络问题
  • 一致性:每次读取都会返回跨多主机的最新写入
  • 简单:包括一个定义良好、面向用户的API(gRPC)
  • 安全:实现了带有可选的客户端证书身份验证的自动化TLS
  • 快速:每秒10000次写入的基准速度
  • 可靠:使用Raft算法实现了强一致、高可用的服务存储目录

    etcd应用场景

    服务发现

    服务发现要解决的也是分布式系统中最常见的问题之一,即在同一个分布式集群中的进程或服务,要如何才能找到对方并建立连接。本质上来说,服务发现就是想要了解集群中是否有进程在监听 udp 或 tcp 端口,并且通过名字就可以查找和连接。
    go操作etcd - 图1

    配置中心

    将一些配置信息放到 etcd 上进行集中管理。
    这类场景的使用方式通常是这样:应用在启动的时候主动从 etcd 获取一次配置信息,同时,在 etcd 节点上注册一个 Watcher 并等待,以后每次配置有更新的时候,etcd 都会实时通知订阅者,以此达到获取最新配置信息的目的。

    分布式锁

    因为 etcd 使用 Raft 算法保持了数据的强一致性,某次操作存储到集群中的值必然是全局一致的,所以很容易实现分布式锁。锁服务有两种使用方式,一是保持独占,二是控制时序。

  • 保持独占即所有获取锁的用户最终只有一个可以得到。etcd 为此提供了一套实现分布式锁原子操作 CAS(CompareAndSwap)的 API。通过设置prevExist值,可以保证在多个节点同时去创建某个目录时,只有一个成功。而创建成功的用户就可以认为是获得了锁。

  • 控制时序,即所有想要获得锁的用户都会被安排执行,但是获得锁的顺序也是全局唯一的,同时决定了执行顺序。etcd 为此也提供了一套 API(自动创建有序键),对一个目录建值时指定为POST动作,这样 etcd 会自动在目录下生成一个当前最大的值为键,存储这个新的值(客户端编号)。同时还可以使用 API 按顺序列出所有当前目录下的键值。此时这些键的值就是客户端的时序,而这些键中存储的值可以是代表客户端的编号。

go操作etcd - 图2

为什么用 etcd 而不用ZooKeeper?

etcd 实现的这些功能,ZooKeeper都能实现。那么为什么要用 etcd 而非直接使用ZooKeeper呢?

为什么不选择ZooKeeper?

  1. 部署维护复杂,其使用的Paxos强一致性算法复杂难懂。官方只提供了JavaC两种语言的接口。
  2. 使用Java编写引入大量的依赖。运维人员维护起来比较麻烦。
  3. 最近几年发展缓慢,不如etcdconsul等后起之秀。

    为什么选择etcd?

  4. 简单。使用 Go 语言编写部署简单;支持HTTP/JSON API,使用简单;使用 Raft 算法保证强一致性让用户易于理解。

  5. etcd 默认数据一更新就进行持久化。
  6. etcd 支持 SSL 客户端安全认证。

最后,etcd 作为一个年轻的项目,正在高速迭代和开发中,这既是一个优点,也是一个缺点。优点是它的未来具有无限的可能性,缺点是无法得到大项目长时间使用的检验。然而,目前 CoreOSKubernetesCloudFoundry等知名项目均在生产环境中使用了etcd,所以总的来说,etcd值得你去尝试。

etcd集群

etcd 作为一个高可用键值存储系统,天生就是为集群化而设计的。由于 Raft 算法在做决策时需要多数节点的投票,所以 etcd 一般部署集群推荐奇数个节点,推荐的数量为 3、5 或者 7 个节点构成一个集群。

搭建一个3节点集群示例:

在每个etcd节点指定集群成员,为了区分不同的集群最好同时配置一个独一无二的token。
下面是提前定义好的集群信息,其中n1n2n3表示3个不同的etcd节点。

  1. TOKEN=token-01
  2. CLUSTER_STATE=new
  3. CLUSTER=n1=http://10.240.0.17:2380,n2=http://10.240.0.18:2380,n3=http://10.240.0.19:2380

n1这台机器上执行以下命令来启动etcd:

  1. etcd --data-dir=data.etcd --name n1 \
  2. --initial-advertise-peer-urls http://10.240.0.17:2380 --listen-peer-urls http://10.240.0.17:2380 \
  3. --advertise-client-urls http://10.240.0.17:2379 --listen-client-urls http://10.240.0.17:2379 \
  4. --initial-cluster ${CLUSTER} \
  5. --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

n2这台机器上执行以下命令启动etcd:

  1. etcd --data-dir=data.etcd --name n2 \
  2. --initial-advertise-peer-urls http://10.240.0.18:2380 --listen-peer-urls http://10.240.0.18:2380 \
  3. --advertise-client-urls http://10.240.0.18:2379 --listen-client-urls http://10.240.0.18:2379 \
  4. --initial-cluster ${CLUSTER} \
  5. --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

n3这台机器上执行以下命令启动etcd:

  1. etcd --data-dir=data.etcd --name n3 \
  2. --initial-advertise-peer-urls http://10.240.0.19:2380 --listen-peer-urls http://10.240.0.19:2380 \
  3. --advertise-client-urls http://10.240.0.19:2379 --listen-client-urls http://10.240.0.19:2379 \
  4. --initial-cluster ${CLUSTER} \
  5. --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

etcd 官网提供了一个可以公网访问的 etcd 存储地址。你可以通过如下命令得到 etcd 服务的目录,并把它作为-discovery参数使用。

  1. curl https://discovery.etcd.io/new?size=3
  2. https://discovery.etcd.io/a81b5818e67a6ea83e9d4daea5ecbc92
  3. # grab this token
  4. TOKEN=token-01
  5. CLUSTER_STATE=new
  6. DISCOVERY=https://discovery.etcd.io/a81b5818e67a6ea83e9d4daea5ecbc92
  7. etcd --data-dir=data.etcd --name n1 \
  8. --initial-advertise-peer-urls http://10.240.0.17:2380 --listen-peer-urls http://10.240.0.17:2380 \
  9. --advertise-client-urls http://10.240.0.17:2379 --listen-client-urls http://10.240.0.17:2379 \
  10. --discovery ${DISCOVERY} \
  11. --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
  12. etcd --data-dir=data.etcd --name n2 \
  13. --initial-advertise-peer-urls http://10.240.0.18:2380 --listen-peer-urls http://10.240.0.18:2380 \
  14. --advertise-client-urls http://10.240.0.18:2379 --listen-client-urls http://10.240.0.18:2379 \
  15. --discovery ${DISCOVERY} \
  16. --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}
  17. etcd --data-dir=data.etcd --name n3 \
  18. --initial-advertise-peer-urls http://10.240.0.19:2380 --listen-peer-urls http://10.240.0.19:2380 \
  19. --advertise-client-urls http://10.240.0.19:2379 --listen-client-urls http:/10.240.0.19:2379 \
  20. --discovery ${DISCOVERY} \
  21. --initial-cluster-state ${CLUSTER_STATE} --initial-cluster-token ${TOKEN}

到此etcd集群就搭建起来了,可以使用etcdctl来连接etcd。

  1. export ETCDCTL_API=3
  2. HOST_1=10.240.0.17
  3. HOST_2=10.240.0.18
  4. HOST_3=10.240.0.19
  5. ENDPOINTS=$HOST_1:2379,$HOST_2:2379,$HOST_3:2379
  6. etcdctl --endpoints=$ENDPOINTS member list

Go语言操作etcd

这里使用官方的etcd/clientv3包来连接etcd并进行相关操作。

安装

  1. go get go.etcd.io/etcd/clientv3

put和get操作

put命令用来设置键值对数据,get命令用来根据key获取值。

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "time"
  6. "go.etcd.io/etcd/clientv3"
  7. )
  8. // etcd client put/get demo
  9. // use etcd/clientv3
  10. func main() {
  11. cli, err := clientv3.New(clientv3.Config{
  12. Endpoints: []string{"127.0.0.1:2379"},
  13. DialTimeout: 5 * time.Second,
  14. })
  15. if err != nil {
  16. // handle error!
  17. fmt.Printf("connect to etcd failed, err:%v\n", err)
  18. return
  19. }
  20. fmt.Println("connect to etcd success")
  21. defer cli.Close()
  22. // put
  23. ctx, cancel := context.WithTimeout(context.Background(), time.Second)
  24. _, err = cli.Put(ctx, "q1mi", "dsb")
  25. cancel()
  26. if err != nil {
  27. fmt.Printf("put to etcd failed, err:%v\n", err)
  28. return
  29. }
  30. // get
  31. ctx, cancel = context.WithTimeout(context.Background(), time.Second)
  32. resp, err := cli.Get(ctx, "q1mi")
  33. cancel()
  34. if err != nil {
  35. fmt.Printf("get from etcd failed, err:%v\n", err)
  36. return
  37. }
  38. for _, ev := range resp.Kvs {
  39. fmt.Printf("%s:%s\n", ev.Key, ev.Value)
  40. }
  41. }

watch操作

watch用来获取未来更改的通知。

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "time"
  6. "go.etcd.io/etcd/clientv3"
  7. )
  8. // watch demo
  9. func main() {
  10. cli, err := clientv3.New(clientv3.Config{
  11. Endpoints: []string{"127.0.0.1:2379"},
  12. DialTimeout: 5 * time.Second,
  13. })
  14. if err != nil {
  15. fmt.Printf("connect to etcd failed, err:%v\n", err)
  16. return
  17. }
  18. fmt.Println("connect to etcd success")
  19. defer cli.Close()
  20. // watch key:q1mi change
  21. rch := cli.Watch(context.Background(), "q1mi") // <-chan WatchResponse
  22. for wresp := range rch {
  23. for _, ev := range wresp.Events {
  24. fmt.Printf("Type: %s Key:%s Value:%s\n", ev.Type, ev.Kv.Key, ev.Kv.Value)
  25. }
  26. }
  27. }

将上面的代码保存编译执行,此时程序就会等待etcd中q1mi这个key的变化。
例如:我们打开终端执行以下命令修改、删除、设置q1mi这个key。

  1. etcd> etcdctl.exe --endpoints=http://127.0.0.1:2379 put q1mi "dsb2"
  2. OK
  3. etcd> etcdctl.exe --endpoints=http://127.0.0.1:2379 del q1mi
  4. 1
  5. etcd> etcdctl.exe --endpoints=http://127.0.0.1:2379 put q1mi "dsb3"
  6. OK

上面的程序都能收到如下通知。

  1. watch>watch.exe
  2. connect to etcd success
  3. Type: PUT Key:q1mi Value:dsb2
  4. Type: DELETE Key:q1mi Value:
  5. Type: PUT Key:q1mi Value:dsb3

lease租约

  1. package main
  2. import (
  3. "fmt"
  4. "time"
  5. )
  6. // etcd lease
  7. import (
  8. "context"
  9. "log"
  10. "go.etcd.io/etcd/clientv3"
  11. )
  12. func main() {
  13. cli, err := clientv3.New(clientv3.Config{
  14. Endpoints: []string{"127.0.0.1:2379"},
  15. DialTimeout: time.Second * 5,
  16. })
  17. if err != nil {
  18. log.Fatal(err)
  19. }
  20. fmt.Println("connect to etcd success.")
  21. defer cli.Close()
  22. // 创建一个5秒的租约
  23. resp, err := cli.Grant(context.TODO(), 5)
  24. if err != nil {
  25. log.Fatal(err)
  26. }
  27. // 5秒钟之后, /nazha/ 这个key就会被移除
  28. _, err = cli.Put(context.TODO(), "/nazha/", "dsb", clientv3.WithLease(resp.ID))
  29. if err != nil {
  30. log.Fatal(err)
  31. }
  32. }

keepAlive

  1. package main
  2. import (
  3. "context"
  4. "fmt"
  5. "log"
  6. "time"
  7. "go.etcd.io/etcd/clientv3"
  8. )
  9. // etcd keepAlive
  10. func main() {
  11. cli, err := clientv3.New(clientv3.Config{
  12. Endpoints: []string{"127.0.0.1:2379"},
  13. DialTimeout: time.Second * 5,
  14. })
  15. if err != nil {
  16. log.Fatal(err)
  17. }
  18. fmt.Println("connect to etcd success.")
  19. defer cli.Close()
  20. resp, err := cli.Grant(context.TODO(), 5)
  21. if err != nil {
  22. log.Fatal(err)
  23. }
  24. _, err = cli.Put(context.TODO(), "/nazha/", "dsb", clientv3.WithLease(resp.ID))
  25. if err != nil {
  26. log.Fatal(err)
  27. }
  28. // the key 'foo' will be kept forever
  29. ch, kaerr := cli.KeepAlive(context.TODO(), resp.ID)
  30. if kaerr != nil {
  31. log.Fatal(kaerr)
  32. }
  33. for {
  34. ka := <-ch
  35. fmt.Println("ttl:", ka.TTL)
  36. }
  37. }

基于etcd实现分布式锁

go.etcd.io/etcd/clientv3/concurrency在etcd之上实现并发操作,如分布式锁、屏障和选举。
导入该包:

  1. import "go.etcd.io/etcd/clientv3/concurrency"

基于etcd实现的分布式锁示例:

  1. cli, err := clientv3.New(clientv3.Config{Endpoints: endpoints})
  2. if err != nil {
  3. log.Fatal(err)
  4. }
  5. defer cli.Close()
  6. // 创建两个单独的会话用来演示锁竞争
  7. s1, err := concurrency.NewSession(cli)
  8. if err != nil {
  9. log.Fatal(err)
  10. }
  11. defer s1.Close()
  12. m1 := concurrency.NewMutex(s1, "/my-lock/")
  13. s2, err := concurrency.NewSession(cli)
  14. if err != nil {
  15. log.Fatal(err)
  16. }
  17. defer s2.Close()
  18. m2 := concurrency.NewMutex(s2, "/my-lock/")
  19. // 会话s1获取锁
  20. if err := m1.Lock(context.TODO()); err != nil {
  21. log.Fatal(err)
  22. }
  23. fmt.Println("acquired lock for s1")
  24. m2Locked := make(chan struct{})
  25. go func() {
  26. defer close(m2Locked)
  27. // 等待直到会话s1释放了/my-lock/的锁
  28. if err := m2.Lock(context.TODO()); err != nil {
  29. log.Fatal(err)
  30. }
  31. }()
  32. if err := m1.Unlock(context.TODO()); err != nil {
  33. log.Fatal(err)
  34. }
  35. fmt.Println("released lock for s1")
  36. <-m2Locked
  37. fmt.Println("acquired lock for s2")

输出:

  1. acquired lock for s1
  2. released lock for s1
  3. acquired lock for s2

查看文档了解更多

其他操作

其他操作请查看etcd/clientv3官方文档
参考链接: