Kubebuilder 教程

Kubebuilder 是一个用于构建基于自定义资源定义（CRD）的 Kubernetes API 的框架。本教程将引导您了解其核心组件和工作流程。

1. 项目目录结构及介绍

Kubebuilder 项目通常具有以下标准目录结构：

├── api
│   └── v1 // API 定义所在的包
├── cmd
│   └── controller // 控制器命令的实现
├── config
│   ├── manager
│   │   └── webhook.yaml // Webhook 配置
│   └── rbac.yaml // RBAC 规则
├── controllers // 控制逻辑实现
├── pkg
│   ├── handlers // 处理程序包
│   ├── informers // Informer 实现
│   └── listers // 列表器实现
├── test
│   ├── e2e // 端到端测试
│   └── unit // 单元测试
├── Dockerfile // 构建镜像的 Dockerfile
└── Makefile // 包含构建和部署目标的 Makefile

• api 目录：存放 CRD 的 API 定义。
• cmd/controller：控制器的主要可执行文件，负责启动和管理控制器。
• config 目录：包含了配置文件，如 webhook 和 RBAC 规则。
• controllers：控制器的业务逻辑实现。
• pkg 包含助手函数和通用代码。
• test：测试相关文件，包括单元测试和端到端测试。
• Dockerfile：定义如何构建镜像以运行应用程序。
• Makefile：提供了便捷的构建和部署命令。

2. 项目的启动文件介绍

在 Kubebuilder 中，主要的启动文件是位于 cmd/controller/main.go。这个文件导入了必要的库，创建并运行控制器经理。控制器经理会加载所有的 CRD 并启动相应的控制器实例。

package main

import (
	"sigs.k8s.io/kubebuilder/controllers"
)

func main() {
	if err := controllers.Execute(); err != nil {
		os.Exit(1)
	}
}

controllers.Execute() 函数执行所有必要的初始化步骤，例如注册 CRD、设置日志配置以及运行控制器。

3. 项目的配置文件介绍

• config/manager/webhook.yaml: 这个文件定义了 Admission Webhooks 的配置，例如 MutatingWebhookConfiguration 或 ValidatingWebhookConfiguration，它们可以在资源被创建或更新时进行验证和修改。

apiVersion: admissionregistration.k8s.io/v1
kind:MutatingWebhookConfiguration
metadata:
  name: example-webhook
webhooks:
- name: example.webhook.example.com
  clientConfig:
    service:
      namespace: controller
      name: example
    caBundle: "..." # CA Bundle for webhook server cert
  rules:
  - operations: ["CREATE", "UPDATE"]
    apiGroups: [""]
    apiVersions: ["v1"]
    resources: ["pods"]

• config/rbac.yaml: 这个文件包含了 RBAC 角色和角色绑定，用于授予控制器操作 Kubernetes 资源的权限。

apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRole
metadata:
  name: my-operator
rules:
- apiGroups: ["myapi.example.com"] # 您的 CRD API 组
  resources: ["myresources"] # 您的 CR 名称
  verbs: ["*"]
...
---
apiVersion: rbac.authorization.k8s.io/v1
kind: ClusterRoleBinding
metadata:
  name: my-operator-binding
subjects:
- kind: ServiceAccount
  name: controller-manager
  namespace: default
roleRef:
  kind: ClusterRole
  name: my-operator
  apiGroup: rbac.authorization.k8s.io

通过理解这些核心概念，您就可以开始使用 Kubebuilder 来开发自己的 Kubernetes API 了。要深入了解，请参考官方文档和示例项目。