3. ETCD 常用命令

etcdctl是一個命令列的使用者端，它提供了一些命令，可以方便我們在對服務進行測試或者手動修改資料庫內容。etcdctl與kubectl和systemctl的命令原理及操作類似，其基本用法如下所示：

etcdctl [global options] command [command options] [args...]

具體的命令選項引數可以通過 etcdctl command --help來獲取相關幫助

etcd 在鍵的組織上採用了層次化的空間結構（類似於檔案系統中目錄的概念），資料庫操作圍繞對鍵值和目錄的 CRUD完成生命週期的管理。

若需要指定叢集，可以在~/.bashrc新增以下內容：

HOST_1=127.0.0.1:23791
HOST_2=127.0.0.1:23792
HOST_3=127.0.0.1:23793
ENDPOINTS=${HOST_1},${HOST_2},${HOST_3}
# 如果需要使用原生命令，在命令開頭加一個\ 例如：\etcdctl command
alias etcdctl="etcdctl --endpoints=${ENDPOINTS}"
alias etcdctljson="etcdctl --endpoints=${ENDPOINTS} --write-out=json"
alias etcdctltable="etcdctl --endpoints=${ENDPOINTS} --write-out=table"

以上新增完成後，source一下使其生效

source ~/.bashrc

3.1 檢視etcd版本

etcdctl version

3.2 叢集相關操作

3.2.1 指定etcd叢集

HOST_1=127.0.0.1
ENDPOINTS=${HOST_1}:2379
etcdctl --endpoints=${ENDPOINTS} member list -w table

3.2.2 檢視叢集健康狀態

叢集狀態主要是etcdctl endpoint status和etcdctl endpoint health兩條命令

etcdctl --endpoints=${ENDPOINTS} endpoint status -w table
etcdctl --endpoints=${ENDPOINTS} endpoint health -w table

3.2.3 新增成員

主要用法如下所示：

etcdctl member add <memberName> [options] [flags]

範例如下所示：

# 範例：將目標節點etcd4新增到叢集
etcdctl member add etcd4 http://192.168.3.104:2380
# 啟動目標叢集時需要設定啟動引數如下
etcd --name=etcd4 --data-dir=/etcd-data \
  --listen-peer-urls=http://192.168.3.104:2380 \
  --listen-client-urls=http://192.168.3.104:2379 \
  --initial-advertise-peer-urls=http://192.168.3.104:2380 \
  --advertise-client-urls=http://192.168.3.104:2379 \
  --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 \
  --initial-cluster-state=existing

3.2.4 更新成員

主要用法如下所示：

etcdctl member update <memberID> [options] [flags]

範例如下所示：

etcdctl member update ade526d28b1f92f7 --peer-urls=http://192.168.3.111:2380

3.2.5 刪除成員

主要用法如下所示：

etcdctl member remove <memberID> [flags]

範例如下所示：

etcdctl member remove ade526d28b1f92f7

3.3 資料庫操作命令

3.3.1 put

新增一個鍵值，基本用法如下所示：

etcdctl put [options] <key> <value> [flags]

常用引數如下所示：

引數	功能描述
--prev-kv	輸出修改前的鍵值

注意事項如下所示：

其中value接受從stdin的輸入內容
如果value是以橫線-開始，將會被視為flag，如果不希望出現這種情況，可以使用兩個橫線代替--
若鍵已經存在，則進行更新並覆蓋原有值，若不存在，則進行新增

3.3.2 get

查詢鍵值，基本用法如下所示：

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

刪除鍵值，基本用法如下所示：

etcdctl del [options] <key> [range_end] [flags]

常用引數如下所示：

引數	功能描述
--prefix	根據prefix進行匹配刪除
--prev-kv	輸出刪除的鍵值
--from-key	按byte進行比較，刪除大於等於指定key的結果

3.4 租約相關命令

租約具有生命週期，需要為租約授予一個TTL(time to live)，將租約繫結到一個key上，則key的生命週期與租約一致，可續租，可復原租約。其主要用法如下所示：

etcdctl lease <subcommand> [flags]

3.4.1 新增租約

主要用法如下所示：

etcdctl lease grant <ttl> [flags]

範例如下所示：

etcdctl lease grant 600

3.4.2 列出租約

主要用法如下所示：

etcdctl lease list [flags]

範例如下所示：

etcdctl lease list

3.4.3 刪除租約

主要用法如下所示：

etcdctl lease revoke <leaseID> [flags]

範例如下所示：

etcdctl lease revoke 694d81417acd4754

3.4.4 檢視租約詳情

主要用法如下所示：

etcdctl lease timetolive <leaseID> [options] [flags]

範例如下所示：

etcdctl lease timetolive 694d81417acd4759

3.4.5 租約續約

主要用法如下所示：

etcdctl lease keep-alive [options] <leaseID> [flags]

範例如下所示：

etcdctl lease keep-alive 694d81417acd4757

3.5 watch命令

watch是監聽鍵或字首發生改變的事件流，主要用法如下所示：

etcdctl watch [options] [key or prefix] [range_end] [--] [exec-command arg1 arg2 ...] [flags]

範例如下所示：

# 對某個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 備份和恢復

主要用於管理節點的快照，其主要用法如下所示：

etcdctl snapshot <subcommand> [flags]

3.6.1 生成快照

其主要用法如下所示：

etcdctl snapshot save <filename> [flags]

範例如下所示：

etcdctl snapshot save Surpass.db

3.6.2 檢視快照

其主要用法如下所示：

etcdctl snapshot status <filename> [flags]

範例如下所示：

etcdctl snapshot status Surpass.db -w table

3.6.3 恢復快照

其主要用法如下所示：

etcdctl snapshot restore <filename> [options] [flags]

範例如下所示：

etcdctl snapshot restore Surpass.db \
--name=default \
--data-dir=/home/etcd_db \
--initial-advertise-peer-urls=http://localhost:2380

3.7 檢視告警

如果內部出現問題，會觸發告警，可以通過命令檢視告警引起原因，命令如下所示：

etcdctl alarm <subcommand> [flags]

常用的子命令主要有兩個：

# 檢視所有告警
etcdctl alarm list
# 解除所有告警
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 使用者管理

其主要用法如下所示：

etcdctl user <subcommand> [flags]

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

子命令	常用用法	功能描述
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 角色管理

其主要用法如下所示：

etcdctl role <subcommand> [flags]

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

子命令	常用用法	功能描述
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身份驗證的步驟如下所示：

# 新增root 使用者，密碼為surpass
etcdctl user add root:surpass
# 開啟身份驗證，開啟為enable，取消為disable
etcdctl auth enable
# 在開啟身份驗證後，需要帶user相關資訊
etcdctl get name --user=root:surpass

3.8.4 角色授權

在開啟了root身份驗證後，就可以對普通使用者和角色操作了。

1.使用者增刪改查

# 增加普通使用者
etcdctl user add surpass:surpass --user=root:surpass
# 獲取使用者資訊
etcdctl user get surpass --user=root:surpass
# 檢視所有使用者
etcdctl user list --user=root:surpass
# 修改使用者密碼
etcdctl user passwd surpass --user=root:surpass
# 刪除使用者
etcdctl user delete surpass --user=root:surpass

2.角色增刪改查

# 新增角色
etcdctl role add etcd-test --user=root:surpass
# 獲取角色詳細資訊
etcdctl role get etcd-test --user=root:surpass
# 獲取所有角色
etcdctl role list --user=root:surpass
# 刪除角色
etcdctl role delete etcd-test --user=root:surpass

3.繫結和授權

# 授權角色唯讀（read）、只寫(write)和讀寫(readwrite)許可權
# 按key進行授權
etcdctl role grant-permission etcd-test readwrite name  --user=root:surpass
# 按key的prefix進行授權
etcdctl role grant-permission etcd-test readwrite name --prefix=true --user=root:surpass
# 將授權繫結給指定使用者
etcdctl user grant-role test etcd-test --user=root:surpass
# 撤消角色授權
etcdctl role revoke-permission etcd-test name --user=root:surpass
# 撤消繫結授權
etcdctl user revoke-role test etcd-test --user=root:surpass

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

本文同步在微信訂閱號上釋出，如各位小夥伴們喜歡我的文章，也可以關注我的微信訂閱號：woaitest，或掃描下面的二維條碼新增關注：

ETCD快速入門-03 常用命令

3. ETCD 常用命令

3.1 檢視etcd版本

3.2 叢集相關操作

3.2.1 指定etcd叢集

3.2.2 檢視叢集健康狀態

3.2.3 新增成員

3.2.4 更新成員

3.2.5 刪除成員

3.3 資料庫操作命令

3.3.1 put

3.3.2 get

3.3.3 del

3.4 租約相關命令

3.4.1 新增租約

3.4.2 列出租約

3.4.3 刪除租約

3.4.4 檢視租約詳情

3.4.5 租約續約

3.5 watch命令

3.6 備份和恢復

3.6.1 生成快照

3.6.2 檢視快照

3.6.3 恢復快照

3.7 檢視告警

3.8 使用者許可權

3.8.1 使用者管理

3.8.2 角色管理

3.8.3 開啟root身份驗證

3.8.4 角色授權