4. 模板元数据定义：模板名称、版本号、作者、描述、标签、适用环境

发布策略模板的元数据是模板的“身份证”与“说明书”。在自助门户中，标准化的元数据定义是实现模板发现、版本追溯、环境隔离与权限控制的基础。本节将详细拆解元数据各字段的设计规范与配置调优要点。

4.1 元数据字段总览

一个完整的发布策略模板元数据应包含以下核心字段，它们共同构成了模板的语义描述与生命周期标识：

字段	类型	必填	约束与示例
模板名称	String	是	小写字母+连字符，如 canary-deploy-v2
版本号	SemVer	是	遵循语义化版本，如 1.2.0
作者	String	是	团队别名或个人ID，如 platform-team
描述	Text	是	简述策略目标与适用场景，不超过200字
标签	List[String]	推荐	用于分类与搜索，如 ["blue-green", "zero-downtime"]
适用环境	List[Enum]	是	可选值：dev, staging, prod

4.2 字段设计详解与调优

4.2.1 模板名称

模板名称是模板在门户中的唯一标识符，建议采用 策略类型-目标-序号 的命名模式：

• 策略类型：如 rolling、blue-green、canary、feature-flag。
• 目标：如 backend、frontend、db-migration。
• 序号：如 v2，用于区分同类型的不同变体。

# 命名示例
rolling-backend-v1
blue-green-frontend-v2
canary-db-migration-v1

4.2.2 版本号

严格遵循 语义化版本 2.0.0（SemVer）规范：

• 主版本号：模板结构或策略逻辑发生不兼容变更时递增。
• 次版本号：新增参数或扩展兼容场景时递增。
• 修订号：修复参数默认值、文档或内部逻辑缺陷时递增。

# 版本号示例
1.0.0  # 初始稳定版
1.1.0  # 新增了“流量权重”参数
2.0.0  # 策略从“线性滚动”改为“金丝雀+滚动”混合模式

4.2.3 作者

用于责任追溯与变更通知。建议使用 团队别名 而非个人邮箱，避免人员流动导致信息失效：

# 推荐
author: "sre-core"
author: "release-engineering"

# 不推荐
author: "zhangsan@company.com"

4.2.4 描述

描述应包含 策略目标、适用场景 与 关键限制。建议采用结构化模板：

description: |
  策略目标：实现前端服务的零停机蓝绿部署。
  适用场景：生产环境（prod）中需要快速回滚的 Web 服务。
  关键限制：需要至少 2 个副本，且不支持有状态服务。

4.2.5 标签

标签是模板分类与检索的核心手段。建议建立 企业级标签规范，避免标签膨胀：

• 策略维度：rolling, blue-green, canary, feature-flag, shadow。
• 环境维度：dev-ready, staging-validated, prod-approved。
• 技术维度：kubernetes, vm, serverless, database。

# 标签示例
tags:
  - "blue-green"
  - "kubernetes"
  - "prod-approved"
  - "zero-downtime"

4.2.6 适用环境

适用环境定义了模板的 安全边界。不同环境对策略的稳定性与风险容忍度不同：

环境	典型策略	风险容忍度	备注
dev	快速滚动、直接替换	高	允许失败，快速迭代
staging	金丝雀、蓝绿	中	模拟生产，验证策略
prod	蓝绿、滚动+健康检查	极低	必须包含自动回滚机制

4.3 元数据配置示例（YAML）

以下是一个完整的发布策略模板元数据配置示例，展示了各字段在实际文件中的组织方式：

# 模板元数据定义
apiVersion: release.company.com/v1
kind: DeploymentTemplate
metadata:
  name: blue-green-frontend-v2
  version: 1.2.0
  author: "sre-core"
  description: |
    策略目标：实现前端服务的零停机蓝绿部署。
    适用场景：生产环境（prod）中需要快速回滚的 Web 服务。
    关键限制：需要至少 2 个副本，且不支持有状态服务。
  tags:
    - "blue-green"
    - "kubernetes"
    - "prod-approved"
    - "zero-downtime"
  environments:
    - dev
    - staging
    - prod
spec:
  # 策略参数与步骤定义（后续章节展开）
  ...

4.4 元数据生命周期与版本管理流程

模板元数据并非一成不变，它需要与模板内容同步演进。下图展示了元数据从创建到废弃的完整生命周期：

4.5 元数据校验规则

在模板注册到自助门户时，系统应执行以下校验规则，确保元数据的完整性与合规性：

1. 名称唯一性：模板名称+版本号组合在全局必须唯一。
2. 版本号格式：必须匹配 ^\d+\.\d+\.\d+$ 正则。
3. 环境合法性：environments 列表中的值必须属于 [dev, staging, prod] 枚举。
4. 标签去重：标签列表内部不允许重复值。
5. 描述非空：描述字段不能为空字符串或仅包含空白字符。

# 伪代码：元数据校验逻辑
def validate_metadata(metadata):
    errors = []
    if not re.match(r'^\d+\.\d+\.\d+$', metadata.version):
        errors.append("版本号格式错误，需符合 SemVer")
    if not set(metadata.environments).issubset({'dev', 'staging', 'prod'}):
        errors.append("适用环境包含非法值")
    if len(metadata.tags) != len(set(metadata.tags)):
        errors.append("标签列表存在重复")
    return errors