Operator SDK 版本升级指南：从 v0.2.x 到 v0.17.x 全面解析-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_01172/article/details/148464127

Operator SDK 版本升级指南：从 v0.2.x 到 v0.17.x 全面解析

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

前言

Operator SDK 作为 Kubernetes Operator 开发的核心工具链，其版本迭代过程中包含了大量功能增强和 API 改进。本文将深入剖析从 v0.2.x 到 v0.17.x 的升级路径，帮助开发者顺利完成项目迁移。

升级基本原则

在开始具体版本升级前，开发者需要了解以下核心原则：

依赖管理：大多数情况下只需更新 Gopkg.toml 或 go.mod 文件中的 SDK 依赖版本
兼容性检查：部分版本可能要求同步更新 Kubernetes 和 controller-runtime 依赖
破坏性变更：重大版本升级通常伴随项目结构或 API 的变化，需特别关注变更日志

分版本升级指南

v0.2.x 升级要点

[[constraint]]
  name = "github.com/operator-framework/operator-sdk"
  version = "=v0.2.1"

执行 dep ensure 更新 vendor 目录，这是早期版本最简单的升级方式。

v0.3.x 重要变更

此版本需要同步更新多个核心依赖：

[[override]]
  name = "k8s.io/api"
  revision = "b503174bad5991eb66f18247f52e41c3258f6348"  # kubernetes-1.12.3

[[override]]
  name = "sigs.k8s.io/controller-runtime"
  version = "=v0.1.8"

特别注意 controller-runtime 升级到 v0.1.8，这引入了新的协调器机制。

v0.5.x 依赖调整

此版本新增了多个工具链依赖：

[[override]]
  name = "sigs.k8s.io/controller-tools"
  version = "=v0.1.8"

同时需要修改 required 部分，将 openapi-gen 路径从 k8s.io/code-generator 迁移到 k8s.io/kube-openapi。

v0.6.x OLM 目录格式变更

Operator Lifecycle Manager (OLM) 目录结构改为 registry 清单格式：

deploy/olm-catalog/
└── memcached-operator
    ├── 0.1.0
    │   └── memcached-operator.v0.1.0.clusterserviceversion.yaml
    └── memcached-operator.package.yaml

开发者需要使用新的 operator-sdk olm-catalog gen-csv 命令生成 CSV 文件。

v0.8.x Go Modules 支持

这是 SDK 支持 Go Modules 的第一个版本，开发者可选择：

保持 dep：更新约束并固定 controller-tools 版本
迁移到 Modules：
- 初始化 go.mod 文件
- 添加必要的 replace 指令
- 运行 go mod tidy 清理依赖

关键变更：

CRD 生成现在完全基于源码中的 marker 注释
必须使用 // +kubebuilder 注释来定义 CRD 规范

// +kubebuilder:subresource:status
// +kubebuilder:resource:shortName="mc"
// +genclient:nonNamespaced
type Memcached struct {
    metav1.TypeMeta   `json:",inline"`
    metav1.ObjectMeta `json:"metadata,omitempty"`
    ...
}

v0.9.x 监控指标变更

ExposeMetricsPort() 函数被 CreateMetricsService() 替代：

servicePorts := []v1.ServicePort{
    {Port: metricsPort, Name: metrics.OperatorPortName...},
    {Port: operatorMetricsPort, Name: metrics.CRPortName...},
}
_, err = metrics.CreateMetricsService(ctx, servicePorts)