使用 etcdctl v2 · DOCKER

## 使用 etcdctl v2 `etcdctl` 是一个命令行客户端，它能提供一些简洁的命令，供用户直接跟 `etcd` 服务打交道，而无需基于 `HTTP API` 方式。这在某些情况下将很方便，例如用户对服务进行测试或者手动修改数据库内容。我们也推荐在刚接触 `etcd` 时通过 `etcdctl` 命令来熟悉相关的操作，这些操作跟 `HTTP API` 实际上是对应的。 `etcd` 项目二进制发行包中已经包含了 `etcdctl` 工具，没有的话，可以从 [github.com/coreos/etcd/releases](https://github.com/coreos/etcd/releases) 下载。 `etcdctl` 支持如下的命令，大体上分为数据库操作和非数据库操作两类，后面将分别进行解释。 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl -h</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">NAME:</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> etcdctl - A simple command line client for etcd.</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"></code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">USAGE:</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> etcdctl [global options] command [command options] [arguments...]</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"></code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">VERSION:</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> 2.0.0-rc.1</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"></code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">COMMANDS:</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> backup backup an etcd directory</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> mk make a new key with a given value</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> mkdir make a new directory</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> rm remove a key</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> rmdir removes the key if it is an empty directory or a key-value pair</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> get retrieve the value of a key</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> ls retrieve a directory</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> set set the value of a key</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> setdir create a new or existing directory</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> update update an existing key with a given value</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> updatedir update an existing directory</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> watch watch a key for changes</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> exec-watch watch a key for changes and exec an executable</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> member member add, remove and list subcommands</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> help, h Shows a list of commands or help for one command</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"></code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">GLOBAL OPTIONS:</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> --debug output cURL commands which can be used to reproduce the request</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> --no-sync don't synchronize cluster information before sending request</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> --output, -o 'simple' output response in the given format (`simple` or `json`)</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> --peers, -C a comma-delimited list of machine addresses in the cluster (default: "127.0.0.1:4001")</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> --cert-file identify HTTPS client using this SSL certificate file</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> --key-file identify HTTPS client using this SSL key file</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> --ca-file verify certificates of HTTPS-enabled servers using this CA bundle</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9"> --help, -h show help</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9"> --version, -v print the version</code></li> </ol> ``` ### 数据库操作数据库操作围绕对键值和目录的 CRUD （符合 REST 风格的一套操作：Create）完整生命周期的管理。 etcd 在键的组织上采用了层次化的空间结构（类似于文件系统中目录的概念），用户指定的键可以为单独的名字，如 `testkey`，此时实际上放在根目录 `/` 下面，也可以为指定目录结构，如 `cluster1/node2/testkey`，则将创建相应的目录结构。 *注：CRUD 即 Create, Read, Update, Delete，是符合 REST 风格的一套 API 操作。* #### set 指定某个键的值。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl set /testdir/testkey "Hello world"</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Hello world</code></li> </ol> ``` 支持的选项包括： ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--ttl '0' 该键值的超时时间（单位为秒），不配置（默认为 0）则永不超时</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--swap-with-value value 若该键现在的值是 value，则进行设置操作</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--swap-with-index '0' 若该键现在的索引值是指定索引，则进行设置操作</code></li> </ol> ``` #### get 获取指定键的值。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl set testkey hello</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">hello</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl update testkey world</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">world</code></li> </ol> ``` 当键不存在时，则会报错。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl get testkey2</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Error: 100: Key not found (/testkey2) [1]</code></li> </ol> ``` 支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--sort 对结果进行排序</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--consistent 将请求发给主节点，保证获取内容的一致性</code></li> </ol> ``` #### update 当键存在时，更新值内容。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl set testkey hello</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">hello</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl update testkey world</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">world</code></li> </ol> ``` 当键不存在时，则会报错。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl update testkey2 world</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Error: 100: Key not found (/testkey2) [1]</code></li> </ol> ``` 支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--ttl '0' 超时时间（单位为秒），不配置（默认为 0）则永不超时</code></li></ol> ``` #### rm 删除某个键值。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl rm testkey</code></li></ol> ``` 当键不存在时，则会报错。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl rm testkey2</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Error: 100: Key not found (/testkey2) [8]</code></li> </ol> ``` 支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--dir 如果键是个空目录或者键值对则删除</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--recursive 删除目录和所有子键</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--with-value 检查现有的值是否匹配</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--with-index '0' 检查现有的 index 是否匹配</code></li> </ol> ``` #### mk 如果给定的键不存在，则创建一个新的键值。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl mk /testdir/testkey "Hello world"</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Hello world</code></li> </ol> ``` 当键存在的时候，执行该命令会报错，例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl set testkey "Hello world"</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Hello world</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ ./etcdctl mk testkey "Hello world"</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Error: 105: Key already exists (/testkey) [2]</code></li> </ol> ``` 支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--ttl '0' 超时时间（单位为秒），不配置（默认为 0）则永不超时</code></li></ol> ``` #### mkdir 如果给定的键目录不存在，则创建一个新的键目录。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl mkdir testdir</code></li></ol> ``` 当键目录存在的时候，执行该命令会报错，例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl mkdir testdir</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl mkdir testdir</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">Error: 105: Key already exists (/testdir) [7]</code></li> </ol> ``` 支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--ttl '0' 超时时间（单位为秒），不配置（默认为 0）则永不超时</code></li></ol> ``` #### setdir 创建一个键目录，无论存在与否。支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--ttl '0' 超时时间（单位为秒），不配置（默认为 0）则永不超时</code></li></ol> ``` #### updatedir 更新一个已经存在的目录。支持的选项为 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--ttl '0' 超时时间（单位为秒），不配置（默认为 0）则永不超时</code></li></ol> ``` #### rmdir 删除一个空目录，或者键值对。若目录不空，会报错 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl set /dir/testkey hi</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">hi</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl rmdir /dir</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Error: 108: Directory not empty (/dir) [13]</code></li> </ol> ``` #### ls 列出目录（默认为根目录）下的键或者子目录，默认不显示子目录中内容。例如 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ ./etcdctl set testkey 'hi'</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">hi</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ ./etcdctl set dir/test 'hello'</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">hello</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ ./etcdctl ls</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">/testkey</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">/dir</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">$ ./etcdctl ls dir</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">/dir/test</code></li> </ol> ``` 支持的选项包括 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--sort 将输出结果排序</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--recursive 如果目录下有子目录，则递归输出其中的内容</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">-p 对于输出为目录，在最后添加 `/` 进行区分</code></li> </ol> ``` ### 非数据库操作 #### backup 备份 etcd 的数据。支持的选项包括 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--data-dir etcd 的数据目录</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--backup-dir 备份到指定路径</code></li> </ol> ``` #### watch 监测一个键值的变化，一旦键值发生更新，就会输出最新的值并退出。例如，用户更新 testkey 键值为 Hello world。 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl watch testkey</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">Hello world</code></li> </ol> ``` 支持的选项包括 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--forever 一直监测，直到用户按 `CTRL+C` 退出</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--after-index '0' 在指定 index 之前一直监测</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--recursive 返回所有的键值和子键值</code></li> </ol> ``` #### exec-watch 监测一个键值的变化，一旦键值发生更新，就执行给定命令。例如，用户更新 testkey 键值。 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl exec-watch testkey -- sh -c 'ls'</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">default.etcd</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">Documentation</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">etcd</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">etcdctl</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">etcd-migrate</code></li> <li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">README-etcdctl.md</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">README.md</code></li> </ol> ``` 支持的选项包括 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">--after-index '0' 在指定 index 之前一直监测</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">--recursive 返回所有的键值和子键值</code></li> </ol> ``` #### member 通过 list、add、remove 命令列出、添加、删除 etcd 实例到 etcd 集群中。例如本地启动一个 etcd 服务实例后，可以用如下命令进行查看。 ``` <pre class="prettyprint"><ol class="linenums"><li class="l"><code class="pcalibre10 pcalibre11 pcalibre9">$ etcdctl member list</code></li> <li class="l1"><code class="pcalibre10 pcalibre11 pcalibre9">ce2a822cea30bfca: name=default peerURLs=http://localhost:2380,http://localhost:7001 clientURLs=http://localhost:2379,http://localhost:4001</code></li> </ol> ``` ### 命令选项 - `--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 文件进行验证 - `--help, -h` 显示帮助命令信息 - `--version, -v` 打印版本信息