add build doc (#453)

4b5994e2 · lllwan · GitHub · c7bb9433 · 4b5994e2
Unverified Commit 4b5994e2 authored 3 years ago by lllwan Committed by GitHub 3 years ago
Hide whitespace changes
Inline Side-by-side

Showing

with 70 additions and 0 deletions
+70 -0
--- a/docs/build/build_zh.md
+++ b/docs/build/build_zh.md
+# 镜像build
+> 就像使用Dockerfile来构建容器镜像一样， 我们可以通过Kubefile来定义一个sealer的集群镜像。我们可以使用和Dockerfile一样的指令来定义一个可离线部署的交付镜像。
+>
+>
+### Kubefile 定义
+
+ For example:
+
+```bigquery
+FROM registry.cn-qingdao.aliyuncs.com/sealer-io/kubernetes:v1.19.9
+# download kubernetes dashboard yaml file
+RUN wget https://raw.githubusercontent.com/kubernetes/dashboard/v2.2.0/aio/deploy/recommended.yaml
+# when run this CloudImage, will apply a dashboard manifests
+CMD kubectl apply -f recommended.yaml
+```
+
+1. Kubefile支持的基本指令
+ FROM
+    + 引用一个基础镜像，例如：kubernetes：1.19.9 sealer社区提供基于kubernetes官方版本制作的基础镜像。
+ RUN
+    + 执行命令，例如上面示例中下载一个资源定义并apply的动作，build时会将资源定义文件保存在镜像中
+ COPY
+    + copy 文件或者目录到rootfs中
+ CMD
+    + 同RUN指令
+
+
+### build类型
+> 针对不同的业务需求场景，sealer build 目前支持3种构建方式。
+
+#### 1. cloud build
+> 基于云服务（目前仅支持阿里云， 欢迎贡献其他云厂商的Provider），自动化创建ecs并部署kubernetes集群并构建镜像，cloud build 是兼容性最好的构建方式， 基本可以100%的满足构建需求。缺点是需要创建按量计费的云主机会产生一定的成本。如果您要交付的环境涉及例如分布式存储这样的底层资源，建议使用此方式来进行构建。
+
+```bigquery
+sealer build -t my-cluster:v1.19.9 .
+```
+
+#### 2. container build
+> 通过在docker中运行一个微型kubernetes集群的方式来进行构建，可以消耗很少量的资源完成集群构建，缺点是不能很好的支持对底层资源依赖的场景。
+
+```bigquery
+sealer build -b container -t my-cluster:v1.19.9 .
+```
+
+#### 3. lite build
+> 最轻量的构建方式， 原理是通过解析helm chart、提交镜像清单、解析manifest下的资源定义获取镜像清单并缓存， 配合Kubefile的定义，实现不用拉起kubernetes集群的轻量化构建，此种方式优点是资源消耗最低，有一台能够跑sealer的主机即可进行构建。缺点是无法覆盖一些场景， 例如无法获取通过operator部署的镜像，一些通过专有的管理工具进行交付的业务也无法解析获取到对应的镜像，lite build适用于已知镜像清单， 或者没有特殊的资源需求的场景。
+ Kubefile 示例：
+
+```bigquery
+FROM kubernetes:v1.19.9
+COPY imageList manifests
+COPY apollo charts
+RUN helm install charts/apollo
+RUN wget https://raw.githubusercontent.com/kubernetes/dashboard/v2.2.0/aio/deploy/recommended.yaml
+COPY recommended.yaml manifests
+RUN kubectl apply -f manifests/recommended.yaml
+```
+
+ 如上示例，lite构建会从如下三个位置解析会获取镜像清单，并将镜像缓存至registry：
+    + manifests/imageList: 内容就是镜像的清单，一行一个镜像地址。如果这个文件存在，则逐行提取镜像。imageList的文件名必须固定，不可更改，且必须放在manifests下。
+    + manifests 目录下的yaml文件: lite build将解析manifests目录下的所有yaml文件并从中提取镜像。
+    + charts 目录: helm chart应放置此目录下， lite build将通过helm引擎从helm chart中解析镜像地址。
+    
+ lite build 操作示例，假设Kubefile在当前目录下：
+
+```bigquery
+sealer build -b lite -t my-cluster:v1.19.9 .
+```
+
+ 构建完成将生成镜像：my-cluster:v1.19.9
\ No newline at end of file