Kubebuilder项目从v0到v1版本的迁移指南-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00596/article/details/148440509

Kubebuilder项目从v0到v1版本的迁移指南

kubebuilder Kubebuilder - SDK for building Kubernetes APIs using CRDs 项目地址: https://gitcode.com/gh_mirrors/ku/kubebuilder

前言

Kubebuilder作为Kubernetes官方推荐的Operator开发框架，经历了从v0到v1的重大架构升级。本文将详细介绍如何将基于Kubebuilder v0版本创建的项目迁移到v1版本，帮助开发者顺利完成项目升级。

版本差异概述

在开始迁移前，开发者需要了解两个版本之间的主要差异：

项目结构变化：v1版本采用了更标准化的项目布局
控制器实现差异：Reconcile函数的签名和实现方式有显著变化
客户端交互方式：v1版本统一使用runtime.Client接口
依赖管理：v1版本使用更现代的依赖管理方式

迁移步骤详解

1. 初始化v1项目

首先需要创建一个新的v1项目骨架：

kubebuilder init --project-version v1 --domain <your-domain>

这里的domain需要从原项目的pkg/apis/doc.go文件中获取。

2. 创建API资源

对于每个自定义资源(CRD)，需要执行：

kubebuilder create api --group <group> --version <version> --kind <Kind>

注意：

group和version对应原项目pkg/apis下的目录名
Kind名称需要首字母大写
如果原项目有多个CRD，需要为每个CRD重复此步骤

3. 迁移类型定义

将原项目的<type>_types.go文件内容复制到新项目中，但需要保留v1项目自动生成的<type>List结构和init函数。

示例保留部分：

// +k8s:deepcopy-gen:interfaces=k8s.io/apimachinery/pkg/runtime.Object
// +genclient:nonNamespaced

// HelloList contains a list of Hello
type HelloList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Hello `json:"items"`
}

func init() {
	SchemeBuilder.Register(&Hello{}, &HelloList{})
}

4. 控制器代码迁移

Reconcile函数改造

v0和v1版本的Reconcile函数签名不同：

v0版本：func (bc *<kind>Controller) Reconcile(k types.ReconcileKey) error
v1版本：func (r *Reconcile<kind>) Reconcile(request reconcile.Request) (reconcile.Result, error)

迁移时需要：

复制函数体内容
修改所有return语句，添加reconcile.Result{}作为第一个返回值
更新客户端调用方式

客户端调用转换示例

| v0版本调用 | v1版本等效调用 | |------------|----------------| | bc.memcachedLister.Memcacheds(k.Namespace).Get(k.Name) | r.Client.Get(context.TODO(), request.NamespacedName, mc) | | bc.KubernetesInformers.Apps().V1().Deployments().Lister().Deployments(mc.Namespace).Get(mc.Name) | r.Client.Get(context.TODO(), request.NamespacedName, dp) | | bc.KubernetesClientSet.AppsV1().Deployments(mc.Namespace).Create(dep) | r.Client.Create(context.TODO(), dep) | | bc.KubernetesClientSet.AppsV1().Deployments(mc.Namespace).Update(deploymentForMemcached(mc)) | r.Client.Update(context.TODO(), dep) | | bc.KubernetesInformers.Core().V1().Pods().Lister().Pods(mc.Namespace).List(labelSelector) | r.Client.List(context.TODO(), &client.ListOptions{LabelSelector: labelSelector}, pods) |

Watch机制改造

v0版本中的ProvideController函数在v1中对应add函数。需要将watch调用转换为新格式：

// v0版本
gc.Watch(&myappsv1alpha1.Memcached{})
gc.WatchControllerOf(&v1.Pod{}, eventhandlers.Path{...})

// v1版本
c.Watch(&source.Kind{Type: &myappsv1alpha1.Memcached{}}, &handler.EnqueueRequestForObject{})
c.Watch(&source.Kind{Type: &appsv1.Deployment{}}, &handler.EnqueueRequestForOwner{
    IsController: true,
    OwnerType:    &myappsv1alpha1.Memcached{},
})