ETCD快速入门-03 常用命令

瑞星  金牌会员 | 2022-9-16 17:18:06 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 963|帖子 963|积分 2889

3. ETCD 常用命令

    etcdctl是一个命令行的客户端，它提供了一些命令，可以方便我们在对服务进行测试或者手动修改数据库内容。etcdctl与kubectl和systemctl的命令原理及操作类似，其基本用法如下所示：
  1. etcdctl [global options] command [command options] [args...]
复制代码
具体的命令选项参数可以通过 etcdctl command --help来获取相关帮助
    etcd 在键的组织上采用了层次化的空间结构（类似于文件系统中目录的概念），数据库操作围绕对键值和目录的 CRUD完成生命周期的管理。
    若需要指定集群，可以在~/.bashrc添加以下内容：
  1. HOST_1=127.0.0.1:23791
  2. HOST_2=127.0.0.1:23792
  3. HOST_3=127.0.0.1:23793
  4. ENDPOINTS=${HOST_1},${HOST_2},${HOST_3}
  5. # 如果需要使用原生命令，在命令开头加一个\ 例如：\etcdctl command
  6. alias etcdctl="etcdctl --endpoints=${ENDPOINTS}"
  7. alias etcdctljson="etcdctl --endpoints=${ENDPOINTS} --write-out=json"
  8. alias etcdctltable="etcdctl --endpoints=${ENDPOINTS} --write-out=table"
复制代码
    以上添加完成后，source一下使其生效
  1. source ~/.bashrc
复制代码
3.1 查看etcd版本
  1. etcdctl version
复制代码

3.2 集群相关操作

3.2.1 指定etcd集群
  1. HOST_1=127.0.0.1
  2. ENDPOINTS=${HOST_1}:2379
  3. etcdctl --endpoints=${ENDPOINTS} member list -w table
复制代码

3.2.2 查看集群健康状态

    集群状态主要是etcdctl endpoint status和etcdctl endpoint health两条命令
  1. etcdctl --endpoints=${ENDPOINTS} endpoint status -w table
  2. etcdctl --endpoints=${ENDPOINTS} endpoint health -w table
复制代码

3.2.3 添加成员

    主要用法如下所示：
  1. etcdctl member add <memberName> [options] [flags]
复制代码
    示例如下所示：
  1. # 示例：将目标节点etcd4添加到集群
  2. etcdctl member add etcd4 http://192.168.3.104:2380
  3. # 启动目标集群时需要设置启动参数如下
  4. etcd --name=etcd4 --data-dir=/etcd-data \
  5.   --listen-peer-urls=http://192.168.3.104:2380 \
  6.   --listen-client-urls=http://192.168.3.104:2379 \
  7.   --initial-advertise-peer-urls=http://192.168.3.104:2380 \
  8.   --advertise-client-urls=http://192.168.3.104:2379 \
  9.   --initial-cluster=etcd1=http://192.168.3.101:2380,etcd2=http://192.168.3.102:2380,etcd3=http://192.168.3.103:2380,etcd4=http://192.168.3.104:2380 \
  10.   --initial-cluster-state=existing
复制代码
3.2.4 更新成员

    主要用法如下所示：
  1. etcdctl member update <memberID> [options] [flags]
复制代码
    示例如下所示：
  1. etcdctl member update ade526d28b1f92f7 --peer-urls=http://192.168.3.111:2380
复制代码
3.2.5 删除成员

    主要用法如下所示：
  1. etcdctl member remove <memberID> [flags]
复制代码
    示例如下所示：
  1. etcdctl member remove ade526d28b1f92f7
复制代码
3.3 数据库操作命令

3.3.1 put

    添加一个键值，基本用法如下所示：
  1. etcdctl put [options] <key> <value> [flags]
复制代码
    常用参数如下所示：
参数功能描述--prev-kv输出修改前的键值    注意事项如下所示：

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

3.3.2 get

    查询键值，基本用法如下所示：
  1. etcdctl get [options] <key> [range_end] [flags]
复制代码
    常用参数如下所示：
参数功能描述--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

    删除键值，基本用法如下所示：
  1. etcdctl del [options] <key> [range_end] [flags]
复制代码
    常用参数如下所示：
参数功能描述--prefix根据prefix进行匹配删除--prev-kv输出删除的键值--from-key按byte进行比较，删除大于等于指定key的结果
3.4 租约相关命令

    租约具有生命周期，需要为租约授予一个TTL(time to live)，将租约绑定到一个key上，则key的生命周期与租约一致，可续租，可撤销租约。其主要用法如下所示：
  1. etcdctl lease <subcommand> [flags]
复制代码
3.4.1 添加租约

    主要用法如下所示：
  1. etcdctl lease grant <ttl> [flags]
复制代码
    示例如下所示：
  1. etcdctl lease grant 600
复制代码
3.4.2 列出租约

    主要用法如下所示：
  1. etcdctl lease list [flags]
复制代码
    示例如下所示：
  1. etcdctl lease list
复制代码
3.4.3 删除租约

    主要用法如下所示：
  1. etcdctl lease revoke <leaseID> [flags]
复制代码
    示例如下所示：
  1. etcdctl lease revoke 694d81417acd4754
复制代码
3.4.4 查看租约详情

    主要用法如下所示：
  1. etcdctl lease timetolive <leaseID> [options] [flags]
复制代码
    示例如下所示：
  1. etcdctl lease timetolive 694d81417acd4759
复制代码
3.4.5 租约续约

    主要用法如下所示：
  1. etcdctl lease keep-alive [options] <leaseID> [flags]
复制代码
    示例如下所示：
  1. etcdctl lease keep-alive 694d81417acd4757
复制代码
3.5 watch命令

    watch是监听键或前缀发生改变的事件流， 主要用法如下所示：
  1. etcdctl watch [options] [key or prefix] [range_end] [--] [exec-command arg1 arg2 ...] [flags]
复制代码
    示例如下所示：
  1. # 对某个key监听操作，当key1发生改变时，会返回最新值
  2. etcdctl watch name
  3. # 监听key前缀
  4. etcdctl watch name --prefix
  5. # 监听到改变后执行相关操作
  6. etcdctl watch name --  etcdctl get age
复制代码
etcdctl watch name --  etcdctl put name Kevin，如果写成，会不会变成死循环，导致无限监视，尽量避免。
3.6 备份和恢复

    主要用于管理节点的快照，其主要用法如下所示：
  1. etcdctl snapshot <subcommand> [flags]
复制代码
3.6.1 生成快照

    其主要用法如下所示：
  1. etcdctl snapshot save <filename> [flags]
复制代码
    示例如下所示：
  1. etcdctl snapshot save Surpass.db
复制代码
3.6.2 查看快照

    其主要用法如下所示：
  1. etcdctl snapshot status <filename> [flags]
复制代码
    示例如下所示：
  1. etcdctl snapshot status Surpass.db -w table
复制代码
3.6.3 恢复快照

    其主要用法如下所示：
  1. etcdctl snapshot restore <filename> [options] [flags]
复制代码
    示例如下所示：
  1. etcdctl snapshot restore Surpass.db \
  2. --name=default \
  3. --data-dir=/home/etcd_db \
  4. --initial-advertise-peer-urls=http://localhost:2380
复制代码
3.7 查看告警

    如果内部出现问题，会触发告警，可以通过命令查看告警引起原因，命令如下所示：
  1. etcdctl alarm <subcommand> [flags]
复制代码
    常用的子命令主要有两个：
  1. # 查看所有告警
  2. etcdctl alarm list
  3. # 解除所有告警
  4. etcdctl alarm disarm
复制代码
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 用户管理

    其主要用法如下所示：
  1. etcdctl user <subcommand> [flags]
复制代码
    其主要子命令主要如下所示：
子命令常用用法功能描述addetcdctl user add < user name or user:password > [options] [flags]添加新用户deleteetcdctl user delete < user name > [flags]删除用户listetcdctl user list [flags]列出所有用户getetcdctl user get < user name > [options] [flags]获取用户详细信息passwdetcdctl user passwd < user name > [options] [flags]修改密码grant-roleetcdctl user grant-role < user name > < role name > [flags]赋予用户角色revoke-roleetcdctl user revoke-role < user name > < role name > [flags]删除用户角色3.8.2 角色管理

    其主要用法如下所示：
  1. etcdctl role <subcommand> [flags]
复制代码
    其主要子命令主要如下所示：
子命令常用用法功能描述addetcdctl role add < role name > [flags]添加角色deleteetcdctl role delete  [flags]删除角色listetcdctl role list [flags]列出所有角色getetcdctl role get  [flags]获取角色详情grant-permissionetcdctl role grant-permission [options] < role name > < permission type > < key > [endkey] [flags]把key操作权限授予给一个角色revoke-permissionetcdctl role revoke-permission < role name > < key > [endkey] [flags]从角色中撤销key操作权限3.8.3 开启root身份验证

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

  • 开启身份验证：
所有etcdctl命令操作都需要指定用户参数--user，参数值为用户名:密码


  • 开启证书验证：
所有etcdctl命令操作都需要添加证书参数--cacert
    开启root身份验证的步骤如下所示：
  1. # 添加root 用户，密码为surpass
  2. etcdctl user add root:surpass
  3. # 开启身份验证，开启为enable，取消为disable
  4. etcdctl auth enable
  5. # 在开启身份验证后，需要带user相关信息
  6. etcdctl get name --user=root:surpass
复制代码
3.8.4 角色授权

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

  • 1.用户增删改查
  1. # 增加普通用户
  2. etcdctl user add surpass:surpass --user=root:surpass
  3. # 获取用户信息
  4. etcdctl user get surpass --user=root:surpass
  5. # 查看所有用户
  6. etcdctl user list --user=root:surpass
  7. # 修改用户密码
  8. etcdctl user passwd surpass --user=root:surpass
  9. # 删除用户
  10. etcdctl user delete surpass --user=root:surpass
复制代码

  • 2.角色增删改查
  1. # 添加角色
  2. etcdctl role add etcd-test --user=root:surpass
  3. # 获取角色详细信息
  4. etcdctl role get etcd-test --user=root:surpass
  5. # 获取所有角色
  6. etcdctl role list --user=root:surpass
  7. # 删除角色
  8. etcdctl role delete etcd-test --user=root:surpass
复制代码

  • 3.绑定和授权
  1. # 授权角色只读（read）、只写(write)和读写(readwrite)权限
  2. # 按key进行授权
  3. etcdctl role grant-permission etcd-test readwrite name  --user=root:surpass
  4. # 按key的prefix进行授权
  5. etcdctl role grant-permission etcd-test readwrite name --prefix=true --user=root:surpass
  6. # 将授权绑定给指定用户
  7. etcdctl user grant-role test etcd-test --user=root:surpass
  8. # 撤消角色授权
  9. etcdctl role revoke-permission etcd-test name --user=root:surpass
  10. # 撤消绑定授权
  11. etcdctl user revoke-role test etcd-test --user=root:surpass
复制代码
原文地址：https://www.jianshu.com/p/e861a428b90f
本文同步在微信订阅号上发布，如各位小伙伴们喜欢我的文章，也可以关注我的微信订阅号：woaitest，或扫描下面的二维码添加关注：


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！

本帖子中包含更多资源

您需要 登录 才可以下载或查看，没有账号？立即注册

x
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

瑞星

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

运维 CIO 存储 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表