ETCD快速入门-03 常用命令

编程语言 2022-08-14 19:49:55 阅读次数: 0

3. ETCD 常用命令

etcdctl是一个 命令行的客户端 ，它提供了一些命令，可以方便我们在对服务进行测试或者手动修改数据库内容。etcdctl与kubectl和systemctl的命令原理及操作类似，其基本用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl [<span style="color:#333333"><strong>global</strong></span> <span style="color:#333333"><strong>options</strong></span>] <span style="color:#333333"><strong>command</strong></span> [<span style="color:#333333"><strong>command</strong></span> <span style="color:#333333"><strong>options</strong></span>] [<span style="color:#333333"><strong>args</strong></span>...]</span></span>

具体的命令选项参数可以通过 etcdctl command --help来获取相关帮助

etcd 在键的组织上采用了层次化的空间结构（类似于文件系统中目录的概念），数据库操作围绕对 键值 和 目录 的 CRUD完成生命周期的管理。

若需要指定集群，可以在 ~/.bashrc 添加以下内容：

<span style="color:#444444"><span style="background-color:#f6f6f6">HOST_1=127.0.0.1:23791
HOST_2=127.0.0.1:23792
HOST_3=127.0.0.1:23793
ENDPOINTS=<span style="color:#bc6060">${HOST_1}</span>,<span style="color:#bc6060">${HOST_2}</span>,<span style="color:#bc6060">${HOST_3}</span>
<span style="color:#888888"># 如果需要使用原生命令，在命令开头加一个\ 例如：\etcdctl command</span>
<span style="color:#397300">alias</span> etcdctl=<span style="color:#880000">"etcdctl --endpoints=<span style="color:#bc6060">${ENDPOINTS}</span>"</span>
<span style="color:#397300">alias</span> etcdctljson=<span style="color:#880000">"etcdctl --endpoints=<span style="color:#bc6060">${ENDPOINTS}</span> --write-out=json"</span>
<span style="color:#397300">alias</span> etcdctltable=<span style="color:#880000">"etcdctl --endpoints=<span style="color:#bc6060">${ENDPOINTS}</span> --write-out=table"</span></span></span>

以上添加完成后，source一下使其生效

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>source</strong></span> ~/.bashrc</span></span>

3.1 查看etcd版本

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> version</span></span>

3.2 集群相关操作

3.2.1 指定etcd集群

<span style="color:#444444"><span style="background-color:#f6f6f6">HOST_1=<span style="color:#880000">127.0</span><span style="color:#880000">.0</span><span style="color:#880000">.1</span>
ENDPOINTS=${HOST_1}:<span style="color:#880000">2379</span>
etcdctl --endpoints=${ENDPOINTS} member <span style="color:#333333"><strong>list</strong></span> -w table</span></span>

3.2.2 查看集群健康状态

集群状态主要是 etcdctl endpoint status 和 etcdctl endpoint health 两条命令

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> --endpoints=<span style="color:#bc6060">${ENDPOINTS}</span> endpoint status -w table
etcdctl --endpoints=<span style="color:#bc6060">${ENDPOINTS}</span> endpoint health -w table</span></span>

3.2.3 添加成员

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl member <span style="color:#397300">add</span> <span style="color:#bc6060"><memberName></span> [<span style="color:#333333"><strong>options</strong></span>] [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 示例：将目标节点etcd4添加到集群</span>
etcdctl member add etcd4 http:<span style="color:#bc6060">//</span><span style="color:#880000">192.168</span>.<span style="color:#880000">3.104</span>:<span style="color:#880000">2380</span>
<span style="color:#888888"># 启动目标集群时需要设置启动参数如下</span>
etcd --name=etcd4 --data-dir=<span style="color:#bc6060">/etcd-data \
  --listen-peer-urls=http:/</span><span style="color:#bc6060">/192.168.3.104:2380 \
  --listen-client-urls=http:/</span><span style="color:#bc6060">/192.168.3.104:2379 \
  --initial-advertise-peer-urls=http:/</span><span style="color:#bc6060">/192.168.3.104:2380 \
  --advertise-client-urls=http:/</span><span style="color:#bc6060">/192.168.3.104:2379 \
  --initial-cluster=etcd1=http:/</span><span style="color:#bc6060">/192.168.3.101:2380,etcd2=http:/</span><span style="color:#bc6060">/192.168.3.102:2380,etcd3=http:/</span><span style="color:#bc6060">/192.168.3.103:2380,etcd4=http:/</span><span style="color:#bc6060">/192.168.3.104:2380 \
  --initial-cluster-state=existing</span></span></span>

3.2.4 更新成员

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl member <span style="color:#333333"><strong>update</strong></span> <span style="color:#bc6060"><memberID></span> [<span style="color:#333333"><strong>options</strong></span>] [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl member <span style="color:#333333"><strong>update</strong></span> ade526d28b1f92f7 <span style="color:#888888">--peer-urls=http://192.168.3.111:2380</span></span></span>

3.2.5 删除成员

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl member <span style="color:#397300">remove</span> <span style="color:#bc6060"><memberID></span> [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> member remove ade526d28b1f92f7</span></span>

3.3 数据库操作命令

3.3.1 put

添加一个键值，基本用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl <span style="color:#333333"><strong>put</strong></span> [<span style="color:#333333"><strong>options</strong></span>] <span style="color:#bc6060"><key></span> <span style="color:#bc6060"><value></span> [flags]</span></span>

常用参数如下所示：

参数 功能描述
--prev-kv 输出修改前的键值

注意事项如下所示：

  • 其中value接受从stdin的输入内容
  • 如果value是以横线 - 开始，将会被视为flag，如果不希望出现这种情况，可以使用两个横线代替 --
  • 若键已经存在，则进行更新并覆盖原有值，若不存在，则进行添加

3.3.2 get

查询键值，基本用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl <span style="color:#397300">get</span> [<span style="color:#333333"><strong>options</strong></span>] <span style="color:#bc6060"><key></span> [range_end] [flags]</span></span>

常用参数如下所示：

参数 功能描述
--hex 以十六进制形式输出
--limit number 设置输出结果的最大值
--prefix 根据prefix进行匹配key
--order 对输出结果进行排序，ASCEND 或 DESCEND
--sort-by 按给定字段排序，CREATE, KEY, MODIFY, VALUE, VERSION
--print-value-only 仅输出value值
--from-key 按byte进行比较，获取大于等于指定key的结果
--keys-only 仅获取keys

3.3.3 del

删除键值，基本用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl <span style="color:#333333"><strong>del</strong></span> <span style="color:#bc6060">[options]</span> <key> <span style="color:#bc6060">[range_end]</span> <span style="color:#bc6060">[flags]</span></span></span>

常用参数如下所示：

参数 功能描述
--prefix 根据prefix进行匹配删除
--prev-kv 输出删除的键值
--from-key 按byte进行比较，删除大于等于指定key的结果

3.4 租约相关命令

租约具有生命周期，需要为租约授予一个TTL(time to live)，将租约绑定到一个key上，则key的生命周期与租约一致，可续租，可撤销租约。其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease <subcommand> [flags]</span></span>

3.4.1 添加租约

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease grant <ttl> [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease grant <span style="color:#880000">600</span></span></span>

3.4.2 列出租约

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease list [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease list</span></span>

3.4.3 删除租约

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease revoke <leaseID> [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease revoke 694d81417acd4754</span></span>

3.4.4 查看租约详情

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl lease timetolive <span style="color:#bc6060"><leaseID></span> [<span style="color:#333333"><strong>options</strong></span>] [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease timetolive 694d81417acd4759</span></span>

3.4.5 租约续约

主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl lease keep-alive [<span style="color:#333333"><strong>options</strong></span>] <span style="color:#bc6060"><leaseID></span> [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> lease keep-alive 694d81417acd4757</span></span>

3.5 watch命令

watch是监听键或前缀发生改变的事件流， 主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> <span style="color:#333333"><strong>watch</strong></span> <span style="color:#bc6060">[options]</span> <span style="color:#bc6060">[key or prefix]</span> <span style="color:#bc6060">[range_end]</span> <span style="color:#bc6060">[--]</span> <span style="color:#bc6060">[exec-command arg1 arg2 ...]</span> <span style="color:#bc6060">[flags]</span></span></span>

示例如下所示：

# 对某个key监听操作，当key1发生改变时，会返回最新值
etcdctl watch name
# 监听key前缀
etcdctl watch name --prefix
# 监听到改变后执行相关操作
etcdctl watch name --  etcdctl get age

etcdctl watch name -- etcdctl put name Kevin，如果写成，会不会变成死循环，导致无限监视，尽量避免。

3.6 备份和恢复

主要用于管理节点的快照，其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> snapshot <subcommand> [flags]</span></span>

3.6.1 生成快照

其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> snapshot save <filename> [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> snapshot save Surpass.db</span></span>

3.6.2 查看快照

其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> snapshot status <filename> [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl snapshot status Surpass.db -w <span style="color:#397300">table</span></span></span>

3.6.3 恢复快照

其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl snapshot restore <span style="color:#bc6060"><filename></span> [<span style="color:#333333"><strong>options</strong></span>] [flags]</span></span>

示例如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6">etcdctl snapshot <span style="color:#333333"><strong>restore</strong></span> Surpass.db \
<span style="color:#888888">--name=default \</span>
<span style="color:#888888">--data-dir=/home/etcd_db \</span>
<span style="color:#888888">--initial-advertise-peer-urls=http://localhost:2380</span></span></span>

3.7 查看告警

如果内部出现问题，会触发告警，可以通过命令查看告警引起原因，命令如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> alarm <subcommand> [flags]</span></span>

常用的子命令主要有两个：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 查看所有告警</span>
etcdctl <span style="color:#333333"><strong>alarm</strong></span> list
<span style="color:#888888"># 解除所有告警</span>
etcdctl <span style="color:#333333"><strong>alarm</strong></span> disarm</span></span>

3.8 用户权限

etcd默认是没有开启访问控制的，如果开启外网访问etcd的话就需要考虑访问控制的问题，etcd提供了两种访问控制的方式：

  • 基于身份验证的访问控制
  • 基于证书的访问控制

etcd有一个特殊用户root和一个特殊角色root：

  • root用户 ：root用户是etcd的超级管理员，拥有etcd的所有权限，在开启角色认证之前为们必须要先建立好root用户
  • root角色 ：具有该root角色的用户既具有全局读写访问权限，具有更新集群的身份验证配置的权限。此外，该root角色还授予常规集群维护的特权，包括修改集群成员资格，对存储进行碎片整理以及拍摄快照。

etcd的权限资源：

  • Users : user用来设置身份认证(user:passwd)，一个用户可以拥有多个角色，每个角色被分配一定的权限(只读、只写、可读写)，用户分为root用户和非root用户。
  • Roles : 角色用来关联权限，角色主要三类：
    root角色:默认创建root用户时即创建了root角色，该角色拥有所有权限；
    guest角色:默认自动创建，主要用于非认证使用。普通角色，
    由root用户创建角色，并分配指定权限。
  • Permissions : 权限分为只读、只写、可读写三种权限，权限即对指定目录或key的读写权限。

如果没有指定任何验证方式，即未显示指定以什么用户进行访问，那么默认会设定为 guest 角色。默认情况下 guest 也是具有全局访问权限的

3.8.1 用户管理

其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> user <subcommand> [flags]</span></span>

其主要子命令主要如下所示：

子命令 常用用法 功能描述
add etcdctl user add < user name or user:password > [options] [flags] 添加新用户
delete etcdctl user delete < user name > [flags] 删除用户
list etcdctl user list [flags] 列出所有用户
get etcdctl user get < user name > [options] [flags] 获取用户详细信息
passwd etcdctl user passwd < user name > [options] [flags] 修改密码
grant-role etcdctl user grant-role < user name > < role name > [flags] 赋予用户角色
revoke-role etcdctl user revoke-role < user name > < role name > [flags] 删除用户角色

3.8.2 角色管理

其主要用法如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#333333"><strong>etcdctl</strong></span> role <subcommand> [flags]</span></span>

其主要子命令主要如下所示：

子命令 常用用法 功能描述
add etcdctl role add < role name > [flags] 添加角色
delete etcdctl role delete <role name > [flags] 删除角色
list etcdctl role list [flags] 列出所有角色
get etcdctl role get <role name > [flags] 获取角色详情
grant-permission etcdctl role grant-permission [options] < role name > < permission type > < key > [endkey] [flags] 把key操作权限授予给一个角色
revoke-permission etcdctl role revoke-permission < role name > < key > [endkey] [flags] 从角色中撤销key操作权限

3.8.3 开启root身份验证

在开启身份验证后，注意事项如下所示：

  • 开启身份验证：

所有etcdctl命令操作都需要指定用户参数 --user ，参数值为 用户名:密码

  • 开启证书验证：

所有etcdctl命令操作都需要添加证书参数 --cacert

开启root身份验证的步骤如下所示：

<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 添加root 用户，密码为surpass</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> <span style="color:#333333"><strong>add</strong></span> root:surpass
<span style="color:#888888"># 开启身份验证，开启为enable，取消为disable</span>
etcdctl auth enable
<span style="color:#888888"># 在开启身份验证后，需要带user相关信息</span>
etcdctl get name --<span style="color:#333333"><strong>user</strong></span>=root:surpass</span></span>

3.8.4 角色授权

在开启了root身份验证后，就可以对普通用户和角色操作了。

  • 1.用户增删改查
<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 增加普通用户</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> <span style="color:#333333"><strong>add</strong></span> surpass:surpass --user=root:surpass
<span style="color:#888888"># 获取用户信息</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> get surpass --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 查看所有用户</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> list --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 修改用户密码</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> passwd surpass --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 删除用户</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> delete surpass --<span style="color:#333333"><strong>user</strong></span>=root:surpass</span></span>
  • 2.角色增删改查
<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 添加角色</span>
etcdctl role <span style="color:#333333"><strong>add</strong></span> etcd-test --user=root:surpass
<span style="color:#888888"># 获取角色详细信息</span>
etcdctl role get etcd-test --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 获取所有角色</span>
etcdctl role list --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 删除角色</span>
etcdctl role delete etcd-test --<span style="color:#333333"><strong>user</strong></span>=root:surpass</span></span>
  • 3.绑定和授权
<span style="color:#444444"><span style="background-color:#f6f6f6"><span style="color:#888888"># 授权角色只读（read）、只写(write)和读写(readwrite)权限</span>
<span style="color:#888888"># 按key进行授权</span>
etcdctl role grant-permission etcd-test readwrite name  --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 按key的prefix进行授权</span>
etcdctl role grant-permission etcd-test readwrite name --prefix=true --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 将授权绑定给指定用户</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> grant-role test etcd-test --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 撤消角色授权</span>
etcdctl role revoke-permission etcd-test name --<span style="color:#333333"><strong>user</strong></span>=root:surpass
<span style="color:#888888"># 撤消绑定授权</span>
etcdctl <span style="color:#333333"><strong>user</strong></span> revoke-role test etcd-test --<span style="color:#333333"><strong>user</strong></span>=root:surpass</span></span>

原文地址： https://www.jianshu.com/p/e861a428b90f

猜你喜欢

转载自blog.csdn.net/JHIII/article/details/126303136
今日推荐
周排行
阿里云服务器ECS开放8080端口
求正弦和余弦
链表倒数第n个节点
vue.js入门（13）实战demo
Java学习——day 15
My First Day in CSDN
Oracle11g 密码延迟认证导致library cache lock的情况分析
SAP ALV输出字段内容前增加空格
CloudFlare 推出免费 VPN 服务「Warp」，你懂的！
BUG(跑SLAM14-ch10)
每日归档
更多
2025-03-16(0)
2025-03-15(0)
2025-03-14(0)
2025-03-13(0)
2025-03-12(0)
2025-03-11(0)
2025-03-10(0)
2025-03-09(0)
2025-03-08(0)
2025-03-07(0)

代码天地 © 2018 codetd.com

境外服务器   最新电视剧2022