项目配置

概述

项目配置表示一个 KubeBuilder 项目的配置。所有通过 CLI （KubeBuilder 版本 3.0 及更高版本）搭建的项目将在项目根目录生成 PROJECT 文件。因此，它将存储生成项目和 API 所使用的所有插件和输入数据，以便更好地支持插件在搭建时做出有用的决策。

Example

以下是一个项目配置文件的示例，这是使用部署镜像插件生成的包含两个API的项目的结果。

# 工具生成的代码。请勿编辑。
# 此文件用于跟踪用于搭建您项目的信息
# 并允许插件正常工作。
# 更多信息： https://book.kubebuilder.io/reference/project-config.html
domain: testproject.org
layout:
  - go.kubebuilder.io/v4
plugins:
  部署图像.go.kubebuilder.io/v1-alpha:
    resources:
      - domain: testproject.org
        group: example.com
        kind: Memcached
        选项:
          容器命令: memcached,--memory-limit=64,-o,modern,-v
          容器端口: "11211"
          image: memcached:1.4.36-alpine
          以用户身份运行: "1001"
        version: v1alpha1
      - domain: testproject.org
        group: example.com
        kind: Busybox
        选项:
          image: busybox:1.28
        version: v1alpha1
projectName: 项目-v4-带部署镜像
repo: sigs.k8s.io/kubebuilder/testdata/project-v4-with-deploy-image
resources:
  - api:
      crdVersion: v1
      namespaced: true
    controller: true
    domain: testproject.org
    group: example.com
    kind: Memcached
    path: sigs.k8s.io/kubebuilder/testdata/project-v4-with-deploy-image/api/v1alpha1
    version: v1alpha1
    webhooks:
      validation: true
      webhookVersion: v1
  - api:
      crdVersion: v1
      namespaced: true
    controller: true
    domain: testproject.org
    group: example.com
    kind: Busybox
    path: sigs.k8s.io/kubebuilder/testdata/project-v4-with-deploy-image/api/v1alpha1
    version: v1alpha1
version: "3"

为什么我们需要存储插件和使用的数据？

以下是一些追踪使用输入的动机示例：

• 检查一个插件是否可以在现有插件的基础上创建（即）插件兼容性，同时将多个插件连接在一起。
• 可以进行或不能进行的操作，例如验证当前配置是否允许为不同组搭建API的布局。
• 验证在CLI操作中可以或不能使用哪些数据，例如确保WebHooks只能为已存在的API创建。

请注意，KubeBuilder 不仅是一个 CLI 工具，还可以用作库，让用户创建他们的插件/工具，提供帮助程序和定制，以支持他们现有的项目 - 其中一个例子是 Operator-SDK。SDK 利用 KubeBuilder 创建插件，允许用户使用其他语言，并为用户提供帮助，以便他们将项目与例如 Operator Framework 解决方案/OLM 集成。您可以查看 插件文档 以了解更多关于创建自定义插件的信息。

此外，PROJECT 文件的另一个目的，是帮助我们创建一个功能，使用户能够通过提供自动重新搭建项目的辅助工具，轻松升级他们的项目。PROJECT 文件中包含了有关 API、其配置和版本的所有必要元数据。例如，它可以用于自动化在插件版本之间迁移时重新搭建的过程。 (更多信息)。

版本控制

项目配置是根据其布局进行版本控制的。欲了解更多信息，请参见 版本控制。

布局定义

PROJECT 版本 3 的布局如下：

domain: testproject.org
layout:
  - go.kubebuilder.io/v4
plugins:
  部署图像.go.kubebuilder.io/v1-alpha:
    resources:
      - domain: testproject.org
        group: example.com
        kind: Memcached
        选项:
          容器命令: memcached,--memory-limit=64,-o,modern,-v
          容器端口: "11211"
          image: memcached:memcached:1.6.26-alpine3.19
          以用户身份运行: "1001"
        version: v1alpha1
      - domain: testproject.org
        group: example.com
        kind: Busybox
        选项:
          image: busybox:1.36.1
        version: v1alpha1
projectName: 项目-v4-带部署镜像
repo: sigs.k8s.io/kubebuilder/testdata/project-v4-with-deploy-image
resources:
  - api:
      crdVersion: v1
      namespaced: true
    controller: true
    domain: testproject.org
    group: example.com
    kind: Memcached
    path: sigs.k8s.io/kubebuilder/testdata/project-v4-with-deploy-image/api/v1alpha1
    version: v1alpha1
    webhooks:
      validation: true
      webhookVersion: v1
  - api:
      crdVersion: v1
      namespaced: true
    controller: true
    domain: testproject.org
    group: example.com
    kind: Busybox
    path: sigs.k8s.io/kubebuilder/testdata/project-v4-with-deploy-image/api/v1alpha1
    version: v1alpha1
version: "3"

现在让我们检查一下它的布局字段定义：