From 781291355521ced7e7d0b397828890d460deca5a Mon Sep 17 00:00:00 2001
From: Jimmy Song <rootsongjc@gmail.com>
Date: Mon, 26 Nov 2018 17:14:49 +0800
Subject: [PATCH] Add kubebuilder

---
 SUMMARY.md             |  5 +++--
 develop/kubebuilder.md | 34 ++++++++++++++++++++++++++++++++++
 2 files changed, 37 insertions(+), 2 deletions(-)
 create mode 100644 develop/kubebuilder.md

diff --git a/SUMMARY.md b/SUMMARY.md
index 9c30fe08f..2841579fa 100644
--- a/SUMMARY.md
+++ b/SUMMARY.md
@@ -243,11 +243,12 @@
 * [开发指南概览](develop/index.md)
 * [SIG和工作组](develop/sigs-and-working-group.md)
 * [开发环境搭建](develop/developing-environment.md)
-* [本地分布式开发环境搭建（使用Vagrant和Virtualbox）](develop/using-vagrant-and-virtualbox-for-development.md)
+  * [本地分布式开发环境搭建（使用Vagrant和Virtualbox）](develop/using-vagrant-and-virtualbox-for-development.md)
 * [单元测试和集成测试](develop/testing.md)
 * [client-go示例](develop/client-go-sample.md)
 * [Operator](develop/operator.md)
-* [operator-sdk](develop/operator-sdk.md)
+  * [operator-sdk](develop/operator-sdk.md)
+* [kubebuilder](develop/kubebuilder.md)
 * [高级开发指南](develop/advance-developer.md)
 * [社区贡献](develop/contribute.md)
 * [Minikube](develop/minikube.md)
diff --git a/develop/kubebuilder.md b/develop/kubebuilder.md
new file mode 100644
index 000000000..47c34d98b
--- /dev/null
+++ b/develop/kubebuilder.md
@@ -0,0 +1,34 @@
+# Kubebuilder
+
+Kubebuilder 是一个基于 [CRD](../concepts/crd.md) 来构建 Kubernetes API 的框架，可以使用 CRD 来构建 API、Controller 和 Admission Webhook。
+
+请参考 [Kubebuilder quick start](https://book.kubebuilder.io/quick_start.html) 来安装 kubebuilder。
+
+## 动机
+
+目前扩展 Kubernetes 的 API 的方式有创建 [CRD](../concepts/crd.md)、使用 [Operator](operator.md) SDK 等方式，都需要写很多的样本文件（boilerplate），使用起来十分麻烦。为了能够更方便构建 Kubernetes API 和工具，就需要一款能够事半功倍的工具，与其他 Kubernetes API 扩展方案相比，kubebuilder 更加简单易用，并获得了社区的广泛支持。
+
+## 工作流程
+
+Kubebuilder 的工作流程如下：
+
+1. 创建一个新的工程目录
+2. 创建一个或多个资源 API CRD 然后将字段添加到资源
+3. 在控制器中实现协调循环（reconcile loop），watch 额外的资源
+4. 在集群中运行测试（自动安装 CRD 并自动启动控制器）
+5. 更新引导集成测试测试新字段和业务逻辑
+6. 使用用户提供的 Dockerfile 构建和发布容器
+
+## 设计哲学
+
+Kubebuilder 提供基于简洁的精心设计的示例 godoc 来提供整洁的库抽象。
+
+- 能使用 go 接口和库，就不使用代码生成
+- 能使用代码生成，就不用使用多于一次的存根初始化
+- 能使用一次存根，就不 fork 和修改 boilerplate
+- 绝不 fork 和修改 boilerplate
+
+## 参考
+
+- [Kubebuilder quick start - book.kubebuilder.io](https://book.kubebuilder.io/quick_start.html)
+- [kubebuilder - github.com](https://github.com/kubernetes-sigs/kubebuilder/)
\ No newline at end of file