歡迎訪問我的GitHub
https://github.com/zq2599/blog_demos
內(nèi)容:所有原創(chuàng)文章分類匯總及配套源碼廊营,涉及Java饼灿、Docker赘娄、Kubernetes归园、DevOPS等吞杭;
系列文章鏈接
- client-go實戰(zhàn)之一:準備工作
- client-go實戰(zhàn)之二:RESTClient
- client-go實戰(zhàn)之三:Clientset
- client-go實戰(zhàn)之四:dynamicClient
- client-go實戰(zhàn)之五:DiscoveryClient
本篇概覽
- 本文是《client-go實戰(zhàn)》系列的第二篇廊遍,前文咱們提到過client-go一共有四種客戶端:RESTClient踪旷、ClientSet植捎、DynamicClient衙解、DiscoveryClient,而RESTClient是最基礎(chǔ)的版本鸥跟,其他三種都是基于RESTClient封裝的丢郊,今天咱們通過實戰(zhàn)編碼來學習RESTClient,熟悉最基礎(chǔ)的遠程操作步驟医咨;
- 本篇由以下幾部分組成:
- 簡介RESTClient
- 每次編碼前的準備工作
- 正式編碼
- 驗證
- 關(guān)鍵源碼分析
RESTClient簡介
- RESTClient是client-go最基礎(chǔ)的客戶端枫匾,主要是對HTTP Reqeust進行了封裝,對外提供RESTful風格的API拟淮,并且提供豐富的API用于各種設(shè)置干茉,相比其他幾種客戶端雖然更復雜,但是也更為靈活很泊;
- 使用RESTClient對kubernetes的資源進行增刪改查的基本步驟如下:
- 確定要操作的資源類型(例如查找deployment列表)角虫,去官方API文檔中找到對于的path沾谓、數(shù)據(jù)結(jié)構(gòu)等信息,后面會用到戳鹅;
- 加載配置kubernetes配置文件(和kubectl使用的那種kubeconfig完全相同)均驶;
- 根據(jù)配置文件生成配置對象,并且通過API對配置對象就行設(shè)置(例如請求的path枫虏、Group妇穴、Version、序列化反序列化工具等)隶债;
- 創(chuàng)建RESTClient實例腾它,入?yún)⑹桥渲脤ο螅?/li>
- 調(diào)用RESTClient實例的方法向kubernetes的API Server發(fā)起請求,編碼用fluent風格將各種參數(shù)傳入(例如指定namespace死讹、資源等)瞒滴,如果是查詢類請求,還要傳入數(shù)據(jù)結(jié)構(gòu)實例的指針赞警,改數(shù)據(jù)結(jié)構(gòu)用于接受kubernetes返回的查詢結(jié)果妓忍;
- 接下來的編碼實戰(zhàn)也是按照上述流程進行的;
實戰(zhàn)內(nèi)容
- 本次實戰(zhàn)內(nèi)容很簡單:查詢<font color="blue">kube-system</font>這個namespace下的所有pod仅颇,然后在控制臺打印每個pod的幾個關(guān)鍵字段单默;
- 感謝您耐心聽我啰嗦了一大堆,接下來開始實戰(zhàn)吧忘瓦;
源碼下載
- 本篇實戰(zhàn)中的源碼可在GitHub下載到搁廓,地址和鏈接信息如下表所示(https://github.com/zq2599/blog_demos):
名稱 | 鏈接 | 備注 |
---|---|---|
項目主頁 | https://github.com/zq2599/blog_demos | 該項目在GitHub上的主頁 |
git倉庫地址(https) | https://github.com/zq2599/blog_demos.git | 該項目源碼的倉庫地址,https協(xié)議 |
git倉庫地址(ssh) | git@github.com:zq2599/blog_demos.git | 該項目源碼的倉庫地址耕皮,ssh協(xié)議 |
- 這個git項目中有多個文件夾境蜕,client-go相關(guān)的應用在<font color="blue">client-go-tutorials</font>文件夾下,如下圖紅框所示:
在這里插入圖片描述
- client-go-tutorials文件夾下有多個子文件夾凌停,本篇對應的源碼在<font color="blue">restclientdemo</font>目錄下粱年,如下圖紅框所示:
在這里插入圖片描述
查看官方文檔,獲取編碼所需內(nèi)容
瀏覽器打開官方API文檔罚拟,地址:https://v1-19.docs.kubernetes.io/docs/reference/generated/kubernetes-api/v1.19/
找到pod的API文檔台诗,如下圖,確定了path和namespace參數(shù):
在這里插入圖片描述
- 然后還要關(guān)注響應的數(shù)據(jù)結(jié)構(gòu)赐俗,如下圖紅框拉队,返回的是:
在這里插入圖片描述
- 點擊上圖紅框中的內(nèi)容,可見PodList的詳情阻逮,這就是我們編碼時所需的數(shù)據(jù)結(jié)構(gòu):
在這里插入圖片描述
- 掌握了請求和響應的詳細信息粱快,可以開始編碼了;
編碼
- 新建文件夾restclientdemo,在里面執(zhí)行以下命令事哭,新建module:
go mod init restclientdemo
- 添加k8s.io/api和k8s.io/client-go這兩個依賴漫雷,注意版本要匹配kubernetes環(huán)境:
go get k8s.io/api@v0.20.0
go get k8s.io/client-go@v0.20.0
- 新建main.go,內(nèi)容如下鳍咱,已經(jīng)都添加了詳細的注釋降盹,就不贅述了:
package main
import (
"context"
"flag"
"fmt"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"
"k8s.io/client-go/util/homedir"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"path/filepath"
)
func main() {
var kubeconfig *string
// home是家目錄,如果能取得家目錄的值谤辜,就可以用來做默認值
if home:=homedir.HomeDir(); home != "" {
// 如果輸入了kubeconfig參數(shù)澎现,該參數(shù)的值就是kubeconfig文件的絕對路徑,
// 如果沒有輸入kubeconfig參數(shù)每辟,就用默認路徑~/.kube/config
kubeconfig = flag.String("kubeconfig", filepath.Join(home, ".kube", "config"), "(optional) absolute path to the kubeconfig file")
} else {
// 如果取不到當前用戶的家目錄,就沒辦法設(shè)置kubeconfig的默認目錄了干旧,只能從入?yún)⒅腥? kubeconfig = flag.String("kubeconfig", "", "absolute path to the kubeconfig file")
}
flag.Parse()
// 從本機加載kubeconfig配置文件渠欺,因此第一個參數(shù)為空字符串
config, err := clientcmd.BuildConfigFromFlags("", *kubeconfig)
// kubeconfig加載失敗就直接退出了
if err != nil {
panic(err.Error())
}
// 參考path : /api/v1/namespaces/{namespace}/pods
config.APIPath = "api"
// pod的group是空字符串
config.GroupVersion = &corev1.SchemeGroupVersion
// 指定序列化工具
config.NegotiatedSerializer = scheme.Codecs
// 根據(jù)配置信息構(gòu)建restClient實例
restClient, err := rest.RESTClientFor(config)
if err!=nil {
panic(err.Error())
}
// 保存pod結(jié)果的數(shù)據(jù)結(jié)構(gòu)實例
result := &corev1.PodList{}
// 指定namespace
namespace := "kube-system"
// 設(shè)置請求參數(shù),然后發(fā)起請求
// GET請求
err = restClient.Get().
// 指定namespace椎眯,參考path : /api/v1/namespaces/{namespace}/pods
Namespace(namespace).
// 查找多個pod挠将,參考path : /api/v1/namespaces/{namespace}/pods
Resource("pods").
// 指定大小限制和序列化工具
VersionedParams(&metav1.ListOptions{Limit:100}, scheme.ParameterCodec).
// 請求
Do(context.TODO()).
// 結(jié)果存入result
Into(result)
if err != nil {
panic(err.Error())
}
// 表頭
fmt.Printf("namespace\t status\t\t name\n")
// 每個pod都打印namespace、status.Phase编整、name三個字段
for _, d := range result.Items {
fmt.Printf("%v\t %v\t %v\n",
d.Namespace,
d.Status.Phase,
d.Name)
}
}
- 編碼完成舔稀,執(zhí)行<font color="blue">go run main.go</font>,即可獲取指定namespace下所有pod的信息掌测,控制臺輸出如下:
(base) zhaoqindeMBP:restclientdemo zhaoqin$ go run main.go
namespace status name
kube-system Running coredns-7f89b7bc75-5pdwc
kube-system Running coredns-7f89b7bc75-nvbvm
kube-system Running etcd-hedy
kube-system Running kube-apiserver-hedy
kube-system Running kube-controller-manager-hedy
kube-system Running kube-flannel-ds-v84vc
kube-system Running kube-proxy-hlppx
kube-system Running kube-scheduler-hedy
- 至此内贮,RESTClient客戶端從編碼到驗證都完成了;
如何將收到的數(shù)據(jù)反序列化為PodList對象汞斧?
- 前面的代碼比較簡單夜郁,但是有一處引起了我的興趣,如下圖紅框所示粘勒,result是corev1.PodList類型的結(jié)構(gòu)體指針竞端,restClient收到kubernetes返回的數(shù)據(jù)后,如何知道要將數(shù)據(jù)反序列化成corev1.PodList類型呢(Into方法入?yún)㈩愋蜑閞untime.Object)庙睡?
在這里插入圖片描述
- 之前的代碼中有一行設(shè)置了編解碼工具:<font color="blue">config.NegotiatedSerializer = scheme.Codecs</font>事富,展開這個scheme.Codecs,可見設(shè)置的時候確定了序列化工具為runtime.Serializer:
在這里插入圖片描述
- Serializer的typer字段類型是runtime.ObjectTyper乘陪,這里實際上是runtime.Scheme统台,因此ObjectTyper.ObjectKinds方法,實際上就是Scheme.ObjectKinds方法暂刘,在里面根據(jù)s.typeToGVK[t]拿到了GVK饺谬,也就是v1.PodList:
在這里插入圖片描述
- 有了這個GVK就確定的返回數(shù)據(jù)的類型,最終調(diào)用<font color="blue">caseSensitiveJSONIterator.Unmarshal(data, obj)</font>完成byte數(shù)組到對象的反序列化操作:
在這里插入圖片描述
- 最后還有一行關(guān)鍵代碼,將data的內(nèi)容寫到最外層的Into方法的入?yún)⒅校?/li>
在這里插入圖片描述
- 源碼分析完成募寨,簡單來說除了利用反射獲取實際類型族展,還有就是Scheme內(nèi)部維護的數(shù)據(jù)類型和GVK的關(guān)系映射表;
- 至此拔鹰,RESTClient的實戰(zhàn)就完成了仪缸,希望本篇能幫助您打好基礎(chǔ),這樣后面在體驗其他三種客戶端時已對其底層的實現(xiàn)原理了然于胸列肢;
你不孤單恰画,欣宸原創(chuàng)一路相伴
你不孤單,欣宸原創(chuàng)一路相伴
歡迎關(guān)注公眾號:程序員欣宸
微信搜索「程序員欣宸」瓷马,我是欣宸拴还,期待與您一同暢游Java世界...
https://github.com/zq2599/blog_demos