使用 etcdctl v2

    etcd 项目二进制发行包中已经包含了 etcdctl 工具,没有的话,可以从 下载。

    etcdctl 支持如下的命令,大体上分为数据库操作和非数据库操作两类,后面将分别进行解释。

    数据库操作围绕对键值和目录的 CRUD (符合 REST 风格的一套操作:Create)完整生命周期的管理。

    etcd 在键的组织上采用了层次化的空间结构(类似于文件系统中目录的概念),用户指定的键可以为单独的名字,如 testkey,此时实际上放在根目录 / 下面,也可以为指定目录结构,如 cluster1/node2/testkey,则将创建相应的目录结构。

    注:CRUD 即 Create, Read, Update, Delete,是符合 REST 风格的一套 API 操作。

    指定某个键的值。例如

    1. $ etcdctl set /testdir/testkey "Hello world"
    2. Hello world

    支持的选项包括:

    1. --ttl '0' 该键值的超时时间(单位为秒),不配置(默认为 0)则永不超时
    2. --swap-with-value value 若该键现在的值是 value,则进行设置操作
    3. --swap-with-index '0' 若该键现在的索引值是指定索引,则进行设置操作

    get

    获取指定键的值。例如

    1. $ etcdctl set testkey hello
    2. hello
    3. $ etcdctl update testkey world
    4. world

    当键不存在时,则会报错。例如

    1. $ etcdctl get testkey2
    2. Error: 100: Key not found (/testkey2) [1]

    支持的选项为

    1. --sort 对结果进行排序
    2. --consistent 将请求发给主节点,保证获取内容的一致性

    update

    当键存在时,更新值内容。例如

    1. $ etcdctl set testkey hello
    2. hello
    3. world

    当键不存在时,则会报错。例如

    1. $ etcdctl update testkey2 world
    2. Error: 100: Key not found (/testkey2) [1]

    rm

    删除某个键值。例如

    当键不存在时,则会报错。例如

    1. $ etcdctl rm testkey2
    2. Error: 100: Key not found (/testkey2) [8]

    支持的选项为

    1. --dir 如果键是个空目录或者键值对则删除
    2. --recursive 删除目录和所有子键
    3. --with-value 检查现有的值是否匹配
    4. --with-index '0' 检查现有的 index 是否匹配

    如果给定的键不存在,则创建一个新的键值。例如

    1. $ etcdctl mk /testdir/testkey "Hello world"
    2. Hello world

    当键存在的时候,执行该命令会报错,例如

    1. $ etcdctl set testkey "Hello world"
    2. Hello world
    3. $ ./etcdctl mk testkey "Hello world"
    4. Error: 105: Key already exists (/testkey) [2]

    支持的选项为

    1. --ttl '0' 超时时间(单位为秒),不配置(默认为 0)则永不超时

    mkdir

    如果给定的键目录不存在,则创建一个新的键目录。例如

    1. $ etcdctl mkdir testdir

    当键目录存在的时候,执行该命令会报错,例如

    1. $ etcdctl mkdir testdir
    2. $ etcdctl mkdir testdir
    3. Error: 105: Key already exists (/testdir) [7]

    支持的选项为

    1. --ttl '0' 超时时间(单位为秒),不配置(默认为 0)则永不超时

    setdir

    创建一个键目录,无论存在与否。

    支持的选项为

    updatedir

    更新一个已经存在的目录。 支持的选项为

    1. --ttl '0' 超时时间(单位为秒),不配置(默认为 0)则永不超时

    若目录不空,会报错

    1. $ etcdctl set /dir/testkey hi
    2. hi
    3. $ etcdctl rmdir /dir
    4. Error: 108: Directory not empty (/dir) [13]

    ls

    列出目录(默认为根目录)下的键或者子目录,默认不显示子目录中内容。

    例如

    1. $ ./etcdctl set testkey 'hi'
    2. hi
    3. $ ./etcdctl set dir/test 'hello'
    4. hello
    5. $ ./etcdctl ls
    6. /dir
    7. /dir/test

    支持的选项包括

    1. --sort 将输出结果排序
    2. --recursive 如果目录下有子目录,则递归输出其中的内容
    3. -p 对于输出为目录,在最后添加 `/` 进行区分

    backup

    备份 etcd 的数据。

    支持的选项包括

    1. --data-dir etcd 的数据目录
    2. --backup-dir 备份到指定路径

    watch

    监测一个键值的变化,一旦键值发生更新,就会输出最新的值并退出。

    例如,用户更新 testkey 键值为 Hello world。

    1. $ etcdctl watch testkey
    2. Hello world

    支持的选项包括

    1. --forever 一直监测,直到用户按 `CTRL+C` 退出
    2. --after-index '0' 在指定 index 之前一直监测
    3. --recursive 返回所有的键值和子键值

    监测一个键值的变化,一旦键值发生更新,就执行给定命令。

    例如,用户更新 testkey 键值。

    1. $ etcdctl exec-watch testkey -- sh -c 'ls'
    2. default.etcd
    3. Documentation
    4. etcd
    5. etcdctl
    6. etcd-migrate
    7. README-etcdctl.md
    8. README.md

    支持的选项包括

    member

    例如本地启动一个 etcd 服务实例后,可以用如下命令进行查看。

    1. $ etcdctl member list
    2. ce2a822cea30bfca: name=default peerURLs=http://localhost:2380,http://localhost:7001 clientURLs=http://localhost:2379,http://localhost:4001
    • --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 文件进行验证
    • 显示帮助命令信息
    • --version, -v 打印版本信息