关于SegmentFault:k8sclientgo源码剖析一

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

简介：云原生社区活动---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.SchemeGroupVersionconfig.NegotiatedSerializer = scheme.CodecsrestClient, 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下的deploydeploymentClient := 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 servero.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 v1name: componentstatuses, group: , version v1name: configmaps, group: , version v1name: 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 源码？

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