kubernetes-sigs/kustomize
GitHub: kubernetes-sigs/kustomize
Kubernetes 官方推出的无模板 YAML 配置定制工具,通过声明式补丁实现多环境配置管理。
Stars: 12008 | Forks: 2376
# kustomize
`kustomize` 允许您为多种目的定制原始的、无模板的 YAML
文件,同时保持原始 YAML
不变并可直接使用。
`kustomize` 面向 kubernetes;它理解并可以
patch [kubernetes style] API 对象。它就像
[`make`],因为它的操作是在文件中声明的,
它也像 [`sed`],因为它输出编辑后的文本。
本工具由 [sig-cli] ([KEP]) 赞助。
- [安装说明](https://kubectl.docs.kubernetes.io/installation/kustomize/)
- [通用文档](https://kubectl.docs.kubernetes.io/references/kustomize/)
- [示例](examples)
[](https://prow.k8s.io/job-history/kubernetes-jenkins/pr-logs/directory/kustomize-presubmit-master)
[](https://goreportcard.com/report/github.com/kubernetes-sigs/kustomize)
## kubectl 集成
要查看较新版本 kubectl 中嵌入的 kustomize 版本,请运行 `kubectl version`:
```
> kubectl version --client
Client Version: v1.31.0
Kustomize Version: v5.4.2
```
[v2.0.3] 版本的 kustomize build 流程
被添加到了 [kubectl v1.14][kubectl announcement] 中。kubectl 中的
kustomize 流程在 kubectl v1.21 之前一直停留在 v2.0.3,
v1.21 [将其更新到了 v4.0.5][kust-in-kubectl update]。未来它将
定期更新,此类更新将
反映在 Kubernetes 发行说明中。
| Kubectl 版本 | Kustomize 版本 |
| --------------- | ----------------- |
| < v1.14 | n/a |
| 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 documentation]。
## 用法
### 1) 创建一个 [kustomization] 文件
在包含您的 YAML [resource]
文件(deployments, services, configmaps 等)的某个目录中,创建一个
[kustomization] 文件。
该文件应声明这些资源,以及要
应用于它们的任何定制,例如 _添加一个通用
label_。
```
base: kustomization + resources
kustomization.yaml deployment.yaml service.yaml
+---------------------------------------------+ +-------------------------------------------------------+ +-----------------------------------+
| apiVersion: kustomize.config.k8s.io/v1beta1 | | apiVersion: apps/v1 | | apiVersion: v1 |
| kind: Kustomization | | kind: Deployment | | kind: Service |
| labels: | | metadata: | | metadata: |
| - includeSelectors: true | | name: myapp | | name: myapp |
| pairs: | | spec: | | spec: |
| app: myapp | | selector: | | selector: |
| resources: | | matchLabels: | | app: myapp |
| - deployment.yaml | | app: myapp | | ports: |
| - service.yaml | | template: | | - port: 6060 |
| configMapGenerator: | | metadata: | | targetPort: 6060 |
| - name: myapp-map | | labels: | +-----------------------------------+
| literals: | | app: myapp |
| - KEY=value | | spec: |
+---------------------------------------------+ | containers: |
| - name: myapp |
| image: myapp |
| resources: |
| limits: |
| memory: "128Mi" |
| cpu: "500m" |
| ports: |
| - containerPort: 6060 |
+-------------------------------------------------------+
```
文件结构:
此目录中的资源可能是其他人配置的
一个分支。如果是这样,您可以轻松地
从源材料变基以获取
改进,因为您不直接修改
资源。
使用以下命令生成定制的 YAML:
```
kustomize build ~/someApp
```
YAML 可以直接 [applied] 到集群:
### 2) 使用 [overlays] 创建 [variants]
使用修改通用 [base] 的
[overlays] 管理传统的配置 [variants] —— 如
_development_、_staging_ 和 _production_。
```
overlay: kustomization + patches
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 |
| labels: | | metadata: | | metadata: |
| - includeSelectors: true | | name: myapp | | name: myapp |
| pairs: | | spec: | | spec: |
| variant: prod | | replicas: 80 | | template: |
| resources: | +-------------------------------+ | spec: |
| - ../../base | | containers: |
| patches: | | - name: myapp |
| - path: replica_count.yaml | | resources: |
| - path: cpu_count.yaml | | limits: |
+-----------------------------------------------+ | memory: "128Mi" |
| cpu: "7000m" |
+------------------------------------------+
```
文件结构:
获取上面步骤 (1) 的工作成果,将其移动到
名为 `base` 的 `someApp` 子目录中,然后
将 overlays 放置在同级目录中。
一个 overlay 只是另一个 kustomization,它引用
base,并引用要应用于该
base 的补丁。
这种安排使得用 `git` 管理您的
配置变得容易。base 可能包含
由其他人管理的上游仓库中的文件。
overlays 可以位于您拥有的仓库中。
将 repo 克隆作为同级目录安排在磁盘上避免了
对 git submodules 的需求(不过如果您是 submodule 的粉丝,那样做也没问题)。
生成 YAML 使用
```
kustomize build ~/someApp/overlays/production
```
YAML 可以直接 [applied] 到集群:
## 社区
- [提交 Bug](https://kubectl.docs.kubernetes.io/contributing/kustomize/bugs/)
- [贡献功能](https://kubectl.docs.kubernetes.io/contributing/kustomize/features/)
- [提议更大的改进](https://github.com/kubernetes-sigs/kustomize/tree/master/proposals)
### 行为准则
Kubernetes 社区的参与
受 [Kubernetes Code of Conduct] 约束。
标签:EVTX分析, Go语言, kubectl插件, kustomize, Pandas, sig-cli, YAML定制, 声明式配置, 多环境部署, 子域名突变, 日志审计, 模板引擎, 程序破解, 资源编排, 配置补丁