KT:一款可提升 Kubernetes 開發效率的免費工具
對於使用了 Kubernetes 作為應用執行環境的開發者而言,在同一個叢集中我們可以使用名稱空間(Namespace)快速建立多套隔離環境,在相同名稱空間下,服務間使用 Service 的內部 DNS 域名進行相互訪問。 基於 Kubernetes 強大的隔離以及服務編排能力,可以實現一套定義編排(YAML)多處部署的能力。
不過,一般來說 Kubernetes 使用的容器網路與開發者的所在的辦公網路直接並不能直接連通。 因此,如何高效的利用 Kubernetes 進行服務間的聯調測試,成為在日常開發工作中一道繞不開的坎。本文我們就來聊一聊,如何加速基於 Kubernetes 的研發效率。
使用自動流水線
為了能夠讓開發者能夠更快的將修改的程式碼部署到叢集測試環境中,一般來說我們會引入持續交付流水線,將程式碼的編譯,映象的打包上傳以及部署通過自動化的方式來解決。如下所示:
從一定程度上來說,這種方式可以避免開發人員進行大量重複性的工作。但是,雖然整個過程自動化了,但是開發人員也不得不每次進行程式碼變更之後都需要等待流水線的執行。對於開發人員來說,每次程式碼變更後等待流水線執行或許已經成為整個開發任務過程中體驗最糟糕的部分。
打破網路限制,本地聯調
理想狀態下是開發者可以直接在本地啟動服務,並且這個服務就可以無縫的和遠端的 kubernetes 叢集中的各個其它服務實現互相呼叫。需要解決兩個問題:
-
我依賴了其它的服務:執行在本地的程式碼可以直接通過 podIP,clusterIP 甚至是 Kubernetes 叢集內的 DNS 地址訪問到部署在叢集中的其它應用,如下圖左;
-
其它的服務依賴了我:執行在 Kubernetes 叢集中的其它應用可以在不做任何改變的情況下訪問我到執行的本地的程式碼,如下圖右。
要實現剛才說的兩種本地聯調方式,主要需要解決以下 3 個問題:
-
本地網路與 Kubernetes 叢集網路直接的連通問題
-
在本地實現 Kubernetes 中內部服務的 DNS 解析;
-
如果將對叢集中其它 Pod 訪問的流量轉移到本地;
雲效開發者工具 KT
為了簡化在 Kubernetes 下進行聯調測試的複雜度,雲效在 SSH 隧道網路的基礎上並結合 Kubernetes 特性構建了一款面向開發者的免費輔助工具 KT(點選文末閱讀原文可直接下載),如下所示:
當本地執行的服務 C’希望能夠直接訪問叢集中 default 名稱空間下的 Service A 和 Service B 時,執行如下命令:
複製程式碼
$ ktctl -namespace=default
KT 會自動在叢集中部署 SSH/DNS 代理容器,並構建本地到 Kubernetes 叢集的 VPN 網路並通過 DNS 代理實現叢集服務 DNS 域名解析,在執行 KT 之後,開發者的本地程式可以直接像執行在叢集中的服務一樣通過 service 名字呼叫叢集中部署的其它應用:
而如果希望叢集中的其它 Pod(比如圖中的 PodD 和 PodE)能夠通過 ServiceC 訪問到本地執行的程式 C‘,通過如下命令,指定需要替換的目標 Deployment 以及指定本地服務埠:
複製程式碼
# -swap-deployment 指定需要替換的目標 Deployment # -expose 指定本地服務執行的埠 ktctl -swap-deployment c-deployment-expose=8080
KT 在構建 VPN 網路的同時,還會自動通過代理容器接管叢集原有的 PodC 例項,並直接轉發的本地的 8080 埠。實現叢集應用聯調本地。
經過上述兩個命令,開發者就可以真正的使用雲原生的方式來開發除錯 Kubernetes 中的應用了。
工作原理
下面解析 KT 的工作原理,如果你已經迫不及待的想嘗試 KT 的功能,可以直接跳到文章末尾下載 KT 工具。
KT 主要由兩部分組成:
-
在本地執行的命令列工具 ktctl
-
執行在叢集中的 SSH/DNS 代理容器。
在工作原理上 KT 實際上是結合 Kubernetes 自身能力實現的一個基於 SSH 的 VPN 網路。這這部分,筆者將詳細介紹雲效 Kubernetes 開發者工具 KT 的工作原理:
打通 SSH 協議通道
在 Kubernetes 命令列工具 kubectl 中內建的 port-forward 命令可以幫助使用者建立本地埠到 Kubernetes 叢集中特定 Pod 例項埠間的網路轉發。
當我們在叢集中部署一個包含 sshd 服務的容器後,通過 port-forward 可以將容器的 SSH 服務埠對映到本地:
複製程式碼
# 將對本地2222埠轉發到 kt-porxy 例項的22埠 $ kubectl port-forward deployments/kt-proxy2222:22 Forwardingfrom127.0.0.1:8080->8080 Forwardingfrom[::1]:8080->8080
在執行埠轉發後,就可以直接通過本地的 2222 埠通過 SSH 協議進入到 Kubernetes 叢集的 kt-proxy 例項中。從而打通本地與叢集之間的 SSH 網路鏈路。
本地動態埠轉發與 VPN
在打通 SSH 網路之後,我們就可以利用 SSH 通道實現本地到叢集的網路請求,其中最基本的方式就是使用 SSH 動態埠轉發的能力。
使用如下命令,通過本地 2000 執行的代理,可以將網路請求通過叢集中執行的 kt-proxy 容器進行轉發,從而實現本地到叢集網路請求的轉發:
複製程式碼
# ssh -D [本地網絡卡地址:] 本地埠name@ip -p 對映到 kt-proxy 的22埠的本地埠 ssh [email protected]
在啟用 SSH 動態埠轉發後,通過設定 http_proxy 環境變數後,即可直接在命令列中訪問叢集網路:
複製程式碼
#exporthttp_proxy=socks5://127.0.0.1:ssh 動態埠轉發的代理埠 exporthttp_proxy=socks5://127.0.0.1:2000
不過原生 SSH 動態埠轉發也有一定的限制那就是無法直接使用 UDP 協議,這裡我們選擇了一個替代方案 sshuttle. 如下命令所示:
複製程式碼
# export http_proxy=socks5://127.0.0.1:ssh 動態埠轉發的代理埠 export http_proxy=socks5://127.0.0.1:2000 sshuttle --dns --to-ns172.16.1.36-e'ssh -oStrictHostKeyChecking=no -oUserKnownHostsFile=/dev/null'[email protected]:2222172.16.1.0/16172.19.1.0/16-vv
sshuttle 工具在 SSH 協議之上構建了一個簡易的 VPN 網路,同時支援 DNS 協議轉發。
因此,接下來的問題就是實現一個自定義的 DNS 服務即可,而該服務在 KT 中是直接內建在 KT 代理映象中。
遠端埠轉發
在本地到叢集的鏈路打通之後。 接下來需要解決的就是從叢集到本地的訪問鏈路。這部分,我們會使用到 SSH 的遠端埠轉發能力,如下所示,指定所有對 kt-proxy 的 8080 埠的網路請求都會通過 SSH 隧道直接轉發到本地的 8080 埠:
複製程式碼
# ssh -R8080:localhost:[email protected] ssh -R8080:localhost:[email protected]
因此,在 KT 的實現過程之中,結合 Kubernetes 基於標籤的鬆耦合能力,我們只需要克隆原有應用例項的 YAML 描述,並將容器替換為 kt-proxy 即可。從而將對叢集中原有應用的請求通過 SSH 遠端埠轉發到本地。
綜上,通過利用 Kubernetes 原生能力以及適度的擴充套件,開發者可以快速在本地利用 KT 打破本地網路與 Kubernetes 網路之間的界限,大大提升使用 Kubernetes 進行聯調測試的效率。
小結
工具承載了對特定問題的解決方案,而工程技術實踐則是對其價值的放大。阿里巴巴雲效平臺,致力於為開發者提供一站式的企業研發與協作服務,並將阿里多年的軟體工程實踐以一種更加開發的形態反饋技術社群,歡迎更多的技術開發者入駐。
目前,Mac 使用者可以 下載 並體驗 KT 工具。
作者簡介
鄭雲龍,阿里巴巴研發效能部高階研發工程師。