使用 etcdctl

etcdctl 是一個指令行指令列用戶端，它能提供一些簡潔的指令，供使用者直接跟 etcd 服務打交道，而無需基於 HTTP API 方式。這在某些情況下將很方便，例如使用者對服務進行測試或是手動修改資料庫內容。我們也推薦在剛接觸 etcd 時透過 etcdctl 指令來熟悉相關的作業，這些作業跟 HTTP API 實際上是對應的。

etcd 項目二進位發行包中已經包含了 etcdctl 工具，沒有的話，可以從 github.com/coreos/etcd/releases 下載。

etcdctl 支援如下的指令，大體上分為資料庫作業和非資料庫作業兩類，後面將分別進行解釋。

$ etcdctl -h
NAME:
   etcdctl - A simple command line client for etcd.

USAGE:
   etcdctl [global options] command [command options] [arguments...]

VERSION:
   2.0.0-rc.1

COMMANDS:
   backup    backup an etcd directory
   mk        make a new key with a given value
   mkdir    make a new directory
   rm        remove a key
   rmdir    removes the key if it is an empty directory or a key-value pair
   get        retrieve the value of a key
   ls        retrieve a directory
   set        set the value of a key
   setdir    create a new or existing directory
   update    update an existing key with a given value
   updatedir    update an existing directory
   watch    watch a key for changes
   exec-watch    watch a key for changes and exec an executable
   member    member add, remove and list subcommands
   help, h    Shows a list of commands or help for one command

GLOBAL OPTIONS:
   --debug            output cURL commands which can be used to reproduce the request
   --no-sync            don't synchronize cluster information before sending request
   --output, -o 'simple'    output response in the given format (`simple` or `json`)
   --peers, -C             a comma-delimited list of machine addresses in the cluster (default: "127.0.0.1:4001")
   --cert-file             identify HTTPS client using this SSL certificate file
   --key-file             identify HTTPS client using this SSL key file
   --ca-file             verify certificates of HTTPS-enabled servers using this CA bundle
   --help, -h            show help
   --version, -v        print the version

資料庫作業

資料庫作業圍繞對鍵值和目錄的 CRUD （符合 REST 風格的一套作業：Create）完整生命週期的管理。

etcd 在鍵的組織上採用了層次化的空間結構（類似於檔案系統中目錄的概念），使用者指定的鍵可以為單獨的名字，如 testkey，此時實際上放在根目錄 / 下面，也可以為指定目錄結構，如 cluster1/node2/testkey，則將建立相應的目錄結構。

註：CRUD 即 Create, Read, Update, Delete，是符合 REST 風格的一套 API 作業。

set

指定某個鍵的值。例如

$ etcdctl set /testdir/testkey "Hello world"
Hello world

支援的選項包括：

--ttl '0'            該鍵值的逾時時間（單位為秒），不設定（ 預設為 0）則永不逾時
--swap-with-value value 若該鍵現在的值是 value，則進行設定作業
--swap-with-index '0'    若該鍵現在的索引值是指定索引，則進行設定作業

get

取得指定鍵的值。例如

$ etcdctl set testkey hello
hello
$ etcdctl update testkey world
world

當鍵不存在時，則會報錯。例如

$ etcdctl get testkey2
Error:  100: Key not found (/testkey2) [1]

支援的選項為

--sort    對結果進行排序
--consistent 將請求發給主節點，保證取得內容的一致性

update

當鍵存在時，更新值內容。例如

$ etcdctl set testkey hello
hello
$ etcdctl update testkey world
world

當鍵不存在時，則會報錯。例如

$ etcdctl update testkey2 world
Error:  100: Key not found (/testkey2) [1]

支援的選項為

--ttl '0'    逾時時間（單位為秒），不設定（ 預設為 0）則永不逾時

rm

刪除某個鍵值。例如

$ etcdctl rm testkey

當鍵不存在時，則會報錯。例如

$ etcdctl rm testkey2
Error:  100: Key not found (/testkey2) [8]

支援的選項為

--dir        如果鍵是個空目錄或是鍵值對則刪除
--recursive        刪除目錄和所有子鍵
--with-value     檢查現有的值是否符合
--with-index '0'    檢查現有的 index 是否符合

mk

如果設定的鍵不存在，則建立一個新的鍵值。例如

$ etcdctl mk /testdir/testkey "Hello world"
Hello world

當鍵存在的時候，執行該指令會報錯，例如

$ etcdctl set testkey "Hello world"
Hello world
$ ./etcdctl mk testkey "Hello world"
Error:  105: Key already exists (/testkey) [2]

支援的選項為

--ttl '0'    逾時時間（單位為秒），不設定（ 預設為 0）則永不逾時

mkdir

如果設定的鍵目錄不存在，則建立一個新的鍵目錄。例如

$ etcdctl mkdir testdir

當鍵目錄存在的時候，執行該指令會報錯，例如

$ etcdctl mkdir testdir
$ etcdctl mkdir testdir
Error:  105: Key already exists (/testdir) [7]

支援的選項為

--ttl '0'    逾時時間（單位為秒），不設定（ 預設為 0）則永不逾時

setdir

建立一個鍵目錄，無論存在與否。

支援的選項為

--ttl '0'    逾時時間（單位為秒），不設定（ 預設為 0）則永不逾時

updatedir

更新一個已經存在的目錄。 支援的選項為

--ttl '0'    逾時時間（單位為秒），不設定（ 預設為 0）則永不逾時

rmdir

刪除一個空目錄，或是鍵值對。

若目錄不空，會報錯

$ etcdctl set /dir/testkey hi
hi
$ etcdctl rmdir /dir
Error:  108: Directory not empty (/dir) [13]

ls

列出目錄（ 預設為根目錄）下的鍵或是子目錄， 預設不顯示子目錄中內容。

例如

$ ./etcdctl set testkey 'hi'
hi
$ ./etcdctl set dir/test 'hello'
hello
$ ./etcdctl ls
/testkey
/dir
$ ./etcdctl ls dir
/dir/test

支援的選項包括

--sort    將輸出結果排序
--recursive    如果目錄下有子目錄，則遞歸輸出其中的內容
-p        對於輸出為目錄，在最後加入 `/` 進行區分

非資料庫作業

backup

備份 etcd 的資料。

支援的選項包括

--data-dir         etcd 的資料目錄
--backup-dir     備份到指定路徑

watch

監測一個鍵值的變化，一旦鍵值發生更新，就會輸出最新的值並結束。

例如，使用者更新 testkey 鍵值為 Hello world。

$ etcdctl watch testkey
Hello world

支援的選項包括

--forever        一直監測，直到使用者按 `CTRL+C` 結束
--after-index '0'    在指定 index 之前一直監測
--recursive        傳回所有的鍵值和子鍵值

exec-watch

監測一個鍵值的變化，一旦鍵值發生更新，就執行設定指令。

例如，使用者更新 testkey 鍵值。

$etcdctl exec-watch testkey -- sh -c 'ls'
default.etcd
Documentation
etcd
etcdctl
etcd-migrate
README-etcdctl.md
README.md

支援的選項包括

--after-index '0'    在指定 index 之前一直監測
--recursive        傳回所有的鍵值和子鍵值

member

透過 list、add、remove 指令列出、加入、刪除 etcd 實例到 etcd 叢集中。

例如本地啟動一個 etcd 服務實例後，可以用如下指令進行 檢視。

$ etcdctl member list
ce2a822cea30bfca: name=default peerURLs=http://localhost:2380,http://localhost:7001 clientURLs=http://localhost:2379,http://localhost:4001

指令選項

  • --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 列印版本資訊

results matching ""

    No results matching ""