Operator-SDK项目迁移指南：从pre-v1.0.0版本升级到最新版-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00267/article/details/148464100

Operator-SDK项目迁移指南：从pre-v1.0.0版本升级到最新版

operator-sdk Operator SDK是一个开源的Kubernetes Operator开发框架，用于简化Kubernetes应用程序的部署、管理和升级。 - 功能：Kubernetes Operator开发；应用程序管理；部署；升级。 - 特点：易于使用；支持多种编程语言；与Kubernetes集成；自动化部署和管理。项目地址: https://gitcode.com/gh_mirrors/op/operator-sdk

概述

随着Operator-SDK项目的发展，从1.0.0版本开始采用了Kubebuilder风格的布局结构。这种变化为用户带来了更大的灵活性，也是Operator-SDK与Kubebuilder项目整合的重要一步。本文将详细介绍如何将pre-v1.0.0版本（0.19.x+）构建的Go项目迁移到最新版本。

迁移前的准备工作

在开始迁移之前，建议您：

确保项目已升级到最新的SDK v1.y版本
备份现有项目代码
熟悉Kubebuilder的基本概念和项目结构

项目结构变化详解

主要目录结构变更

deploy目录被config目录取代，包含新的Kubernetes清单文件布局：
- CRD清单从deploy/crds/移动到config/crd/bases
- CR示例从deploy/crds/移动到config/samples
- 控制器清单从deploy/operator.yaml移动到config/manager/manager.yaml
- RBAC清单从deploy移动到config/rbac/

文件位置变更

build/Dockerfile移动到项目根目录
pkg/apis和pkg/controllers移动到根目录
cmd/manager/main.go移动到根目录

新增功能特性

新版本项目脚手架包含：

使用kustomize管理部署Operator所需的Kubernetes资源
提供包含构建、测试、部署等有用目标的Makefile
支持webhook的辅助工具和选项
更新了指标配置，使用kube-auth-proxy和metrics-addr标志
使用envtest测试框架的脚手架测试
初步支持CLI插件
新增PROJECT配置文件存储GVK和插件信息
支持使用ComponentConfig创建项目的选项
默认使用Go 1.15版本

详细迁移步骤

1. 创建新项目

首先需要确定API的域(domain)，查看现有项目中CRD的spec.group字段。例如，对于cache.example.com，域就是example.com。

mkdir memcached-operator
cd memcached-operator
operator-sdk init --domain example.com --repo github.com/example/memcached-operator

2. 检查是否为多组项目

如果项目包含多个API组（如foo.example.com和crew.example.com），需要启用多组支持：

operator-sdk edit --multigroup=true

3. 迁移API和控制器

为每个API重新创建：

operator-sdk create api \
    --group=cache \
    --version=v1alpha1 \
    --kind=Memcached \
    --resource \
    --controller

API类型迁移注意事项

将pkg/apis/<group>/<version>/<kind>_types.go复制到api/<version>/<kind>_types.go
注意标记符的变化：
- +k8s:deepcopy-gen:interfaces=...替换为+kubebuilder:object:root=true
- 如果不使用openapi-gen，可以移除相关标记

4. Webhook迁移（如适用）

为每个需要webhook的API创建：

operator-sdk create webhook \
    --group=cache \
    --version=v1alpha1 \
    --kind=Memcached \
    --defaulting \
    --programmatic-validation

5. 控制器迁移

将控制器逻辑从pkg/controller/<kind>/<kind>_controller.go迁移到controllers/<kind>_controller.go：

复制结构体字段到新的<Kind>Reconciler结构体
替换reconcile逻辑
更新Watch机制为新的Builder模式

6. RBAC权限设置

RBAC权限现在通过标记符配置，例如：

//+kubebuilder:rbac:groups=cache.example.com,resources=memcacheds,verbs=get;list;watch;create;update;patch;delete
//+kubebuilder:rbac:groups=cache.example.com,resources=memcacheds/status,verbs=get;update;patch

更新后运行make manifests生成RBAC清单。

7. 主程序迁移

将cmd/manager/main.go中的自定义逻辑迁移到新的main.go，注意：

领导者选举机制变化
默认指标端口改为8080
OPERATOR_NAME和POD_NAME环境变量不再使用

8. 测试迁移

新项目使用envtest框架进行集成测试，需要将现有测试迁移到新的测试框架。

9. 自定义资源迁移

将CR示例从deploy/crds/复制到config/samples/目录。

10. 操作符配置迁移

将deploy/operator.yaml中的自定义配置迁移到config/manager/manager.yaml。

常见问题解决方案

保持使用v1beta1版本的CRD

如果需要支持Kubernetes 1.15及更早版本，可以使用--crd-version=v1beta1标志：

operator-sdk create api --group=cache --version=v1alpha1 --kind=Memcached --crd-version=v1beta1

Prometheus指标配置

确保集群中已安装Prometheus Operator
取消config/default/kustomization.yaml中关于ServiceMonitor的注释
运行make deploy部署更新

迁移后的验证

完成迁移后，建议：

运行单元测试和集成测试
在测试环境中部署Operator
验证CRD创建和资源调和功能
检查指标和健康端点是否正常工作

通过以上步骤，您应该能够成功将pre-v1.0.0版本的Operator项目迁移到最新版本，享受新版本带来的各项改进和功能增强。

创作声明：本文部分内容由AI辅助生成（AIGC），仅供参考