关于SegmentFault:k8sclientgo源码剖析一

简介：云原生社区活动 —Kubernetes 源码分析第一期

有幸参加云原生社区举办的 Kubernetes 源码分析流动，流动次要以书籍《Kubernetes 源码分析》为次要思路进行开展，提出在看书过程中遇到的问题，和社区成员一起探讨，最初会将后果总结到云原生社区的常识星球或 Github。

第一期流动次要以书本第五章 <Client-go 编程式交互 > 为主题进行学习，打算共三周半。

打算如下：

client-go 客户端学习
Infoermer 机制学习
WorkQueue 学习
整体构造回顾、逻辑回顾、优良代码回顾

学习总得有个重要的优先级，我集体的优先级是这样的，仅供参考：

Informer 机制原理
WorkerQueue 原理
几种 Client-go 客户端的应用、优劣

学习环境相干：

Kubernetes 1.14 版本
对应版本的 client-go

本文主题

本文是第一周，课题有两个：

Client-go 源码构造
几种 Client 客户端对象学习

Client-go 源码目录构造

[root@normal11 k8s-client-go]# tree . -L 1
.
├── CHANGELOG.md
├── code-of-conduct.md
├── CONTRIBUTING.md
├── discovery
├── dynamic
├── examples
├── Godeps
├── go.mod
├── go.sum
├── informers
├── INSTALL.md
├── kubernetes
├── kubernetes_test
├── LICENSE
├── listers
├── metadata
├── OWNERS
├── pkg
├── plugin
├── README.md
├── rest
├── restmapper
├── scale
├── SECURITY_CONTACTS
├── testing
├── third_party
├── tools
├── transport
└── util

client-go 代码库曾经集成到了 Kubernetes 源码中，所以书本中展现的内容是在 Kubernetes 源码中源码构造，而这里展现的是 Client-go 代码库中原始的内容，所以多了一些源码之外的内容，例如 README、example、go.mod 等。上面讲一下各个目录的作用，内容引自书本：

几种 Client-go 客户端

下图是一个简略的总结, 其中 ClientSet、DynamicClient、DiscoveryClient 都是基于 RESTClient 封装的。

RESTClient

最根底的客户端，对 HTTP Request 进行了封装，实现了 RESTFul 格调的 API。

案例代码：

package main

import (

"fmt"

corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes/scheme"
"k8s.io/client-go/rest"
"k8s.io/client-go/tools/clientcmd"

)

func main() {

config, err := clientcmd.BuildConfigFromFlags("","/root/.kube/config")
if err != nil {panic(err.Error())
}

config.APIPath = "api"
config.GroupVersion = &corev1.SchemeGroupVersion
config.NegotiatedSerializer = scheme.Codecs

restClient, err := rest.RESTClientFor(config)
if err != nil {panic(err.Error())
}

result := &corev1.NodeList{}
err = restClient.Get().Namespace("").Resource("nodes").VersionedParams(&metav1.ListOptions{Limit: 100}, scheme.ParameterCodec).Do().Into(result)
if err != nil {panic(err)
}

for _, d := range result.Items {fmt.Printf("Node Name %v n", d.Name)
}

}

预期运行后果将会打印 K8S 集群中的 node

ClientSet

对 RESTClient 进行了对象分类形式的封装，能够实例化特定资源的客户端，

以 Resource 和 Version 的形式裸露。例如实例化一个只操作 appsv1 版本的 Deploy 客户端,

ClientSet 能够认为是一系列资源的汇合客户端。毛病是不能间接拜访 CRD。

通过 client-gen 代码生成器生成带有 CRD 资源的 ClientSet 后能够拜访 CRD 资源。(未测试)

案例代码：

package main

import (

apiv1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/client-go/kubernetes"
"k8s.io/client-go/tools/clientcmd"

)

func main() {

config, err := clientcmd.BuildConfigFromFlags("","/root/.kube/config")
if err != nil {panic(err)
}
clientset, err := kubernetes.NewForConfig(config)
if err != nil {panic(err)
}

podClient := clientset.CoreV1().Pods(apiv1.NamespaceDefault)

list, err := podClient.List(metav1.ListOptions{Limit: 500})
if err != nil {panic(err)
}
for _, d := range list.Items {if d.Name == "" {}
    // fmt.Printf("NAME:%v t NAME:%v t STATUS: %+vn", d.Namespace, d.Name, d.Status)
}

// 申请 namespace 为 default 下的 deploy
deploymentClient := clientset.AppsV1().Deployments(apiv1.NamespaceDefault)
deployList, err2 := deploymentClient.List(metav1.ListOptions{Limit: 500})
if err2 != nil {panic(err2)
}
for _, d := range deployList.Items {if d.Name == "" {}
    // fmt.Printf("NAME:%v t NAME:%v t STATUS: %+vn", d.Namespace, d.Name, d.Status)
}

// 申请 ds 资源 todo  有趣味能够尝试下
// clientset.AppsV1().DaemonSets()

}

代码中别离打印了获取到 K8S 集群中的 500 个 Pod 和 500 个 deploy，目前打印语句是正文了，如果要看成果须要先删掉正文。

案例代码中还留了一个小内容，申请获取 daemonset 资源，感兴趣的能够试一试。

DynamicClient

这是一种动静客户端，对 K8S 任意资源进行操作，包含 CRD。

申请返回的后果是 map[string]interface{}

代码案例：

package main

import (

"fmt"

apiv1 "k8s.io/api/core/v1"
corev1 "k8s.io/api/core/v1"
metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
"k8s.io/apimachinery/pkg/runtime"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/dynamic"
"k8s.io/client-go/tools/clientcmd"

)

func main() {

config, err := clientcmd.BuildConfigFromFlags("","/root/.kube/config")
if err != nil {panic(err)
}

dymaicClient, err := dynamic.NewForConfig(config)
checkErr(err)
//map[string]interface{}

     //TODO 获取 CRD 资源 这里是获取了 TIDB 的 CRD 资源
// gvr := schema.GroupVersionResource{Version: "v1alpha1", Resource: "tidbclusters", Group: "pingcap.com"}
// unstructObj, err := dymaicClient.Resource(gvr).Namespace("tidb-cluster").List(metav1.ListOptions{Limit: 500})
// checkErr(err)
// fmt.Println(unstructObj)

gvr := schema.GroupVersionResource{Version: "v1", Resource: "pods"}
unstructObj, err := dymaicClient.Resource(gvr).Namespace(apiv1.NamespaceDefault).List(metav1.ListOptions{Limit: 500})
checkErr(err)
// fmt.Println(unstructObj)
podList := &corev1.PodList{}
err = runtime.DefaultUnstructuredConverter.FromUnstructured(unstructObj.UnstructuredContent(), podList)
checkErr(err)
for _, d := range podList.Items {fmt.Printf("NAME:%v t NAME:%v t STATUS: %+vn", d.Namespace, d.Name, d.Status)
}

}

func checkErr(err error) {

if err != nil {panic(err)
}

}

这个案例是打印了 namespace 为 default 下的 500 个 pod，同样的，在案例中也有一个 todo，获取 CRD 资源，感兴趣的能够尝试一下。如果 K8S 集群中没有 TIDB 的资源能够自行换成本人想要的 CRD 资源。

代码中曾经有获取 v1alpha1 版本的 tidbclusters 资源。如果你不晓得 CRD 相干的信息，能够依照上面的步骤来找出对应的信息：

通过 kubectl api-resources 获取到资源的 Group 和 Resource
通过 kubectl api-versions 找到对应 Group 的版本

这样资源的 GVR(Group、Version、Resource) 都有了

DiscoveryClient

这是一种发现客户端，在后面的客户端中须要晓得资源的 Resource 和 Version 能力找到你想要的，

这些信息太多很难全副记住，这个客户端用于获取资源组、版本等信息。

后面用到的 api-resources 和 api-versions 都是通过 discoveryClient 客户端实现的, 源码在 Kubernetes 源码库中 pkg/kubectl/cmd/apiresources/apiresources.go pkg/kubectl/cmd/apiresources/apiversions.go

// RunAPIResources does the work
func (o APIResourceOptions) RunAPIResources(cmd cobra.Command, f cmdutil.Factory) error {

w := printers.GetNewTabWriter(o.Out)
defer w.Flush()

// 拿到一个 DiscoveryClient 客户端
discoveryclient, err := f.ToDiscoveryClient()
if err != nil {return err}

// RunAPIVersions does the work
func (o *APIVersionsOptions) RunAPIVersions() error {

// Always request fresh data from the server
o.discoveryClient.Invalidate()

// 通过 discoveryClient 获取 group 相干信息
groupList, err := o.discoveryClient.ServerGroups()
if err != nil {return fmt.Errorf("couldn't get available api versions from server: %v", err)
}

案例代码：

获取集群中的 GVR

package main

import (

"fmt"
"k8s.io/apimachinery/pkg/runtime/schema"
"k8s.io/client-go/discovery"
"k8s.io/client-go/tools/clientcmd"

)

func main() {

config, err := clientcmd.BuildConfigFromFlags("","/root/.kube/config")
if err != nil {panic(err.Error())
}

discoveryClient, err := discovery.NewDiscoveryClientForConfig(config)
if err != nil {panic(err.Error())
}

_, APIResourceList, err := discoveryClient.ServerGroupsAndResources()
if err != nil {panic(err.Error())
}
for _, list := range APIResourceList {gv, err := schema.ParseGroupVersion(list.GroupVersion)
    if err != nil {panic(err.Error())
    }
    for _, resource := range list.APIResources {fmt.Printf("name: %v, group: %v, version %vn", resource.Name, gv.Group, gv.Version)
    }
}

}

预期成果：打印集群中的 GVR

[root@normal11 discoveryclient]# go run main.go 
name: bindings, group: , version v1
name: componentstatuses, group: , version v1
name: configmaps, group: , version v1
name: endpoints, group: , version v1
...

DiscoveryClient 在申请到数据之后会缓存到本地，默认存储地位是~/.kube/cache 和~/.kube/http-cache, 默认是每 10 分钟会和 API Server 同步一次。

总结

第一周次要是理解下各种客户端的应用以及不同，有工夫的能够再进行一些拓展试验，钻研对象能够抉择一些支流的框架或官网示例，例如：

Sample-Controller 中如何应用 client-go 的
Kubebuilder 中如何应用 client-go 的
Operator-sdk 中如何应用 client-go 的

延长浏览：

流动 Kubernetes 源码研习社第一期流动
如何高效浏览 Kubernetes 源码？

始发于四颗咖啡豆, 转载请申明出处.
关注公粽号 ->[四颗咖啡豆] 获取最新内容

首发于 2020 年 8 月份, 这里从新做一次公布