Operator SDK Helm 教程：构建基于 Helm 的 Kubernetes Operator-优快云博客

本文链接：https://blog.youkuaiyun.com/gitblog_00547/article/details/148464114

Operator SDK Helm 教程：构建基于 Helm 的 Kubernetes Operator

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

前言

在现代云原生生态中，Kubernetes Operator 已经成为管理复杂应用的标准模式。Operator SDK 作为 Operator Framework 的核心组件，提供了多种开发 Operator 的方式。本文将重点介绍如何使用 Operator SDK 的 Helm 插件来构建 Operator，这种方式特别适合已经熟悉 Helm 的开发者。

准备工作

在开始之前，请确保满足以下条件：

已完成 Operator SDK 的安装
当前用户具有集群管理员权限
拥有可访问的镜像仓库（如公共镜像仓库或 Quay.io）并已登录
如果是私有仓库，需要配置好认证和证书

项目概述

我们将创建一个名为 nginx-operator 的示例项目，该 Operator 将实现以下功能：

当 Nginx 自定义资源(CR)创建时，自动部署 Nginx
确保 Deployment 的副本数与 CR 中指定的数量一致

创建新项目

使用以下命令创建基于 Helm 的 Operator 项目：

mkdir nginx-operator
cd nginx-operator
operator-sdk init --plugins helm --domain example.com --group demo --version v1alpha1 --kind Nginx

这个命令会创建一个专门用于监控 APIVersion 为 demo.example.com/v1alpha1、Kind 为 Nginx 的资源项目。

使用现有 Helm Chart

Operator SDK 支持使用现有的 Helm Chart，可以通过以下参数指定：

--helm-chart: 指定本地或远程的 Chart
--helm-chart-repo: 指定 Chart 仓库地址
--helm-chart-version: 指定 Chart 版本

当使用 --helm-chart 时，其他参数如 --group、--version 和 --kind 变为可选。

自定义 Operator 逻辑

我们的 nginx-operator 将为每个 Nginx CR 执行以下协调逻辑：

如果不存在则创建 Nginx Deployment
如果不存在则创建 Nginx Service
如果启用则创建 Nginx Ingress
确保 Deployment、Service 和 Ingress 的配置与 CR 中指定的期望状态一致

监控 Nginx CR

默认情况下，Operator 会监控 watches.yaml 中定义的 Nginx 资源事件：

- group: demo
  version: v1alpha1
  kind: Nginx
  chart: helm-charts/nginx

理解 Nginx Helm Chart

创建项目时，SDK 会生成一个示例 Helm Chart，包含 Deployment、Service 和 Ingress 的模板。这些模板位于 helm-charts/nginx/templates 目录下。

理解 Nginx CR 规范

Helm 使用 values 来自定义 Chart 的默认配置。在 Operator 中，这些值通过 CR 的 spec 部分设置。例如：

replicaCount 控制副本数
service.port 控制服务端口

示例 CR：

apiVersion: demo.example.com/v1alpha1
kind: Nginx
metadata:
  name: nginx-sample
spec:
  replicaCount: 2
  service:
    port: 8080

配置 Operator 镜像

在 Makefile 中设置镜像标签：

IMG ?= $(IMAGE_TAG_BASE):$(VERSION)

然后构建并推送镜像：

make docker-build docker-push

运行 Operator

有三种方式运行 Operator：

1. 在集群外本地运行

make install run

2. 作为 Deployment 在集群内运行

make deploy

验证部署：

kubectl get deployment -n nginx-operator-system

3. 使用 OLM 部署

首先安装 OLM：

operator-sdk olm install

然后构建并推送 Bundle：

make bundle bundle-build bundle-push

最后运行 Bundle：

operator-sdk run bundle example.com/nginx-operator-bundle:v0.0.1

创建 Nginx CR

应用示例 CR：

kubectl apply -f config/samples/demo_v1alpha1_nginx.yaml

验证资源创建：

kubectl get deployment
kubectl get pods
kubectl get service

更新和清理

更新 CR 后重新应用：

kubectl apply -f config/samples/demo_v1alpha1_nginx.yaml

清理资源：

kubectl delete -f config/samples/demo_v1alpha1_nginx.yaml
make undeploy

总结

通过 Operator SDK 的 Helm 插件，我们可以快速将现有的 Helm Chart 转化为功能完整的 Operator。这种方式既保留了 Helm 的易用性，又获得了 Operator 的自动化管理能力，是 Helm 用户进阶到 Operator 开发的理想路径。

对于更高级的功能，如指标暴露、Webhook 等，可以参考 Operator SDK 的高级特性文档。对于生产环境部署，建议使用 OLM 来管理 Operator 的生命周期。

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