3、标准模板设计原则

平台工程中的自助目录模板并非一次性编写的静态文件，而是需要遵循一系列软件工程与平台设计原则的“活产物”。以下六大原则构成了标准模板设计的核心骨架，确保模板可复用、可维护、可组合且安全合规。

3.1 模板化思维

模板化思维要求将基础设施、应用配置、流水线等资源抽象为参数化的“蓝图”，而非硬编码的实例。其核心在于“定义一次，生成多次”。

• 参数化： 将环境、版本、实例数等变量提取为输入参数，而非写死在模板中。
• 模块化： 将大型模板拆分为可独立维护的模块（如网络模块、存储模块、计算模块）。
• 标准化： 同一类资源（如所有微服务）使用同一套模板结构，减少认知负担。

3.2 DRY 原则（Don't Repeat Yourself）

DRY 原则要求消除模板中的重复逻辑与配置。重复不仅增加维护成本，更是配置漂移和故障的温床。

3.3 可组合性

可组合性指模板应像“乐高积木”一样，能够通过拼接、嵌套、覆盖等方式灵活组装出不同形态的资源栈。这是实现平台自助服务的关键能力。

• 原子模块： 每个模块只负责一个职责（如“创建VPC”、“部署Redis集群”），粒度适中。
• 组合接口： 模块之间通过明确的输入/输出契约进行组合，而非内部状态耦合。
• 覆盖机制： 允许上层模板在组合时覆盖下层模块的默认参数，实现定制化。

3.4 可观测性

模板必须内置可观测性能力，使平台团队和开发者能够实时了解资源状态、部署进度和运行健康度。可观测性不是事后添加的“补丁”，而是模板设计的一部分。

3.5 安全合规内置

安全与合规不应是事后检查的“门禁”，而应作为模板的默认行为。平台工程通过“安全左移”将安全策略嵌入模板设计阶段。

• 最小权限原则： 模板中为服务账号、IAM 角色自动分配最小必要权限，而非开放所有权限。
• 加密默认： 所有存储、传输中的数据默认启用加密（TLS、KMS、加密卷）。
• 合规基线： 模板内置行业合规基线（如 SOC2、PCI-DSS、HIPAA）的配置检查点。
• 策略即代码： 使用 OPA（Open Policy Agent）或类似工具，在模板渲染阶段即进行策略校验。

# 安全合规内置示例：OPA 策略片段（Rego 语言）
package platform.security

# 禁止使用默认的、未加密的存储卷
deny[msg] {
  input.kind == "PersistentVolumeClaim"
  not input.spec.storageClassName
  msg := "PVC 必须指定加密存储类，禁止使用默认未加密存储"
}

# 强制容器以非 root 用户运行
deny[msg] {
  input.kind == "Deployment"
  container := input.spec.template.spec.containers[_]
  not container.securityContext.runAsNonRoot
  msg := sprintf("容器 %v 必须以非 root 用户运行", [container.name])
}

3.6 版本控制

模板本身是代码，必须纳入版本控制系统（如 Git）。版本控制不仅用于追溯变更，更是平台发布管理、回滚和多环境管理的基础。