code-generator 使用介绍——CRD客户端生成工具

目录

背景

框架构建

代码注入

测试

---

背景

client-go为每种k8s内置资源提供了对应的clientset和informer。如果需要监听和操作自定义资源对象，有以下两种做法——

• 使用client-go提供的dynamicClient来操作自定义资源对象，当然由于dynamicClient是基于RESTClient实现的，所以可以使用RESTClient来达到同样的目的。
• 使用conde-generator来生成客户端代码，这样就可以像使用client-go为k8s内置资源对象提供的方式监听和操作自定义资源了。

项目地址：https://github.com/kubernetes/code-generator

框架构建

要先生成整体的客户端代码，首先需要打下框架。

来自红帽的一段博文——

Kubernetes Deep Dive: Code Generation for CustomResources

为了操作方便，我将项目新建于环境变量$GOPATH目录下，并且在go.mod中将pkg声明成我的github repository地址： 

module github.com/octoboy233/ops-operator

既然是Operator，那么也需要先引入依赖

go get -u sigs.k8s.io/controller-runtime

复制代码https://github.com/kubernetes/code-generator/tree/master/examples/crd/apis/example/v1 放到ops-operator/pkg/extensions/operation/v1下面。ops-operator是我的项目名称，extensions是GVK的Group中的抬头，operation是我的CRD的名称，v1则是GVK的Version。

然后需要根据CRD的申明字段做一些客制化的修改，这里的代码主要是用于Controller调用client-go过程中对对象的一些反序列化操作，以及对外暴露的注册到Manager 的Scheme的函数方法。

代码注入

将https://github.com/kubernetes/code-generator/releases/tag/v0.22.18-rc.0 拷贝到$GOPATH，需要借助源码中的一段脚本来生成代码。

最后通过脚本传入一定参数，来执行命令

$GOPATH/src/k8s.io/code-generator/generate-groups.sh all  github.com/octoboy233/ops-operator/pkg/client github.com/octoboy233/ops-operator/pkg/extensions operation:v1

文中的一些可变参数都已经在上文中提及。

测试

集群环境中已有一个存量对象，接下来，编写一段测试代码，来获取它的结构化数据。

% kubectl get ops
NAME    AGE
myops   45m

无脑Get就完事了～

package main

import (
	"context"
	"fmt"
	v1 "github.com/octoboy233/ops-operator/pkg/client/clientset/versioned/typed/operation/v1"
	"github.com/octoboy233/ops-operator/pkg/kube"
	v12 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

func main() {
	cli, _ := v1.NewForConfig(kube.InitConfig())
	r, _ := cli.Operations("default").Get(context.Background(), "myops", v12.GetOptions{})
	fmt.Println(r)
}

此外，查看生成的代码目录，还支持Clientset以外的informer、lister的扩展。

至此，通过代码生成工具，针对operator中CRD提供监听和操作自定义资源的方式就完成了。