如何使用client-go监听Kubernetes自定义CRD ApiGateway资源变更？

先给你吃颗定心丸：完全可以用k8s.io/client-go监听自定义CRD资源！标准client-go库只包含K8s内置资源的类型定义，你的ApiGateway是自定义CRD，所以需要额外生成对应的客户端代码和类型定义，之后就能和监听标准资源一样顺手操作了。

下面是具体的实现步骤，一步步来：

1. 确认CRD状态与准备类型定义 #

首先确保你的ApiGateway CRD已经成功部署到集群里，用这条命令验证：

kubectl get crd apigateways.your-group.example.com  # 替换成你的CRD实际Group和名称

你还需要有该CRD对应的Go类型定义（一般放在types.go文件里），示例结构如下：

package apigatewayv1

import (
    metav1 "k8s.io/apimachinery/pkg/apis/meta/v1"
)

// ApiGatewaySpec 定义ApiGateway的期望状态
type ApiGatewaySpec struct {
    // 这里写你的自定义字段，比如：
    ServiceName string `json:"serviceName"`
    Port        int32  `json:"port"`
}

// ApiGatewayStatus 定义ApiGateway的实际状态
type ApiGatewayStatus struct {
    // 这里写状态相关字段，比如：
    Ready bool `json:"ready"`
}

//+kubebuilder:object:root=true
//+kubebuilder:subresource:status

// ApiGateway 是apigateways API的Schema
type ApiGateway struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`

    Spec   ApiGatewaySpec   `json:"spec,omitempty"`
    Status ApiGatewayStatus `json:"status,omitempty"`
}

//+kubebuilder:object:root=true

// ApiGatewayList 包含一组ApiGateway实例
type ApiGatewayList struct {
    metav1.TypeMeta `json:",inline"`
    metav1.ListMeta `json:"metadata,omitempty"`
    Items           []ApiGateway `json:"items"`
}

2. 生成CRD对应的client-go代码 #

要操作自定义CRD，需要生成对应的客户端代码，推荐两种方式：

方式一：用kubebuilder快速生成（更推荐） #

如果你用kubebuilder初始化项目，只需要执行这条命令，它会自动帮你生成类型定义、CRD YAML，还有对应的client-go客户端代码：

kubebuilder create api --group apigateway --version v1 --kind ApiGateway

后续执行make generate和make manifests就能更新代码和CRD配置。

方式二：用client-gen手动生成 #

如果不想用kubebuilder，也可以用官方的client-gen工具：

1. 把类型定义放在pkg/apis/<group>/<version>目录下，符合client-gen的结构要求
2. 执行生成命令：

client-gen --clientset-name versioned --input-base "your-project/pkg/apis" --input "apigateway/v1" --output-package "your-project/pkg/client/clientset/versioned"

这会生成类似标准kubernetes.Clientset的自定义资源客户端。

3. 初始化客户端并创建Informer监听 #

生成代码后，就可以像监听标准资源一样创建Informer，监听ApiGateway的新增、变更、删除事件了。示例代码如下：

package main

import (
    "time"

    "k8s.io/client-go/tools/cache"
    "k8s.io/client-go/tools/clientcmd"
    "k8s.io/klog/v2"

    // 导入你生成的自定义资源clientset和类型
    apigatewayclientset "your-project/pkg/client/clientset/versioned"
    apigatewayv1 "your-project/pkg/apis/apigateway/v1"
    apigatewayinformers "your-project/pkg/client/informers/externalversions/apigateway/v1"
)

func main() {
    // 加载kubeconfig（本地开发用，集群内运行用rest.InClusterConfig()）
    config, err := clientcmd.BuildConfigFromFlags("", "/path/to/your/kubeconfig")
    if err != nil {
        klog.Fatalf("加载配置失败: %v", err)
    }

    // 初始化自定义资源的clientset
    apigatewayClient, err := apigatewayclientset.NewForConfig(config)
    if err != nil {
        klog.Fatalf("创建ApiGateway客户端失败: %v", err)
    }

    // 创建ApiGateway的Informer工厂
    informerFactory := apigatewayinformers.NewSharedInformerFactory(apigatewayClient, time.Minute*30)
    apigatewayInformer := informerFactory.Apigateway().V1().ApiGateways()

    // 注册事件处理函数
    apigatewayInformer.Informer().AddEventHandler(cache.ResourceEventHandlerFuncs{
        AddFunc: func(obj interface{}) {
            gw := obj.(*apigatewayv1.ApiGateway)
            klog.Infof("ApiGateway已新增: %s/%s", gw.Namespace, gw.Name)
            // 这里写你的新增逻辑，比如同步配置到网关等
        },
        UpdateFunc: func(oldObj, newObj interface{}) {
            oldGw := oldObj.(*apigatewayv1.ApiGateway)
            newGw := newObj.(*apigatewayv1.ApiGateway)
            klog.Infof("ApiGateway已更新: %s/%s", newGw.Namespace, newGw.Name)
            // 这里写你的变更逻辑，比如更新网关配置等
        },
        DeleteFunc: func(obj interface{}) {
            gw := obj.(*apigatewayv1.ApiGateway)
            klog.Infof("ApiGateway已删除: %s/%s", gw.Namespace, gw.Name)
            // 这里写你的删除逻辑，比如清理网关资源等
        },
    })

    // 启动Informer
    stopCh := make(chan struct{})
    defer close(stopCh)
    informerFactory.Start(stopCh)

    // 等待缓存同步完成
    if !cache.WaitForCacheSync(stopCh, apigatewayInformer.Informer().HasSynced) {
        klog.Fatalf("等待缓存同步失败")
    }

    // 保持程序运行
    <-stopCh
}

几个关键注意点 #

• 自定义资源类型必须包含TypeMeta和ObjectMeta，这是client-go识别资源的基础
• 如果是在集群内运行的程序，不需要指定kubeconfig路径，改用rest.InClusterConfig()加载配置
• Informer用缓存机制，能大幅减少对API Server的请求压力，比直接用REST Client轮询高效得多

内容的提问来源于stack exchange，提问作者christian