1. etcd 網(wǎng)關(guān)

etcd 網(wǎng)關(guān)是一個(gè)簡單的 TCP 代理，可將網(wǎng)絡(luò)數(shù)據(jù)轉(zhuǎn)發(fā)到 etcd 集群。網(wǎng)關(guān)是無狀態(tài)且透明的，它既不會檢查客戶端請求，也不會干擾集群響應(yīng)，支持多個(gè) etcd 服務(wù)器實(shí)例，并采用簡單的循環(huán)策略。

etcd 網(wǎng)關(guān)將請求路由到可用端點(diǎn)，并向客戶端隱藏故障，使得客戶端感知不到服務(wù)端的故障。

1.1 適用場景

我們使用客戶端連接到 etcd 服務(wù)器時(shí)，每個(gè)訪問 etcd 的應(yīng)用程序必須知道所要訪問的 etcd 集群實(shí)例的地址，即用來提供客戶端服務(wù)的地址：ETCD_LISTEN_CLIENT_URLS。

如果同一服務(wù)器上的多個(gè)應(yīng)用程序訪問相同的 etcd 集群，每個(gè)應(yīng)用程序仍需要知道 etcd 集群的廣播的客戶端端點(diǎn)地址。如果將 etcd 集群重新配置，擁有不同的端點(diǎn)，那么每個(gè)應(yīng)用程序還需要更新其端點(diǎn)列表。在大規(guī)模集群環(huán)境下，重新配置的操作既造成了重復(fù)又容易出錯(cuò)。

以上問題，都可以通過 etcd 網(wǎng)關(guān)來解決：

• 使用 etcd 網(wǎng)關(guān)作為穩(wěn)定的本地端點(diǎn)，對于客戶端應(yīng)用程序來說，不會感知到集群實(shí)例的變化。
• 典型的 etcd 網(wǎng)關(guān)配置是使每臺運(yùn)行網(wǎng)關(guān)的計(jì)算機(jī)在本地地址上偵聽，并且每個(gè) etcd 應(yīng)用程序都連接對應(yīng)的本地網(wǎng)關(guān)，發(fā)生 etcd 集群實(shí)例的變更時(shí)，只需要網(wǎng)關(guān)更新其端點(diǎn)，而不需要更新每個(gè)客戶端應(yīng)用程序的代碼實(shí)現(xiàn)。

1.2 不適用場景

• 性能提升

etcd 網(wǎng)關(guān)不是為提高 etcd 集群性能設(shè)計(jì)的。它不提供緩存、watch 流合并或批量處理等功能。

• 在集群上運(yùn)行管理系統(tǒng)

類似 Kubernetes 的高級集群管理系統(tǒng)本身支持服務(wù)發(fā)現(xiàn)。應(yīng)用程序可以使用系統(tǒng)默認(rèn)的 DNS 名稱或虛擬 IP 地址訪問 etcd 集群。例如，負(fù)責(zé)為 Service 提供 Cluster 內(nèi)部的服務(wù)發(fā)現(xiàn)和負(fù)載均衡的 Kube-proxy 其實(shí)等效于 etcd 網(wǎng)關(guān)的職能。

總而言之，為了自動傳播集群端點(diǎn)更改，etcd 網(wǎng)關(guān)在每臺機(jī)器上都運(yùn)行，為多個(gè)應(yīng)用提供訪問相同的 etcd 集群服務(wù)。

2. gRPC 網(wǎng)關(guān)

gRPC-Gateway 為非 gRPC 的客戶端提供 HTTP 接口。

etcd v3 使用 gRPC 作為消息傳輸協(xié)議。

etcd 項(xiàng)目中包括了基于 gRPC 的 Go client 和命令行工具 etcdctl，客戶端通過 gRPC 框架與 etcd 集群通訊。對于不支持 gRPC 的客戶端語言，etcd 提供 JSON 的 gRPC-Gateway，通過 gRPC-Gateway 提供 RESTful 代理，轉(zhuǎn)換 HTTP/JSON 請求為 gRPC 的 Protocol Buffer 格式的消息。

這里你需要注意的是，在 HTTP 請求體中的 JSON 對象，其包含的 key 和 value 字段都被定義成了 byte 數(shù)組，因此必須在 JSON 對象中，使用 base64 編碼對內(nèi)容進(jìn)行處理。

2.1 etcd 版本與 gRPC-Gateway 接口對應(yīng)的關(guān)系

gRPC-Gateway 提供的接口路徑自 etcd v3.3 已經(jīng)變更：

• etcd v3.2 及之前的版本只能使用 [CLIENT-URL]/v3alpha/* 接口；

• etcd v3.3 使用 CLIENT-URL/v3alpha/*；

• etcd v3.4 使用 CLIENT-URL/v3beta/，且廢棄了 [CLIENT-URL]/v3alpha/；

• etcd v3.5 只使用 CLIENT-URL/v3beta/；

通過上面的接口與 etcd 版本的對應(yīng)關(guān)系，你可以看到，即使是 v3 版本下的 API，gRPC-Gateway 提供的接口路徑在內(nèi)部細(xì)分的版本下也有不同，所以需要注意當(dāng)前正在使用的 etcd 版本。

2.2 鍵值對讀寫操作

如果沒有使用 base64 對鍵值對進(jìn)行編碼，那么會報(bào)以下錯(cuò)誤：

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/kv/put -X POST -d '{"key": "/demo", "value": "AAA"}'
{"error":"illegal base64 data at input byte 4","message":"illegal base64 data at input byte 4","code":3}

對其進(jìn)行 base64 編碼

• demo 字符串的 base64 編碼結(jié)果為 ZGVtbw==
• AAA 字符串的 base64 編碼結(jié)果為 QUFB

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/kv/put -X POST -d '{"key": "ZGVtbw==", "value": "QUFB"}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"26","raft_term":"3"}}

接著，我們通過 /v3/kv/range 接口，來讀取剛剛寫入的鍵值對：

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/kv/range -X POST -d '{"key": "ZGVtbw=="}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"26","raft_term":"3"},"kvs":[{"key":"ZGVtbw==","create_revision":"26","mod_revision":"26","version":"1","value":"QUFB"}],"count":"1"}

當(dāng)我們想要獲取前綴為指定值的鍵值對時(shí)，可以使用如下請求：

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/kv/range -X POST -d '{"key": "ZGVtbw==", "range_end": "Zm9w"}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"26","raft_term":"3"},"kvs":[{"key":"ZGVtbw==","create_revision":"26","mod_revision":"26","version":"1","value":"QUFB"}],"count":"1"}

因?yàn)橹挥幸粋€(gè)值，所以返回正確。

2.3 watch 鍵值

etcd 中提供了 /v3/watch 接口來監(jiān)測 keys，我們來 watch 剛剛寫入的 ZGVtbw==，請求如下所示：

curl -N http://localhost:2379/v3/watch -X POST -d '{"create_request": {"key":"ZGVtbw=="}}'

然后另開一個(gè)窗口，執(zhí)行以下命令

etcdctl put demo 123

查看 watch 結(jié)果輸出：

wohu@ubuntu:~$ curl -N http://localhost:2379/v3/watch -X POST -d '{"create_request": {"key":"ZGVtbw=="} }'
{"result":{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"26","raft_term":"3"},"created":true}}
{"result":{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"27","raft_term":"3"},"events":[{"kv":{"key":"ZGVtbw==","create_revision":"26","mod_revision":"27","version":"2","value":"MTIz"}}]}}

當(dāng)寫入鍵值后，觸發(fā)了監(jiān)測事件的發(fā)生，控制臺輸出了時(shí)間的細(xì)節(jié)。HTTP 請求客戶端與 etcd 服務(wù)端建立長連接，當(dāng)監(jiān)聽的鍵值對發(fā)生變更時(shí)，便會將事件通知給客戶端。

2.4 HTTP 請求的安全認(rèn)證

HTTP 的方式訪問 etcd 服務(wù)端，需要考慮安全的問題，gRPC-Gateway 中提供的 API 接口支持開啟安全認(rèn)證。通過 /v3/auth 接口設(shè)置認(rèn)證，需要實(shí)現(xiàn)以下 4 個(gè)步驟：

1. 創(chuàng)建用戶

wohu@ubuntu:~$  curl -L http://localhost:2379/v3/auth/user/add -X POST -d '{"name": "root", "password": "123456"}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"27","raft_term":"3"}}

2. 創(chuàng)建角色

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/auth/role/add -X POST -d '{"name": "root"}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"27","raft_term":"3"}}

3. 用戶授予角色

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/auth/user/grant -X POST -d '{"user": "root", "role": "root"}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"27","raft_term":"3"}}

4. 開啟認(rèn)證權(quán)限

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/auth/enable -X POST -d '{}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"27","raft_term":"3"}}

如上的請求中，我們首先創(chuàng)建了 root 用戶和角色，將 root 角色賦予到 root 用戶，這樣就可以開啟用戶的權(quán)限。接下來就是進(jìn)行身份驗(yàn)證，并進(jìn)行 HTTP 訪問。流程如下圖所示：

使用 /v3/auth/authenticate API 接口對 etcd 進(jìn)行身份驗(yàn)證以獲取身份驗(yàn)證令牌：

wohu@ubuntu:~$ curl -L http://localhost:2379/v3/auth/authenticate -X POST -d '{"name": "root", "password": "123456"}'
{"header":{"cluster_id":"14841639068965178418","member_id":"10276657743932975437","revision":"27","raft_term":"3"},"token":"BGQDrdEVPaGQBCGh.51"}

請求獲取到 token 的值為 BGQDrdEVPaGQBCGh.51。接下來，設(shè)置請求的頭部 Authorization 為剛剛獲取到的身份驗(yàn)證令牌，以使用身份驗(yàn)證憑據(jù)設(shè)置 key 值：

curl -L http://localhost:2379/v3/kv/put -H 'Authorization:BGQDrdEVPaGQBCGh.51' -X POST -d '{"key": "ZGVtbw==", "value": "QUFB"}'

如果 token 不合法會報(bào)錯(cuò)誤：

{"error":"etcdserver: invalid auth token","message":"etcdserver: invalid auth token","code":16}

etcd gRPC-Gateway 中提供的 API 接口還有諸如 /v3/auth/role/delete、/v3/auth/role/get 等其他接口，請參考 官網(wǎng)

3. 總結(jié)

• etcd 網(wǎng)關(guān)通常用于 etcd 集群的門戶，是一個(gè)簡單的 TCP 代理，將客戶端請求轉(zhuǎn)發(fā)到 etcd 集群，對外屏蔽了 etcd 集群內(nèi)部的實(shí)際情況，在集群出現(xiàn)故障或者異常時(shí)，可以通過 etcd 網(wǎng)關(guān)進(jìn)行切換；

• gRPC-Gateway 則是對于 etcd 的 gRPC 通信協(xié)議的補(bǔ)充，有些語言的客戶端不支持 gRPC 通信協(xié)議，此時(shí)就可以使用 gRPC-Gateway 對外提供的 HTTP API 接口。通過 HTTP 請求，實(shí)現(xiàn)與 gRPC 調(diào)用協(xié)議同樣的功能。

總結(jié)

以上是生活随笔為你收集整理的etcd 笔记（04）— etcd 网关与 gRPC 网关的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯(cuò)，歡迎將生活随笔推薦給好友。