kubebuilder

Kubebuilder 是一个用于使用自定义资源定义（CRDs）构建 Kubernetes API 的框架。

类似于 Ruby on Rails 和 SpringBoot 等 Web 开发框架，Kubebuilder 提高了开发速度并降低了开发人员在快速构建和发布 Go 语言的 Kubernetes API 时所需管理的复杂性。它建立在用于构建核心 Kubernetes API 的规范技术之上，提供简单的抽象，减少了样板代码和繁琐工作。

Kubebuilder 并不是作为一个可以复制粘贴的示例存在，而是提供强大的库和工具，以简化从头开始构建和发布 Kubernetes API 的过程。它提供了一个插件架构，允许用户利用可选的辅助工具和功能。要了解更多信息，请参阅插件部分。

Kubebuilder 是在 controller-runtime 和 controller-tools 库的基础上开发的。

Kubebuilder 也是一个库

Kubebuilder 是可扩展的，可以作为库在其他项目中使用。Operator-SDK 是一个很好的例子，它将 Kubebuilder 作为库使用。Operator-SDK 使用插件功能来包含非 Go 操作符，例如 operator-sdk 的基于 Ansible 和 Helm 的语言操作符。

要了解更多信息，请参阅如何创建自己的插件。

安装

强烈建议使用已发布的版本。发布的二进制文件可在releases页面上找到。按照说明安装 Kubebuilder。

入门

请参阅入门文档。

快速入门

此外，请确保查看 Deploy Image 插件。该插件允许用户搭建 API/控制器来部署和管理集群上的操作对象（镜像），遵循指导原则和最佳实践。它抽象了实现这一目标的复杂性，同时允许用户自定义生成的代码。

文档

查看 Kubebuilder 书籍。

资源

Kubebuilder 书籍：book.kubebuilder.io
GitHub 仓库：kubernetes-sigs/kubebuilder
Slack 频道：#kubebuilder
Google 群组：kubebuilder@googlegroups.com
设计文档：designs
插件：plugins

动机

构建 Kubernetes 工具和 API 涉及做出许多决策和编写大量样板代码。

为了方便使用规范方法轻松构建 Kubernetes API 和工具，该框架提供了一系列 Kubernetes 开发工具，以最大程度地减少繁琐工作。

Kubebuilder 试图促进以下开发者工作流程来构建 API：

创建一个新的项目目录
创建一个或多个资源 API 作为 CRD，然后向资源添加字段
在控制器中实现协调循环并监视其他资源
通过在集群上运行来测试（自动安装 CRD 并启动控制器）
更新引导的集成测试，以测试新字段和业务逻辑
从提供的 Dockerfile 构建并发布容器

范围

使用 CRD、控制器和准入 Webhook 构建 API。

理念

有关各种 Kubebuilder 项目的指导原则，请参阅 DESIGN.md。

简而言之：

提供清晰的库抽象，并附有清晰且有良好示例的 godocs。

优先使用 Go 接口和库，而不是依赖代码生成
优先使用代码生成，而不是一次性初始化存根
优先使用一次性初始化存根，而不是分叉和修改样板代码
永远不要分叉和修改样板代码

技术

在低级客户端库之上提供更高级的库
- 保护开发人员免受低级库中的重大变更影响
- 从最小开始，并提供功能的渐进式发现
- 提供合理的默认值，并允许用户在存在时进行覆盖
提供代码生成器来维护无法通过接口解决的常见样板代码
- 由 // + 注释驱动
提供引导命令来初始化新包

版本控制和发布

请参阅 VERSIONING.md。

故障排除

错误和功能请求：

如果您发现看起来像是错误的情况，或者想要提出功能请求，请使用 Github 问题跟踪系统。在提交问题之前，请搜索现有问题，以查看您的问题是否已经被涉及。
Slack

对于实时讨论，您可以加入 #kubebuilder slack 频道。Slack 需要注册，但 Kubernetes 团队对任何人开放注册邀请。欢迎随时来提问。