kubernetes集群YAML文件详解

墨颜丶2022-07-182025-04-15

YAML 文件概述

在 Kubernetes 中，YAML（YAML Ain’t a Markup Language）文件是用于定义和管理集群资源的核心工具。通过编写 YAML 格式的资源清单文件（Resource Manifest），用户可以声明式地创建、更新或删除 Kubernetes 资源对象（如 Pod、Deployment、Service 等）。这些文件通过 kubectl 命令（如 kubectl apply 或 kubectl create）执行，实现对集群资源的编排和部署。

YAML 文件书写格式

YAML 基础语法

缩进：使用空格缩进，相同层级的元素需左侧对齐，禁止使用 Tab 键。
注释：以 # 开头，从该字符到行尾的内容会被忽略。
数据结构：
- 对象（映射）：键值对集合，如 key: value。
- 数组（序列）：用 - 标记的列表，如：

1
2
3

ports:
  - containerPort: 80
  - containerPort: 443

纯量：单个值，如字符串、数字、布尔值等。

示例代码结构

apiVersion: v1   # 必须字段，指定 Kubernetes API 版本
kind: Pod        # 必须字段，指定资源类型（Pod、Deployment 等）
metadata:
  name: my-pod   # 资源名称
  labels:        # 标签，用于分类和选择
    app: web
spec:
  containers:
    - name: nginx-container
      image: nginx:latest
      ports:
        - containerPort: 80

资源清单文件的核心字段

必须存在的字段

apiVersion：指定 Kubernetes API 的版本（如 v1、apps/v1）。
kind：定义资源类型（如 Pod、Deployment、Service）。
metadata：元数据，包含资源的名称、标签（labels）、命名空间（namespace）等。

metadata:
  name: my-deployment
  namespace: default
  labels:
    env: production

spec：定义资源的具体配置和期望状态（Spec 是 “Specification” 的缩写）。

spec:
  replicas: 3   # Deployment 的副本数
  selector:
    matchLabels:
      app: web
  template:
    metadata:
      labels:
        app: web
    spec:
      containers:
        - name: app-container
          image: my-app:v1

常用字段说明

apiVersion：
- v1：核心资源（如 Pod、Service）。
- apps/v1：控制器资源（如 Deployment、StatefulSet）。
- batch/v1：批处理任务（如 Job、CronJob）。
kind：
- Pod、Deployment、Service、ConfigMap、Secret 等。
spec：
- 根据资源类型不同，配置项会有所差异。例如：
  - Pod：定义容器、存储卷、端口等。
  - Deployment：定义副本数、滚动更新策略、容器模板等。
  - Service：定义端口、选择器（Selector）、服务类型（ClusterIP/NodePort 等）。

常见资源清单示例

Pod 示例

apiVersion: v1
kind: Pod
metadata:
  name: nginx-pod
  labels:
    app: nginx
spec:
  containers:
    - name: nginx
      image: nginx:1.14.2
      ports:
        - containerPort: 80

Deployment 示例

apiVersion: apps/v1
kind: Deployment
metadata:
  name: my-app-deployment
spec:
  replicas: 3
  selector:
    matchLabels:
      app: my-app
  template:
    metadata:
      labels:
        app: my-app
    spec:
      containers:
        - name: my-app-container
          image: my-app:latest
          ports:
            - containerPort: 8080

Service 示例

apiVersion: v1
kind: Service
metadata:
  name: my-service
spec:
  selector:
    app: my-app
  ports:
    - protocol: TCP
      port: 80
      targetPort: 8080
  type: ClusterIP

如何快速编写 YAML 文件

在 Kubernetes 中，YAML 文件是定义和管理资源的核心工具。以下是两种快速生成或导出 YAML 文件的高效方法：

使用 kubectl create 命令生成

kubectl create 命令允许通过 干运行（dry-run） 功能快速生成资源的 YAML 模板，无需实际创建资源。以下是具体步骤和示例：

1. 基本语法

1	kubectl create <资源类型> <名称> [参数...] --dry-run=client -o yaml > 文件名.yaml

--dry-run=client：表示仅生成文件，不实际创建资源。
-o yaml：指定输出格式为 YAML。
>：将输出重定向到指定文件。

2. 常见资源生成示例

1 2	# 生成一个基于 nginx 镜像的 Deployment YAML kubectl create deployment my-deployment --image=nginx --dry-run=client -o yaml > deployment.yaml

生成的 YAML 内容片段：

apiVersion: apps/v1
kind: Deployment
metadata:
  creationTimestamp: null
  labels:
    app: my-deployment
  name: my-deployment
spec:
  replicas: 1
  selector:
    matchLabels:
      app: my-deployment
  strategy: {}
  template:
    metadata:
      creationTimestamp: null
      labels:
        app: my-deployment
    spec:
      containers:
      - image: nginx
        name: nginx
        resources: {}
status: {}

Service

1 2	# 为 Deployment 创建一个 ClusterIP 类型的 Service YAML kubectl create service clusterip my-service --tcp=80:80 --dry-run=client -o yaml > service.yaml

Pod

1 2	# 生成一个单次运行的 Pod YAML（无重启策略） kubectl run my-pod --image=nginx --restart=Never --dry-run=client -o yaml > pod.yaml

ConfigMap

1 2	# 从环境变量生成 ConfigMap kubectl create configmap my-config --from-literal=key=value --dry-run=client -o yaml > configmap.yaml

Secret

1 2	# 生成一个包含敏感信息的 Secret YAML kubectl create secret generic my-secret --from-literal=username=admin --dry-run=client -o yaml > secret.yaml

3. 自定义参数

指定镜像版本：--image=nginx:latest → 可替换为 nginx:1.21.3。
设置资源限制：

1	kubectl create deployment my-deployment --image=nginx --dry-run=client -o yaml --resource-request=cpu=200m,memory=256Mi > deployment-with-resources.yaml

4. 注意事项

资源类型支持：并非所有资源（如 ClusterRole）都支持 kubectl create 生成，需手动调整。
版本兼容性：不同 Kubernetes 版本的 YAML 字段可能略有差异，建议参考官方文档验证。
高级场景：复杂资源（如 StatefulSet）需结合 kubectl explain 或 Helm 模板工具。

使用 kubectl get 命令导出

如果集群中已有资源，可以通过 kubectl get 命令直接导出其 YAML 配置，便于修改或迁移。

1. 基本语法

1	kubectl get <资源类型>/<资源名称> -n <命名空间> -o yaml > 文件名.yaml

2. 常见场景示例

导出 Deployment

# 导出默认命名空间中的 Deployment
kubectl get deployment my-deployment -o yaml > exported-deployment.yaml

# 导出特定命名空间中的 Deployment
kubectl get deployment my-deployment -n my-namespace -o yaml > exported-deployment.yaml

导出 Service

1	kubectl get service my-service -o yaml > exported-service.yaml

导出 ConfigMap 或 Secret

1 2	kubectl get configmap my-config -o yaml > exported-configmap.yaml kubectl get secret my-secret -o yaml > exported-secret.yaml

3. 导出时排除集群元数据

使用 --export 参数可排除集群特定信息（如 uid、creationTimestamp），使 YAML 更适合跨集群迁移：

1	kubectl get pod my-pod -o yaml --export > portable-pod.yaml

注意：新版本已经移除了 --export

4. 注意事项

资源不存在时：若资源不存在，会报错 Error from server (NotFound): ...
权限问题：需确保有权限读取目标资源。
版本差异：导出的 YAML 可能包含集群特定配置，需根据目标环境调整。

最佳实践与扩展

1. 结合 `kubectl explain` 理解字段

1 2	# 查看 Deployment 的 spec.template.spec.containers 字段说明 kubectl explain deployment.spec.template.spec.containers

2. 使用 Helm 生成复杂模板

# 创建包含完整 Helm Chart 结构的目录
helm create mychart
# 生成的目录包含 deployment、service 等 YAML 模板
tree mychart/

3. 验证 YAML 文件

1 2	# 检查 YAML 文件的语法和格式 kubectl apply -f my-resource.yaml --dry-run=server --validate=true

总结

方法	适用场景	优势
`kubectl create`	快速生成基础模板	无需现有资源，参数灵活
`kubectl get`	导出现有资源配置	保留当前状态，便于修改
`Helm`	复杂应用部署	支持变量替换和版本管理

通过以上方法，可以显著提升 Kubernetes YAML 文件的编写效率，尤其在考试或快速迭代场景中非常实用。

注意事项

缩进规范：必须使用空格缩进，且同一层级的元素需对齐。
数据类型：
- 数组用 - 标记，如 ports: [80, 443]。
- 键值对用 key: value，值为字符串时需注意引号使用。
验证 YAML 文件：
- 使用 kubectl create -f <file> 或 kubectl apply -f <file> 验证语法。
- 使用在线工具（如 YAML Lint）检查格式。
命名规范：
- 资源名称需符合 DNS 子域名格式（小写字母、数字、连字符）。
版本兼容性：
- 不同 Kubernetes 版本的 apiVersion 可能不同，需查阅官方文档确认。

YAML 文件的使用场景

部署应用：通过 Deployment 或 DaemonSet 管理应用副本。
配置服务：定义 Service、Ingress 实现网络访问。
持久化存储：声明 PersistentVolume（PV）和 PersistentVolumeClaim（PVC）。
配置管理：使用 ConfigMap 和 Secret 管理配置和敏感信息。
集群管理：定义 Namespace、Role、ClusterRole 等集群级资源。

总结

YAML 文件是 Kubernetes 的核心配置语言，通过声明式描述实现资源的自动化管理。掌握 YAML 的语法规范和资源清单结构，能够高效地部署和维护 Kubernetes 集群。建议结合 kubectl explain 命令（如 kubectl explain pod.spec）深入理解各个字段的作用。

如果需要进一步了解特定资源的 YAML 配置，可以参考 Kubernetes 官方文档或示例文件。