Operator SDK 示例项目教程

项目介绍

Operator SDK 是一个用于构建 Kubernetes 扩展的框架，它简化了创建、构建和部署 Kubernetes 自定义资源（CRD）的过程。通过 Operator SDK，开发者可以更容易地编写和管理 Kubernetes 应用的生命周期。

Operator SDK 示例项目（https://github.com/operator-framework/operator-sdk-samples）提供了多种语言和框架的示例，包括 Go、Ansible 和 Helm，帮助开发者快速上手并理解如何使用 Operator SDK 创建自己的 Operator。

项目快速启动

环境准备

在开始之前，请确保你已经安装了以下工具：

• Go (版本 >= 1.13)
• Kubernetes 集群（可以使用 Minikube 或 Docker Desktop 提供的 Kubernetes）
• Operator SDK CLI

安装 Operator SDK CLI

你可以通过以下命令安装 Operator SDK CLI：

$ export ARCH=$(case $(uname -m) in x86_64) echo -n amd64 ;; aarch64) echo -n arm64 ;; *) echo -n $(uname -m) ;; esac)
$ export OS=$(uname | awk '{print tolower($0)}')
$ export OPERATOR_SDK_DL_URL=https://github.com/operator-framework/operator-sdk/releases/download/v1.8.0
$ curl -LO ${OPERATOR_SDK_DL_URL}/operator-sdk_${OS}_${ARCH}
$ chmod +x operator-sdk_${OS}_${ARCH}
$ sudo mv operator-sdk_${OS}_${ARCH} /usr/local/bin/operator-sdk

创建一个新的 Operator 项目

使用 Operator SDK CLI 创建一个新的 Operator 项目：

$ mkdir -p $HOME/projects/example-operator
$ cd $HOME/projects/example-operator
$ operator-sdk init --domain=example.com --repo=github.com/example/example-operator

添加 API 和控制器

添加一个新的 API 和控制器：

$ operator-sdk create api --group cache --version v1 --kind Memcached --resource --controller

编写业务逻辑

编辑 controllers/memcached_controller.go 文件，添加你的业务逻辑。例如：

package controllers

import (
	"context"
	"github.com/example/example-operator/api/v1alpha1"
	"k8s.io/apimachinery/pkg/runtime"
	ctrl "sigs.k8s.io/controller-runtime"
	"sigs.k8s.io/controller-runtime/pkg/client"
	"sigs.k8s.io/controller-runtime/pkg/log"
)

type MemcachedReconciler struct {
	client.Client
	Scheme *runtime.Scheme
}

func (r *MemcachedReconciler) Reconcile(ctx context.Context, req ctrl.Request) (ctrl.Result, error) {
	_ = log.FromContext(ctx)

	// 你的业务逻辑

	return ctrl.Result{}, nil
}

func (r *MemcachedReconciler) SetupWithManager(mgr ctrl.Manager) error {
	return ctrl.NewControllerManagedBy(mgr).
		For(&v1alpha1.Memcached{}).
		Complete(r)
}

构建和部署

构建并部署你的 Operator：

$ make docker-build docker-push IMG=quay.io/example/example-operator:v0.0.1
$ make deploy IMG=quay.io/example/example-operator:v0.0.1

应用案例和最佳实践

应用案例

Operator SDK 可以用于管理各种复杂的应用，例如数据库、消息队列和分布式存储系统。一个典型的应用案例是使用 Operator 来管理一个分布式数据库，如 Cassandra 或 etcd。

最佳实践

• 模块化设计：将 Operator 的逻辑分解为多个模块，便于维护和扩展。
• 测试覆盖：编写单元测试和集成测试，确保 Operator 的稳定性和可靠性。
• 文档完善：提供详细的文档和示例，帮助用户快速上手。

典型生态项目

Operator SDK 与其他 Kubernetes 生态项目紧密集成，例如：

• Kustomize：用于管理