2.2 Client-go 原理
通过学习本节，你能清晰认识到 Client-go 主要用在 Kubernetes 的 Controller 中，包括内置的 Controller（如 Kube-Controller-Manager）和 CRD 控制器；该工具实现了对 Kubernetes 集群中各类资源对象（包括 Deployment、Service、Pod、Namespace、Node 等）的增删改查等操作。另外，通过代码分析，我们能够深入了解 Client-go 中各个组件（Reflector、Informer、Indexer）。最后，我们将介绍利用 Client-go 工具实现的一个简单的 Controller，据此，你可以了解 Controller 的大致结构。
2.2.1 Client-go 介绍
Client-go 是操作 Kubernetes 集群资源的编程式交互客户端库，利用对 Kubernetes APIServer 服务的交互访问，实现对 Kubernetes 集群中各类资源对象（包括 Deployment、Service、Pod、Namespace，Node 等）的增删改查等操作。
Client-go 不仅被 Kubernetes 项目本身使用（例如，在 Kubectl 内部），还在基于 Kubernetes 的二次开发中被许多外部用户使用：控制器 Operator，如 ETCD-Operator 或 Prometheus-Operator ；高级框架如 KubeLess 和 OpenShift 等，所以熟悉 Client-go 对了解 Kubernetes 及其周边项目尤为重要。
1. 结构介绍
Kubernetes 官方 2016 年 8 月将 Kubernetes 资源操作相关的核心源码抽取出来，独立组成一个新项目：Client-go。
以下介绍的 Client-go 版本为 v0.18.0，源码目录结构见代码清单 2-6。
代码清单 2-6
$tree -L 1 . ├── CHANGELOG.md ├── CONTRIBUTING.md ├── Godeps ├── INSTALL.md ├── LICENSE ├── OWNERS ├── README.md ├── SECURITY_CONTACTS ├── code-of-conduct.md ├── discovery # 包含 DiscoveryClient 客户端，用于发现 Kubernetes APIServer 支 持的资源信息 ├── dynamic # 包含 DynamicClient 客户端，可以对任意 Kubernetes 资源执行通用操作 ├── examples # 包含 Client-go 库的使用范例 ├── go.mod ├── go.sum ├── informers # 包含各种 Kubernetes 资源的 Informer 实现 ├── kubernetes # 包含 clientset 客户端，可以访问所有 Kubernetes 自身内置的资源 ├── kubernetes_test ├── listers # 为各种 Kubernetes 资源提供 Lister 功能 ├── metadata ├── pkg ├── plugin ├── rest ├── restmapper ├── scale ├── testing ├── third_party ├── tools # 与 util 包一起提供常用工具，便于编写 Controller ├── transport # 提供与 Kubernetes APIServer 的安全连接 └── util
2. 使用说明
操作 Kubernetes 集群的方式有多种，但本质上都要通过调用 Kubernetes REST API 实现对集群的访问和操作。例如，常用的 Kubectl 命令，当执行 Kubectl Get Pods 命令时，Kubectl 向 Kubernetes APIServer 完成认证，并发送 GET 请求（见代码清单2-7）。
代码清单 2-7
GET /api/v1/namespaces/test/pods --- 200 OK Content-Type: application/json { "kind": "PodList", "apiVersion": "v1", "metadata": {...}, "items": [...] }
Client-go 库抽象封装了与 Kubernetes REST API 的交互，方便开发者对 Kubernetes 的二次开发。利用 Client-go 操作 Kubernetes 资源的流程基本如下。
（1）通过 KubeConfig 信息，构造 Config 实例。该实例记录了集群证书、 Kubernetes APIServer 地址等信息。
（2）根据 Config 实例携带的信息，构建特定客户端（例如，ClientSet、DynamicSet 等）。
（3）利用客户端向 Kubernetes APIServer 发起请求，操纵 Kubernetes 资源。
下面以 Examples 目录中的示例讲解 Client-go 库的使用流程（见代码清单 2-8）。
示例：out-of-cluster-client-configuration，列出 default Namespace 下所有的 Pod 资源。
代码清单 2-8
func main() { var kubeconfig *string if home := homeDir(); home != "" { kubeconfig = flag.String( "kubeconfig", filepath.Join(home, ".kube", "config"), "(optional) absolute path to the kubeconfig file", ) } else { kubeconfig = flag.String("kubeconfig", "", "absolute path to the kubeconfig file") } flag.Parse() // use the current context in kubeconfig config, err := clientcmd.BuildConfigFromFlags("", *kubeconfig) if err != nil { panic(err.Error()) } // create the clientset clientset, err := kubernetes.NewForConfig(config) if err != nil { panic(err.Error()) } for { pods, err := clientset.CoreV1().Pods("").List(context.TODO(), metav1. ListOptions{}) if err != nil { panic(err.Error()) } //... } } func homeDir() string { if h := os.Getenv("HOME"); h != "" { return h } return os.Getenv("USERPROFILE") // windows }
（1）加载配置信息
在访问 Kubernetes 集群时，需要进行身份认证。Kubeconfig 用于管理访问集群的配置信息，默认的 Kubeconfig 文件路径为 $HOME/.kube/config 。范例中通过命令行参数配置，若存在 HOME 环境变量，则使用默认 Kubeconfig 配置，并利用 BuildConfigFromFlags 函数构建 Config 结构体。
（2）构建客户端
在操作资源前需要先构建对应客户端（具体客户端种类在后面章节介绍），示例中利用 NewForConfig 函数构建 ClientSet，ClientSet 能访问 Kubernetes 自身内置的资源，这里ClientSet 负责列出 Pod 资源。
（3）操作资源
根据 Kubernetes 资源类型和版本的不同，ClientSet 中包含了一组操作资源的客户端，如代码清单 2-9 所示，操作 Pod 资源使用 CoreV1 客户端。示例中：CoreV1 方法返回对应客户端；Pods 方法指定要操作的对象是 Pod 资源，参数用于设定 Namespace 为空，表示 default Namespace；List 方法表示对资源的操作动作，有 List、Get、Create、Delete 等。
最终返回的 Pods 变量就包含了所有 Pod 资源的信息。
代码清单 2-9
type Clientset struct { *discovery.DiscoveryClient //... coreV1 *corev1.CoreV1Client //... } //... // CoreV1 retrieves the CoreV1Client func (c *Clientset) CoreV1() corev1.CoreV1Interface { return c.coreV1 }
以上只是简单介绍了 ClientSet 的使用流程，下面将详细讲解 Client-go 中所有客户端的功能原理及使用方式。
