kustomize

kustomize 允许您自定义原始的、无模板的 YAML 文件以满足多种用途，同时保持原始 YAML 文件不变且可直接使用。

kustomize 针对 Kubernetes 设计；它能够理解并修补 [Kubernetes 风格] 的 API 对象。它类似于 [make]，因为它的操作在文件中声明，同时也类似于 [sed]，因为它会输出编辑过的文本。

该工具由 [sig-cli] ([KEP]) 赞助。

• 安装说明
• 通用文档
• 示例

kubectl 集成

要查找最近版本的 kubectl 中嵌入的 kustomize 版本，请运行 kubectl version：

> kubectl version --short --client
Client Version: v1.26.0
Kustomize Version: v4.5.7

v2.0.3 版本的 kustomize 构建流程被添加到了 [kubectl v1.14][kubectl announcement] 中。kubectl 中的 kustomize 流程在 v2.0.3 版本保持不变，直到 kubectl v1.21，该版本更新到了 v4.0.5。今后它将定期更新，这些更新将反映在 Kubernetes 的发布说明中。

Kubectl 版本	Kustomize 版本
< v1.14	不适用
v1.14-v1.20	v2.0.3
v1.21	v4.0.5
v1.22	v4.2.0
v1.23	v4.4.1
v1.24	v4.5.4
v1.25	v4.5.7
v1.26	v4.5.7
v1.27	v5.0.1

有关使用 kubectl 集成的示例和指南，请参阅 [kubernetes 文档]。

使用方法

1) 创建 [kustomization] 文件

在包含您的 YAML [资源] 文件（部署、服务、配置映射等）的某个目录中，创建一个 [kustomization] 文件。

该文件应声明这些资源，以及要应用于它们的任何自定义设置，例如 添加一个通用标签。

基础：kustomization + 资源

kustomization.yaml                                      deployment.yaml                                                 service.yaml
+---------------------------------------------+         +-------------------------------------------------------+       +-----------------------------------+
| apiVersion: kustomize.config.k8s.io/v1beta1 |         | apiVersion: apps/v1                                   |       | apiVersion: v1                    |
| kind: Kustomization                         |         | kind: Deployment                                      |       | kind: Service                     |
| commonLabels:                               |         | metadata:                                             |       | metadata:                         |
|   app: myapp                                |         |   name: myapp                                         |       |   name: myapp                     |
| resources:                                  |         | spec:                                                 |       | spec:                             |
|   - deployment.yaml                         |         |   selector:                                           |       |   selector:                       |
|   - service.yaml                            |         |     matchLabels:                                      |       |     app: myapp                    |
| configMapGenerator:                         |         |       app: myapp                                      |       |   ports:                          |
|   - name: myapp-map                         |         |   template:                                           |       |     - port: 6060                  |
|     literals:                               |         |     metadata:                                         |       |       targetPort: 6060            |
|       - KEY=value                           |         |       labels:                                         |       +-----------------------------------+
+---------------------------------------------+         |         app: myapp                                    |
                                                        |     spec:                                             |
                                                        |       containers:                                     |
                                                        |         - name: myapp                                 |
                                                        |           image: myapp                                |
                                                        |           resources:                                  |
                                                        |             limits:                                   |
                                                        |               memory: "128Mi"                         |
                                                        |               cpu: "500m"                             |
                                                        |           ports:                                      |
                                                        |             - containerPort: 6060                     |
                                                        +-------------------------------------------------------+

文件结构：

~/someApp
├── deployment.yaml
├── kustomization.yaml
└── service.yaml

这个目录中的资源可能是别人配置的一个分支。如果是这样，您可以轻松地从源材料中重新基准以捕获改进，因为您不直接修改资源。

使用以下命令生成自定义的 YAML：

kustomize build ~/someApp

可以直接将 YAML [应用] 到集群：

kustomize build ~/someApp | kubectl apply -f -

2) 使用 [overlays] 创建 [variants]

使用 [overlays] 管理配置的传统 [variants]（如 开发、预发布 和 生产），以修改通用 [base]。

overlay：kustomization + 补丁
kustomization.yaml                                      replica_count.yaml                      cpu_count.yaml
+-----------------------------------------------+       +-------------------------------+       +------------------------------------------+
| apiVersion: kustomize.config.k8s.io/v1beta1   |       | apiVersion: apps/v1           |       | apiVersion: apps/v1                      |
| kind: Kustomization                           |       | kind: Deployment              |       | kind: Deployment                         |
| commonLabels:                                 |       | metadata:                     |       | metadata:                                |  
|   variant: prod                               |       |   name: myapp                 |       |   name: myapp                            |
| resources:                                    |       | spec:                         |       | spec:                                    |
|   - ../../base                                |       |   replicas: 80                |       |  template:                               |
| patches:                                      |       +-------------------------------+       |     spec:                                |
|   - path: replica_count.yaml                  |                                               |       containers:                        |
|   - path: cpu_count.yaml                      |                                               |         - name: myapp                    |  
+-----------------------------------------------+                                               |           resources:                     |
                                                                                                |             limits:                      |
                                                                                                |               memory: "128Mi"            |
                                                                                                |               cpu: "7000m"               |
                                                                                                +------------------------------------------+

文件结构：

~/someApp
├── base
│   ├── deployment.yaml
│   ├── kustomization.yaml
│   └── service.yaml
└── overlays
    ├── development
    │   ├── cpu_count.yaml
    │   ├── kustomization.yaml
    │   └── replica_count.yaml
    └── production
        ├── cpu_count.yaml
        ├── kustomization.yaml
        └── replica_count.yaml

将上面步骤(1)中的工作移入someApp子目录下的base文件夹，然后将overlays放在同级目录中。

overlay只是另一个kustomization，它引用base并引用要应用于该base的补丁。

这种安排使得使用git管理配置变得容易。base可以包含来自他人管理的上游仓库的文件。overlays可以在你自己的仓库中。将仓库克隆作为同级目录排列在磁盘上，避免了使用git子模块的需要（虽然如果你是子模块的粉丝，这也可以正常工作）。

使用以下命令生成YAML：

kustomize build ~/someApp/overlays/production

YAML可以直接[应用]到集群：

kustomize build ~/someApp/overlays/production | kubectl apply -f -

社区

• 提交bug
• 贡献功能
• 提议更大的增强

行为准则

参与Kubernetes社区受[Kubernetes行为准则]的约束。