etcd基本操作

目录

• 概述
• 安装etcd
• 使用etcdctl操作etcd
  • 数据库操作
  • 非数据库操作
• 使用curl操作etcd

概述

etcd是一个用于共享配置和服务的高可用键值存储系统，由CoreOS使用开发并作为CoreOS的基础服务启动。etcd的灵感来源于Apache ZooKeeper和doozer，其特点：

• 简单：可用curl进行操作（HTTP+JSON）
• 安全：可使用SSL客户端证书验证
• 快速：基准测试在每个实例1000次写入每秒
• 可靠: 使用Raft协议来进行合理的分布式
  etcd是go语言写的，并使用Raft一致性算法来管理一个高可用的复制日志。

etcd 2.0之后，规范了端口号的使用，并且写入了IANA组织的标准端口记录。etcd将提供给外部客户端的端口变为2379，而etcd服务间通信的端口变为2380

安装etcd

etcd的安装非常简单，可以直接下载编译后的可执行文件，启动如下：

etcd -name etcd1 -data-dir /data/etcd --advertise-client-urls http://10.116.21.131:2379,http://127.0.0.1:2379 --listen-client-urls http://10.116.21.131:2379,http://127.0.0.1:2379

使用etcdctl操作etcd

需要说明的是，下面所有操作都是针对etcd2.0可用，etcd3.0的接口变动较大，尚未进行验证

数据库操作

1、set：设置键值

#支持的选项：
    --ttl "0"    #该键值的超时时间，单位为s，默认为0，永不超时
    --swap-with-value value    #若该键现在的值为value，则进行设置操作
    --swap-with-index '0'    #若该键现在的索引值是指定索引，则进行设置操作
    
#示例：
    etcdctl set /foo/bar "hello"    #设置/foo/bar的值为hello
    etcdctl set /foo/bar "hello" --ttl 60    #设置/foo/bar的值为hello，并且超时时间为60s
    etcdctl set /foo/bar "world" --swap-with-value "hello" #当/foo/bar的值为hello时，则设置/foo/bar的值为world，如果不为hello，则会抛出异常

2、mk：设置键的值，仅当该键不存在时设置 ，如果已存在，则抛出异常

etcdctl mk /foo/new_bar "hello"
#支持的选项：
    --ttl "0"

3、update：更新一个键的值，仅当该键存在时，如果不存在，则抛出异常

etcdctl update /foo/bar "world"
支持的选项：
    --ttl "0"    #单位为s，默认为0，永不超时

4、get：获取某个键的值，如果不存在，则抛出异常

etcdctl get /foo/bar
#支持的选项：
    --sort    #对结果进行排序
    --consistent    #将请求结果发给主节点，保证获取内容的一致性

5、rm：删除某个键值 ，如果键不存在，则抛出异常

etcdctl rm testkey
#支持的选项：
    --dir    #如果键是空目录或者键值对则删除
    --recursive    #删除目录和所有子键
    --with-value    #检查现有的值是否匹配,匹配时才删除
    --with-index '0'     #检查现有的index是否匹配

6、mkdir：如果给定的键目录不存在，则创建一个新的键目录，如果存在，则报错

etcdctl mkdir testdir
#支持的选项：
    --ttl "0"

7、setdir：创建一个键目录，无论存在与否。

etcdctl setdir testdir
#支持的选项：
    --ttl "0"

8、updatedir：更新一个已经存在的目录，如果不存在，则抛出异常

#支持的选项：
    --ttl "0"

9、rmdir：删除一个空目录或者键值对。如果目录不为空，则抛出异常

etcdctl rmdir /dir

10、ls：列出目录下的键或子目录，默认不显示子目录的内容

etcdctl set dir/test "hello"
etcdctl ls dir
#支持的选项：
    --sort    #将结果排序
    --recursive    #如果目录下有子目录，则递归输出子目录中的内容
    -p    #对于输出为目录的，在最后添加"/"进行区分

非数据库操作

1、backup：备份etcd数据

etcdctl backup --data-dir /data/etcd --backup-dir /data/backup/etcd
#支持的选项：
    --data-dir    #etcd的数据目录
    --backup-dir    #备份到指定路径

2、watch：监测一个键值的变化，一旦键值发生更新，就会输出最新的值并退出

etcdctl watch testkey
#支持的选项：
    --forever    #一直监测，直到用户按"Ctrl+C"退出
    --after-index '0'    #在指定index之前一直监测
    --recursive    #返回所有的键值和子键值

3、exec-watch：监测一个键值的变化 ，一旦键值发生更新，就执行给定的命令

etcdctl exec-watch testkey -- sh -c 'ls'
#支持的选项：
    --after-index "0"    #在指定的index前一直监测
    --recursive    #返回所有的值和子键值 

4、member：通过list、add、remove命令列出、添加、删除etcd实例到etcd集群中

etcdctl member list
#支持的选项：
    --debug     #输出 cURL 命令，显示执行命令的时候发起的请求
    --no-sync   #发出请求之前不同步集群信息
    --output, -o 'simple'   #输出内容的格式 (simple 为原始信息，json 为进行    json格式解码，易读性好一些)
    --peers, -C     #指定集群中的同伴信息，用逗号隔开 (默认为: "127.0.0.1:4001")
    --cert-file     #HTTPS 下客户端使用的 SSL 证书文件
    --key-file  #HTTPS 下客户端使用的 SSL 密钥文件
    --ca-file   #服务端使用 HTTPS 时，使用 CA 文件进行验证

使用curl操作etcd

1、set操作

curl -L http://127.0.0.1:2379/v2/keys/foo/bar -XPUT -d value="hello world"

2、get操作

curl -L http://127.0.0.1:2379/v2/keys/foo/bar

3、rm操作

curl -L http://127.0.0.1:2379/v2/keys/foo/bar -XDELETE
{
"action":"delete",
"node:{
    "key":"/foo/bar",
    "modifiedIndex":28,
    "createdIndex":27
    },
"prevNode":{
    "key":"/foo/bar",
    "value":"hi, etcd",
    "modifiedIndex":27,
    "createdIndex":27
    }
}

参考：
https://tonydeng.github.io/2015/11/24/etcd-the-first-using/
http://cizixs.com/2016/08/02/intro-to-etcd