Quay Operator 项目教程

1. 项目目录结构及介绍

Quay Operator 是一个用于在 Kubernetes 上部署和管理 Quay 容器注册中心的 Kubernetes Operator。以下是项目的目录结构及其简要介绍：

.
├── .chglog            # 变更日志配置
├── .github            # GitHub 工作流和配置
├── .gitignore         # Git 忽略文件
├── apis/              # 定义 QuayRegistry CRD 的 API
│   └── quay/
│       └── v1/
├── bundle/            # 包含 Operator 的打包和部署文件
├── config/            # 配置文件和示例
├── controllers/       # 包含 Quay Operator 的控制器逻辑
├── docs/              # 文档
├── e2e/               # 端到端测试
├── hack/              # 包含部署和测试的脚本
├── kustomize/         # Kustomize 配置
├── main.go            # Operator 的入口文件
├── pkg/               # 包含 Operator 的业务逻辑
├── vendor/            # 依赖的第三方库
├── Dockerfile         # Operator Docker 镜像构建文件
├── Dockerfile.osbs    # OSBS 专用的 Docker 镜像构建文件
├── LICENSE            # Apache 2.0 许可证文件
├── Makefile           # Makefile 文件，包含构建和测试的命令
├── PROJECT            # 项目配置文件
├── README.md          # 项目说明文件
├── go.mod             # Go 依赖管理文件
├── go.sum             # Go 依赖校验文件
└── kuttl-test.yaml    # kuttl 测试文件

2. 项目的启动文件介绍

main.go 是 Quay Operator 的启动文件。它负责初始化 Operator 的各种组件，并启动 Operator。以下是 main.go 文件的主要部分：

package main

import (
    "context"
    "fmt"
    "os"
    "path/filepath"

    "k8s.io/apimachinery/pkg/runtime"
    "sigs.k8s.io/controller-runtime/pkg/client"
    "sigs.k8s.io/controller-runtime/pkg/ctrl"
    "sigs.k8s.io/controller-runtime/pkg/manager"
    "sigs.k8s.io/controller-runtime/pkg/manager/signals"

    quayv1 "github.com/quay/quay-operator/apis/quay/v1"
    controllers "github.com/quay/quay-operator/controllers"
)

func main() {
    // 初始化日志和信号处理
    setupLog := ctrl.SetLogger(zap.New(zap.UseDevMode(true)))
    sigs := make(chan os.Signal, 1)
    signals.Notify(sigs, os.Interrupt)

    // 创建 Manager
    ctx, cancel := context.WithCancel(context.Background())
    defer cancel()
    mgr, err := ctrl.NewManager(ctrl.GetConfigOrDie(), ctrl.Options{
        Scheme: runtime.NewScheme(),
    })
    if err != nil {
        setupLog.Error(err, "无法创建 manager")
        os.Exit(1)
    }

    // 注册 QuayRegistry CRD
    if err = quayv1.AddToScheme(mgr.GetScheme()); err != nil {
        setupLog.Error(err, "无法注册 QuayRegistry CRD")
        os.Exit(1)
    }

    // 注册控制器
    if err = controllers.NewQuayReconciler(mgr.GetClient(), mgr.GetScheme()).SetupWithManager(mgr); err != nil {
        setupLog.Error(err, "无法注册控制器")
        os.Exit(1)
    }

    // 启动 Manager
    if err := mgr.Start(signals.SetupSignalHandler()); err != nil {
        setupLog.Error(err, "Manager 启动失败")
        os.Exit(1)
    }
}

3. 项目的配置文件介绍

项目的配置文件主要位于 config/ 目录下，包括以下文件：

• managed.quayregistry.yaml：这是 QuayRegistry CRD 的示例配置文件，用于创建和管理 Quay 实例。
• quay-operator.catalogsource.yaml：用于创建 CatalogSource，使得 Operator 可在 Kubernetes 集群中安装。
• quay-operator.operatorgroup.yaml：用于创建 OperatorGroup，指定哪些命名空间下的资源由 Operator 管理。
• quay-operator.subscription.yaml：用于创建 Subscription，使得集群可以订阅和安装 Operator。

这些配置文件在使用时需要根据具体的需求进行适当的修改。例如，managed.quayregistry.yaml 文件可能需要修改命名空间和其他配置参数，以符合实际部署 Quay 实例的需求。