YAML运维最佳实践是什么

YAML 在运维（DevOps、SRE、自动化、云原生）场景中使用非常广泛，下面从设计、编写、管理、安全、可维护性等角度，系统性地总结 YAML 运维最佳实践。

一、YAML 基础原则（先避免踩坑）

1. 明确 YAML 不是配置语言，而是数据格式

• YAML 本质是数据结构描述，不是编程语言
• 不要试图用 YAML 表达复杂逻辑（循环、条件）
• 复杂逻辑应交给模板（Helm / Jinja2）或代码（Python / Go）

✅ 正确认知：

YAML = 声明式配置，不是脚本

二、编写规范（可读性 & 一致性）

2. 统一缩进（强制）

• 永远使用 2 个空格
• 禁止 Tab（YAML 对 Tab 极度敏感）

server:
  host: 127.0.0.1
  port: 8080

❌ 错误示例：

server:
    host: 127.0.0.1   # 4 空格

3. 显式指定类型（避免隐式转换）

YAML 会自动推断类型，容易出 Bug：

# 危险
port: 8080     # 看起来像数字
enable: no     # 会被解析为 false
version: 1.10  # 可能被解析为 1.1

✅ 推荐写法：

port: "8080"
enable: false
version: "1.10"

4. 使用多行字符串时明确方式

description: >
  这是一个很长的描述，
  会被合并成一行。

script: |
  #!/bin/bash
  echo "hello"

三、结构设计与可维护性

5. 一个文件只做一件事（单一职责）

❌ 不推荐：

deployment:
  ...
service:
  ...
configmap:
  ...

✅ 推荐拆分：

deployment.yaml
service.yaml
config.yaml

6. 使用锚点（&）和引用（*）减少重复

适合静态重复配置：

defaults: &defaults
  timeout: 30
  retries: 3

service_a:
  <<: *defaults
  name: a

service_b:
  <<: *defaults
  name: b

⚠️ 不建议过度使用，影响可读性

7. 使用变量 / 模板而不是硬编码

• Kubernetes：Helm / Kustomize
• Ansible：vars / group_vars
• CI/CD：环境变量

❌ 不推荐：

image: myapp:20240101

✅ 推荐：

image: "{{ .Values.image }}:{{ .Values.tag }}"

四、版本与变更管理

8. 所有 YAML 必须进 Git

• 禁止手动修改线上 YAML
• Git 是唯一配置来源（GitOps）

✅ 推荐流程：

Git → CI → 自动校验 → 自动部署

9. 提交前必须校验（Lint）

使用工具避免低级错误：

yamllint deployment.yaml
kubectl apply --dry-run=client -f deployment.yaml

五、安全最佳实践（非常重要）

10. 禁止在 YAML 中明文存敏感信息

❌ 禁止：

password: admin123

✅ 正确方式：

• Kubernetes：Secret
• Ansible：ansible-vault
• CI：环境变量 / Vault

password:
  valueFrom:
    secretKeyRef:
      name: db-secret

11. 限制 YAML 执行权限

• 避免 privileged: true
• 避免 hostNetwork / hostPath
• 最小权限原则（RBAC）

六、Kubernetes 场景专项建议

12. 总是写 apiVersion / kind / metadata

apiVersion: apps/v1
kind: Deployment
metadata:
  name: app
  namespace: default

13. 明确 resource limits

resources:
  requests:
    cpu: 100m
    memory: 128Mi
  limits:
    cpu: 500m
    memory: 256Mi

14. 使用 namespace 隔离环境

dev/
test/
prod/

七、运维自动化建议

15. 用工具生成 YAML，而不是手写

• Helm
• Kustomize
• Terraform
• Ansible

✅ 手写 YAML 只用于最终产物或调试

八、常见 YAML 运维反模式（❌）

九、推荐工具链（运维必备）

十、一句话总结

YAML 运维最佳实践 = 可读 + 可校验 + 可版本化 + 不存敏感 + 模板化 + 自动化

如果你愿意，我可以：

• ✅ 给你一份 Kubernetes YAML 模板规范
• ✅ 帮你 审查现有 YAML
• ✅ 设计 企业级 YAML + GitOps 规范

只要告诉我你的具体场景即可。