Kustomize

什么是 Kustomize

yaml 增强版,又没有 helm 那么难写

kustomize 是一个 CLI 工具,可以对 Manifest 的任何字段进行覆写,适合多环境的场景,由 Kubernetes 团队开发,从 1.14 版本开始已经内置到 kubectl 工具。

kubectl -k 参数是指在执行 kubectl 命令时使用 kustomize 来进行资源声明的过程。

base + Overlays(dev、testing等) + kustomization.yaml --> K8s Manifest

例子:

base                # 基础目录,或者不同环境的通用 Manifest
  deployment.yaml
  kustomization.yaml
overlays            # dev 环境目录
  dev
    hpa.yaml
    kustomization.yaml
  production        # production 环境目录
    hpa.yaml
    kustomization.yaml
  staging           # staging 环境目录
    hpa.yaml
    kustomization.yaml

kustomization.yaml 常用配置

  1. resource:定义 Manifest 资源,文件、目录或 URL
  2. secretGenerator:生成 secret 对象
  3. configMapGenerator:生成 configMap 对象
  4. images:覆写 image tag
  5. helmCharts:定义依赖的 helm chart
  6. patchesStrategicMerge:覆写操作,v1 版本将废弃,建议迁移到 patches
  7. 更多配置:https://kubectl.docs.kubernetes.io/references/kustomize/kustomization/

示例

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
  - ./base # 引用base目录下的所有资源
  
configMapGenerator:
  - name: vote-configmap
    literals: 
      - OPTION_A=CaiJiuDuoLian
      - OPTION_B=BuHuiJiuBieWan
      - AUTHOR="hide in bash"
      
secretGenerator:
# 下面两种写法是等效的
  - name: result-db-secret
    files: 
      - .env=.env
  - name: worker-db-secret
    files: 
      - .env

kustomize 还可以对某一环境下的某个 yaml 的部分字段进行覆写,例如

apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
  name: frontend
spec:
  metrics:
  - type: Resource
    resource:
      name: cpu
      target:
        type: Utilization
        averageUtilization: 90
---
apiVersion: autoscaling/v2
kind: HorizontalPodAutoscaler
metadata:
  name: backend
spec:
  metrics:
  - type: Resource
    resource:
      name: cpu
      target:
        type: Utilization
        averageUtilization: 90

在这段内容中,我们只提供了 spec.metrics 字段的内容,Kustomize 将对 dev 目录和 base 目录下相同名称的资源进行对比并合并,相同的字段以 dev 目录下的内容为准,这样就实现了覆盖操作。

简单总结一下就是, 我们需要为 Kustomize 提供不同环境下 Manifest 差异的部分,并提供资源类型和名称用于比对。

最后,我们还需要在 kustomize/overlay/dev 目录下创建一个文件,用来向 Kustomize 提供环境的差异信息。具体做法是将下面的内容保存为 kustomization.yaml 文件。

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
bases:
  - ../../base
  - database.yaml
patchesStrategicMerge:
  - hpa.yaml

patchesStrategicMerge 是 Kustomize 提供的一种修改合并资源的方法,这里应用我们创建的 hpa.yaml,可以定制开发环境的 HPA CPU 策略。

总结

在创建不同的环境目录时,你需要提供两种类型的文件,首先是 kustomization.yaml 文件,其次是用来描述和基准目录差异的文件,Kustomize 将会对比差异,并且进行覆盖操作。需要注意的是,在这节课我主要介绍了 patchesStrategicMerge 这种覆盖方式,这种方式可以覆盖我们大部分的使用场景,不过 Kustomize 还有其他的一些覆盖策略,例如 PatchesJson6902 和 PatchTransformer 等,你可以点击 这个链接 进一步了解。