Menu

Kustomize 是 Kubernetes 原生的声明式配置管理工具，支持多环境分层、配置复用与灵活定制，极大提升了集群配置的可维护性和一致性。本文系统梳理其架构、核心功能、实践用法与最佳实践。

Kustomize 简介

Kustomize 是专为 Kubernetes 设计的声明式配置管理工具，允许用户通过分层和声明式方式定制和管理应用程序配置，无需直接修改原始清单文件。Kustomize 已集成到 kubectl，成为 Kubernetes 原生配置管理方案。

核心模块结构

Kustomize 由多个核心模块协同组成，支撑其灵活的配置管理能力。

```mermaid “Kustomize 核心模块结构” graph TD subgraph “Core Modules” kyaml[“kyaml
YAML Processing Library”] api[“api
Core Kustomize API”] cmd_config[“cmd/config
CLI for Config Management”] kustomize[“kustomize
Main Command-Line Tool”] end

kyaml --> api
kyaml --> cmd_config
api --> kustomize
cmd_config --> kustomize ```

Kustomize 核心模块结构 {width=1920 height=596}

Kustomize 核心功能

Kustomize 提供多种声明式配置管理能力，适用于复杂的 Kubernetes 应用场景。

配置合并与分层管理

Kustomize 采用基础配置（base）和覆盖配置（overlay）的分层架构：

这种分层方式实现了配置继承与灵活定制，提升了管理效率。

声明式配置与复用

Kustomize 使用 YAML 格式的 kustomization.yaml 文件描述定制规则，支持：

通过组件与补丁（patches），实现配置的复用与跨项目共享，降低维护成本。

多环境配置管理

Kustomize 天然支持多环境部署，可为开发、测试、生产等环境创建专属覆盖配置，实现一套基础配置适配多环境。

关键特性

实践示例

以下示例展示如何用 Kustomize 管理名为 “webapp” 的应用配置。

基础配置结构

首先定义基础配置目录结构：

base/
├── kustomization.yaml
├── deployment.yaml
├── service.yaml
└── configmap.yaml

base/kustomization.yaml 示例：

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

resources:
- deployment.yaml
- service.yaml
- configmap.yaml

commonLabels:
  app: webapp

环境特定配置

为不同环境创建覆盖配置：

overlays/
├── dev/
│   ├── kustomization.yaml
│   └── replica-patch.yaml
└── prod/
    ├── kustomization.yaml
    ├── replica-patch.yaml
    └── resource-limits.yaml

overlays/dev/kustomization.yaml 示例：

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

namespace: webapp-dev

resources:
- ../../base

patchesStrategicMerge:
- replica-patch.yaml

images:
- name: webapp
  newTag: dev-latest

overlays/prod/kustomization.yaml 示例：

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

namespace: webapp-prod

resources:
- ../../base

patchesStrategicMerge:
- replica-patch.yaml
- resource-limits.yaml

images:
- name: webapp
  newTag: v1.2.3

replicas:
- name: webapp-deployment
  count: 3

工作流与核心概念

Kustomize 遵循构建流程，将输入资源转换为定制输出。下图展示了其主要流程：

```mermaid “Kustomize 构建流程” flowchart TD subgraph “Input” kustomization[“kustomization.yaml”] resources[“Resources (YAML)”] components[“Components”] patches[“Patches”] end

subgraph "Kustomize Build Process"
    kusttarget["KustTarget"]
    resaccumulator["ResAccumulator"]

    subgraph "Phase 1: Resource Collection"
        load_resources["Load Resources"]
        accumulate_components["Accumulate Components"]
    end

    subgraph "Phase 2: Transformation"
        run_generators["Run Generators"]
        run_transformers["Run Transformers"]
        fix_references["Fix Back References"]
        resolve_vars["Resolve Variables"]
    end

    kusttarget --> load_resources
    load_resources --> accumulate_components
    accumulate_components --> run_generators
    run_generators --> run_transformers
    run_transformers --> fix_references
    fix_references --> resolve_vars
end

subgraph "Output"
    final_yaml["Generated YAML"]
end

kustomization --> kusttarget
resources --> load_resources
components --> accumulate_components
patches --> run_transformers

resolve_vars --> final_yaml ```

Kustomize 构建流程 {width=1920 height=2690}

核心概念说明

资源处理与 YAML 操作

Kustomize 提供复杂的资源处理与 YAML 操作能力。下图展示其主要处理流程：

```mermaid “Kustomize 资源处理架构” graph TD subgraph “YAML Processing (kyaml)” rnode[“RNode
(YAML Node Wrapper)”] filters[“Filters
(Node Transformations)”] setters[“Setters
(Field Value Management)”] openapi[“OpenAPI Schema
(Validation)”] end

subgraph "Resource Management (api)"
    resource["Resource<br>(K8s Object Wrapper)"]
    resid["ResId<br>(Resource Identifier)"]
    resmap["ResMap<br>(Resource Collection)"]
    origin["Origin<br>(Resource Source Tracking)"]
end

subgraph "Transformations"
    name_ref["Name Reference<br>(Handle Renames)"]
    hash_transformer["Hash Transformer<br>(Content-based Names)"]
    patches["Patch Application<br>(JSON, Strategic Merge)"]
    replacements["Replacements<br>(Cross-resource Values)"]
end

subgraph "I/O System (kio)"
    readers["Readers<br>(YAML Input)"]
    writers["Writers<br>(YAML Output)"]
    pipeline["Pipeline<br>(Processing Chain)"]
end

rnode --> filters
filters --> setters
rnode --> openapi

rnode --> resource
resource --> resid
resource --> resmap
resource --> origin

resmap --> name_ref
resmap --> hash_transformer
resmap --> patches
resmap --> replacements

rnode --> readers
rnode --> writers
readers --> pipeline
pipeline --> writers ```

Kustomize 资源处理架构 {width=2238 height=894}

主要组件说明：

插件系统

Kustomize 支持多种插件类型，扩展资源生成与转换能力。

```mermaid “Kustomize 插件系统” graph TD subgraph “Plugin Types” generators[“Generators
(Create Resources)”] transformers[“Transformers
(Modify Resources)”] validators[“Validators
(Verify Resources)”] end

subgraph "Built-in Plugins"
    configmap_gen["ConfigMapGenerator"]
    secret_gen["SecretGenerator"]
    patch_transformer["PatchTransformer"]
    namespace_transformer["NamespaceTransformer"]
    labels_transformer["LabelTransformer"]
    helm_chart_gen["HelmChartInflationGenerator"]
end

subgraph "Custom Plugin Types"
    exec_plugin["Exec Plugins<br>(Shell Scripts)"]
    go_plugin["Go Plugins<br>(Compiled Code)"]
    fn_plugin["Function Plugins<br>(Containerized)"]
end

subgraph "Plugin Loading & Execution"
    plugin_loader["Plugin Loader"]
    plugin_config["Plugin Config"]
    execution["Plugin Execution"]
end

generators --> configmap_gen
generators --> secret_gen
generators --> helm_chart_gen
transformers --> patch_transformer
transformers --> namespace_transformer
transformers --> labels_transformer

plugin_loader --> exec_plugin
plugin_loader --> go_plugin
plugin_loader --> fn_plugin
plugin_loader --> built_in["Built-in Plugins"]

built_in --> configmap_gen
built_in --> secret_gen
built_in --> patch_transformer
built_in --> namespace_transformer
built_in --> labels_transformer
built_in --> helm_chart_gen

plugin_config --> plugin_loader
plugin_loader --> execution ```

Kustomize 插件系统 {width=3143 height=831}

插件类型包括：

与 kubectl 集成使用

自 Kubernetes 1.14 起，Kustomize 已内置于 kubectl，提供原生配置管理能力。kubectl 内置 Kustomize 版本随 Kubernetes 版本变化。

kubectl 与 Kustomize 版本对应表

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
v1.31 v5.4.2

可通过 kubectl version --client 查看当前 kubectl 内置的 Kustomize 版本。

常用命令

高级功能

使用示例

基本用法

一个简单的 kustomization 文件如下：

apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization
resources:
  - deployment.yaml
  - service.yaml
labels:
- includeSelectors: true
  pairs:
    app: myapp

生成定制 YAML：

kustomize build /path/to/kustomization/directory

或使用 kubectl：

kubectl kustomize /path/to/kustomization/directory
kubectl apply -k /path/to/kustomization/directory

使用 Overlays

多环境配置目录结构示例：

~/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

构建特定环境覆盖：

kustomize build ~/someApp/overlays/production

最佳实践

通过 Kustomize，可实现 Kubernetes 配置的标准化管理，提升可维护性与部署一致性。

总结

Kustomize 作为 Kubernetes 原生配置管理工具，凭借分层架构、声明式定制与强大插件系统，极大提升了集群配置的灵活性和可维护性。合理运用 Kustomize 能有效支撑多环境、多团队的高效协作与持续交付。

参考文献

  1. Kustomize 官方文档 - kustomize.io
  2. Kubernetes 官方文档 - kubernetes.io

Menu