Kustomize入门指南：创建你的第一个Kustomization配置

Kustomize入门指南：创建你的第一个Kustomization配置

kustomize Customization of kubernetes YAML configurations 项目地址: https://gitcode.com/gh_mirrors/ku/kustomize

什么是Kustomize？

Kustomize是Kubernetes原生配置管理工具，它允许用户在不修改原始YAML文件的情况下，通过声明式的方式定制Kubernetes资源配置。与传统的模板工具不同，Kustomize采用无模板方式，直接操作YAML文件，大大简化了Kubernetes应用的管理流程。

准备工作

在开始之前，请确保你已经：

1. 安装了kubectl工具（Kustomize已集成在kubectl中）
2. 准备了一个可用的Kubernetes集群用于测试
3. 了解基本的Kubernetes概念，如Deployment、Service等

创建基础资源

让我们从一个简单的Nginx部署开始：

# 创建项目目录
mkdir kustomize-example
cd kustomize-example

# 创建Deployment配置
cat <<'EOF' >deployment.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  labels:
    app: nginx
  name: nginx
spec:
  replicas: 1
  selector:
    matchLabels:
      app: nginx
  template:
    metadata:
      labels:
        app: nginx
    spec:
      containers:
      - image: nginx
        name: nginx
        ports:
        - containerPort: 80
EOF

# 创建Service配置
cat <<'EOF' >service.yaml
apiVersion: v1
kind: Service
metadata:
  labels:
    app: nginx
  name: nginx
spec:
  ports:
  - port: 80
    protocol: TCP
    targetPort: 80
  selector:
    app: nginx
EOF

创建第一个Kustomization文件

Kustomization文件是Kustomize的核心，它定义了如何处理你的Kubernetes资源：

cat <<'EOF' >kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
- deployment.yaml
- service.yaml
EOF

这个简单的kustomization.yaml文件告诉Kustomize包含哪些资源文件。运行kubectl kustomize .命令，你将看到合并后的YAML输出。

基础定制：添加名称前缀

让我们为所有资源添加一个名称前缀：

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

namePrefix: example-  # 添加名称前缀

resources:
- deployment.yaml
- service.yaml

现在运行kubectl kustomize .，你会看到所有资源的名称前都加上了"example-"前缀。

高级用法：环境覆盖(Overlays)

在实际项目中，我们通常需要为不同环境（如开发、测试、生产）创建不同的配置。Kustomize通过"base"和"overlay"的概念优雅地解决了这个问题。

创建目录结构

mkdir -p base overlays/staging overlays/production
mv deployment.yaml kustomization.yaml service.yaml base

创建基础kustomization

cat <<'EOF' >overlays/staging/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
- ../../base
EOF

cat <<'EOF' >overlays/production/kustomization.yaml
apiVersion: kustomize.config.k8s.io/v1beta1
kind: Kustomization

resources:
- ../../base
EOF

为不同环境定制配置

假设我们需要为生产和测试环境配置不同的参数：

生产环境kustomization.yaml:

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

namePrefix: prod-
namespace: production
replicas:
- name: nginx
  count: 3
images:
- name: nginx
  newTag: 1.20.2
resources:
- ../../base

测试环境kustomization.yaml:

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

namePrefix: staging-
namespace: staging
replicas:
- name: nginx
  count: 1
images:
- name: nginx
  newTag: latest
resources:
- ../../base

使用补丁(Patch)添加环境变量

有时我们需要为特定环境添加额外的配置，比如环境变量：

# 创建生产环境补丁文件
cat <<'EOF' >overlays/production/env-patch.yaml
apiVersion: apps/v1
kind: Deployment
metadata:
  name: nginx
spec:
  template:
    spec:
      containers:
      - name: nginx
        env:
        - name: ENV
          value: production
EOF

# 更新生产环境kustomization.yaml
cat <<'EOF' >>overlays/production/kustomization.yaml
patches:
- path: env-patch.yaml
EOF

验证配置

在应用配置前，建议先验证输出：

# 查看生产环境配置
kubectl kustomize overlays/production/

# 查看测试环境配置
kubectl kustomize overlays/staging/

应用配置

确认配置正确后，可以应用到集群：

# 应用到生产环境
kubectl apply -k overlays/production/

# 应用到测试环境
kubectl apply -k overlays/staging/

最佳实践

1. 保持基础配置简洁：base目录中的配置应该是通用的，不包含环境特定信息
2. 合理使用补丁：对于小的修改使用补丁，大的差异考虑创建单独的资源配置
3. 版本控制：将kustomization文件与应用程序代码一起版本控制
4. 命名规范：为不同环境的资源使用一致的命名规则
5. 逐步验证：每次修改后都使用kubectl kustomize验证输出

总结

通过本教程，你已经学会了：

1. 创建基本的Kustomize配置
2. 使用名称前缀等基本转换器
3. 通过overlay管理多环境配置
4. 使用补丁进行环境特定定制
5. 验证和应用Kustomize配置

Kustomize的强大之处在于它的简单性和与Kubernetes原生API的兼容性。随着你对Kustomize的深入了解，你会发现更多高级功能，如生成器、组件等，可以帮助你更高效地管理Kubernetes应用配置。

kustomize Customization of kubernetes YAML configurations 项目地址: https://gitcode.com/gh_mirrors/ku/kustomize