容器与云原生 / 系统课时

Kustomize 基础

Kustomize 基础

Kustomize 可以在不引入模板语法的情况下复用 Kubernetes 原生 YAML。本课将创建一个 Base 和两个 Overlay,通过结构化配置生成开发与生产清单,并用 kubectl 完成渲染和本地验证。

学习目标

  • 理解 Base、Overlay 与最终资源之间的继承关系。
  • 使用 kustomization.yaml 复用资源并覆盖环境差异。
  • 渲染清单并检查名称、命名空间、镜像和副本数。

Base 与 Overlay 的工作方式

Base 保存可被多个环境复用的完整资源;Overlay 引用 Base,再声明当前环境的名称前缀、命名空间、镜像标签、副本数或补丁。Kustomize 读取整个资源图后统一变换,并同步处理资源名称和命名空间等关联字段。

它与字符串模板不同:源文件仍是合法的 Kubernetes YAML,差异通过结构化字段描述。部署入口通常是 overlays/dev 或 overlays/prod,而不是 Base 本身。

Kustomize Base 与 Overlay 的渲染关系

主示例:创建并渲染环境配置

下面的命令一次性创建 Base、开发 Overlay 和生产 Overlay。需要本机已安装支持 kubectl kustomize 的 kubectl。

bash
mkdir -p kustomize-demo/base
mkdir -p kustomize-demo/overlays/{dev,prod}

cat > kustomize-demo/base/deployment.yaml <<'YAML'
apiVersion: apps/v1
kind: Deployment
metadata:
  name: web
spec:
  replicas: 2
  selector:
    matchLabels:
      app: web
  template:
    metadata:
      labels:
        app: web
    spec:
      containers:
        - name: web
          image: example/web:1.0.0
          ports:
            - containerPort: 8080
YAML

cat > kustomize-demo/base/service.yaml <<'YAML'
apiVersion: v1
kind: Service
metadata:
  name: web
spec:
  selector:
    app: web
  ports:
    - port: 80
      targetPort: 8080
YAML

cat > kustomize-demo/base/kustomization.yaml <<'YAML'
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - deployment.yaml
  - service.yaml
YAML

cat > kustomize-demo/overlays/dev/kustomization.yaml <<'YAML'
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - ../../base
namePrefix: dev-
namespace: demo-dev
images:
  - name: example/web
    newTag: 1.1.0-dev
replicas:
  - name: web
    count: 1
YAML

cat > kustomize-demo/overlays/prod/kustomization.yaml <<'YAML'
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - ../../base
namePrefix: prod-
namespace: demo-prod
images:
  - name: example/web
    newTag: 1.1.0
replicas:
  - name: web
    count: 3
YAML

cd kustomize-demo
kubectl kustomize overlays/dev

预期结果中的关键字段如下。资源输出顺序可能随内置 Kustomize 版本不同,但名称、命名空间、镜像和副本数应一致。

yaml
apiVersion: v1
kind: Service
metadata:
  name: dev-web
  namespace: demo-dev
spec:
  selector:
    app: web
  ports:
    - port: 80
      targetPort: 8080
---
apiVersion: apps/v1
kind: Deployment
metadata:
  name: dev-web
  namespace: demo-dev
spec:
  replicas: 1
  template:
    spec:
      containers:
        - image: example/web:1.1.0-dev
          name: web

这里展示的是关键字段,不是可再次应用的完整文件。实际部署应直接使用 Overlay 入口,或把完整渲染结果保存为可追溯制品。切换到 overlays/prod 后,前缀、命名空间、镜像标签和副本数会按生产配置生成。

验证与关键边界

先用客户端 dry-run 检查 Overlay 能否生成 Kubernetes 可识别的对象。该命令不会创建资源,适合放进提交检查。

bash
kubectl apply --dry-run=client -k overlays/dev

预期输出如下。

text
service/dev-web created (dry run)
deployment.apps/dev-web created (dry run)

若提示找不到资源路径,检查 resources 的相对路径;若字段无法识别,检查 kustomization.yaml 的缩进、字段名和本机 kubectl 版本。真正部署前,还应确认 demo-dev 命名空间已存在,并根据集群策略执行服务端校验。

Overlay 应描述差异,而不是复制 Base。大量字段都不同时,应考虑拆分 Base;不要手工修改渲染输出后发布,也不要在 Base 中写入环境专属 Namespace、域名或 Secret 明文。

按自己的节奏,确认真正理解。

目录与阅读设置

阅读设置

17

记录一个想法

Kustomize 基础

0 / 10000 · 笔记保存到账号。未提交的修改会在关闭、离开或刷新后丢失。

登录哪都通