etcdctl使用手册

etcdctl使用手册

我们通过 etcdctl -help可以查看etcd客户端的一些指令与参数，下面让我们分析使用方式

COMMANDS

基本运行命令主要功能有，创建键、删除键、更新、监视等

get

etcdctl get [options] [range_end]

etcdctl --endpoints=$ENDPOINTS get web

例子意思为获取键位web的值

• –prefix 前缀匹配键来查询值 （比如 key有web1，web2，web3，那么可以get web --prefix）
• –limit 最大显示数，比如上面这个例子 如果设置1，那么只显示web1，如果设置2，就显示web1、web2
• –order ASCEND|DESCEND 按照值进行排序，默认为ASCEND
• –rev=0 指定kv版本
• –sort-by 排序目标；创建、键、修改、值或版本 与order结合控制正序反序
• –from-key 例子etcdctl get fooa --from-key ，作用是获取比fooa键大或等于的键的值
• –keys-only 只获取键
• –print-value-only 只获取值

在get之前使用一些全局遍历可以有不一样的效果，比如–write-out 可以设置输出的格式比如json、字段、protobuf、simple、table

put

添加键值，如果键存在则替换值，put中的value可以使用标准输入的值比如cat file | put

• –ignore-lease[=false] 使用当前租约更新密钥

• –ignore-value[=false] 使用当前值更新键

• –lease=“0” 使用租约的ID值 在创建租约时返回的ID值

• –prev-kv[=false] 返回修改前的上一个键值对

​

del

删除指定的键或键范围

• –from-key[=false] 作用与上文一致
• –prefix[=false] 作用于上文一致
• –prev-kv[=false] 返回已删除的键值对

txn

在一个事务中处理所有请求

-i, --interactive[=false] 交互模式下输入事务

watch

监视值发生变化

etcdctl  watch foo

• –prefix[=false] 与上文一致，监视前缀key
• –prev-kv[=false] 获取值变化前的值
• –rev=0 监视起始版本

lease

对租约进行操作，租约创建后需要与键进行绑定。

etcdctl --endpoints=$ENDPOINTS put sample value --lease=2be7547fbc6a5afa

etcdctl --endpoints=$ENDPOINTS lease keep-alive 2be7547fbc6a5afa

etcdctl --endpoints=$ENDPOINTS lease revoke 2be7547fbc6a5afa

• grant 创建租约 返回租约ID值
• revoke 撤销租约 后面跟租约ID值
• timetolive 获取租约信息
• list 列出所有活跃的租约
• keep-alive 保持租约有效（续订）

lock

创建分布式锁

etcdctl lock mutex1

• –ttl=10 锁超时时间

GLOBAL OPTIONS

全局参数，使用谷歌翻译，请自行判断

--cacert="" 使用此 CA 包验证启用 TLS 的安全服务器的证书
      --cert="" 使用此 TLS 证书文件识别安全客户端
      --command-timeout=5s 短时间运行命令超时（不包括拨号超时）
      --debug[=false] 启用客户端调试日志
      --dial-timeout=2s 客户端连接拨号超时
  -d, --discovery-srv="" 用于查询描述集群端点的 SRV 记录的域名
      --endpoints=[127.0.0.1:2379] gRPC 端点
      --hex[=false] 将字节字符串打印为十六进制编码字符串
      --insecure-discovery[=true] 接受描述集群端点的不安全 SRV 记录
      --insecure-skip-tls-verify[=false] 跳过服务器证书验证
      --insecure-transport[=true] 禁用客户端连接的传输安全
      --keepalive-time=2s 客户端连接的保活时间
      --keepalive-timeout=6s 客户端连接的keepalive超时
      --key="" 使用此 TLS 密钥文件识别安全客户端
      --user="" username[:password] 用于身份验证（未提供密码时提示）
  -w, --write-out="simple" 设置输出格式（字段、json、protobuf、simple、table）