通过 CRD 代码生成器快速构建 Kubernetes 自定义资源

1. 项目介绍

本项目是一个基于 OpenShift 的 CRD（Custom Resource Definition）代码生成器，旨在简化 Kubernetes 自定义资源的开发过程。它基于 OpenShift 的 oc 工具和 code-generator 库，能够自动生成 CRD 定义、控制器代码、客户端代码等，大幅提高开发效率。

2. 项目快速启动

2.1 安装依赖

# 安装 oc 工具
sudo apt-get install oc

# 安装 code-generator 库
go get -u k8s.io/code-generator

2.2 生成 CRD 代码

1. 创建一个新项目，例如 my-crd：

mkdir my-crd
cd my-crd

2. 初始化 Go 代码库：

go mod init github.com/my-crd/my-crd

3. 创建 CRD 定义文件，例如 myresource.yaml：

apiVersion: apiextensions.k8s.io/v1
kind: CustomResourceDefinition
metadata:
  name: myresources.my-crd.io
spec:
  group: my-crd.io
  versions:
    - name: v1
      served: true
      storage: true
  scope: Namespaced
  names:
    kind: MyResource
    plural: myresources
    singular: myresource
    kind: MyResource
    listKind: MyResourceList
    plural: myresources
    singular: myresource

4. 生成 CRD 代码：

# 进入生成代码的目录
cd hack

# 生成代码
/update-codegen.sh

# 进入生成的代码目录
cd generated

5. 创建控制器代码，例如 controller.go：

package controllers

import (
    "context"
    "k8s.io/apimachinery/pkg/runtime"
    "sigs.k8s.io/controller-runtime/pkg/client"
    "sigs.k8s.io/controller-runtime/pkg/controller"
    "sigs.k8s.io/controller-runtime/pkg/controller/controllerutil"
    "sigs.k8s.io/controller-runtime/pkg/manager"
    "sigs.k8s.io/controller-runtime/pkg/reconcile"
    "sigs.k8s.io/controller-runtime/pkg/log/zap"
    "my-crd.io/my-crd/api/v1"
)

// ReconcileMyResource reconciles a MyResource object
type ReconcileMyResource struct {
    client.Client
    Scheme *runtime.Scheme
}

// +kubebuilder:rbac:groups=my-crd.io,resources=myresources,verbs=get;list;watch;create;update;patch;delete
// +kubebuilder:rbac:groups=my-crd.io,resources=myresources/status,verbs=get;update;patch

func (r *ReconcileMyResource) Reconcile(ctx context.Context, req reconcile.Request) (reconcile.Result, error) {
    log := zap.New(zap.WriteTo(os.Stdout))

    // Your reconciliation logic here

    return reconcile.Result{}, nil
}

func (r *ReconcileMyResource) SetupWithManager(mgr manager.Manager) error {
    return ctrl.NewControllerManagedBy(mgr).
        For(&v1.MyResource{}).
        Complete(r)
}

6. 构建和运行控制器：

go build -o my-crd-controller
./my-crd-controller -kubeconfig=/path/to/kubeconfig

3. 应用案例和最佳实践

3.1 自定义资源监控

使用 CRD 和代码生成器可以轻松创建自定义资源监控，例如监控特定应用的健康状况、资源使用情况等。

3.2 自定义资源编排

利用 CRD 和代码生成器可以构建自定义资源编排工具，例如自动化部署、升级、回滚等操作。

3.3 最佳实践

• 使用版本控制管理 CRD 定义文件，方便跟踪和回滚变更。
• 为自定义资源设计合理的 API，方便使用者进行操作。
• 使用控制器日志记录关键信息，方便问题排查和优化。

4. 典型生态项目

• prometheus-operator：使用 CRD 和代码生成器管理 Prometheus 监控系统。
• kubeadm：使用 CRD 和代码生成器构建 Kubernetes 集群。
• istio：使用 CRD 和代码生成器管理服务网格。