logo
0
0
Login
docs: 补充审批相关说明

CNB 部署配置项目

这是一个基于 CNB (Cloud Native Build) 的部署配置项目,用于管理不同环境的部署流程和配置。

项目通过 .cnb/tag_deploy.yml 文件进行统一的部署环境配置管理。 通过 .cnb.yml 文件配置部署流水线,支持多环境部署策略。

项目特点

  • 支持多环境部署(本项目配置了三种环境:Development、Staging、Production)
  • 统一的配置管理方式
  • 简单清晰的部署流程
  • 灵活的环境变量配置
  • 部署前置条件配置:元数据、环境、审批流程

环境配置说明

项目支持三个部署环境,每个环境都有其特定的配置:

Development 环境

tag_deploy.development: - name: dev stages: - name: 部署环境名 script: echo $name - name: tag script: echo $tag_name

Staging 环境

tag_deploy.staging: - name: staging stages: - name: 部署环境名 script: echo $name - name: tag script: echo $tag_name

Production 环境

tag_deploy.production: - name: production stages: - name: 部署环境名 script: echo $name - name: tag script: echo $tag_name

部署流程

每个环境的部署流程包含以下步骤:

  1. 环境名称确认

    • 系统会输出当前部署的环境名称
    • 用于验证部署目标环境是否正确
  2. Tag 版本确认

    • 输出当前部署的 tag 名称
    • 用于版本追踪和部署确认
  3. 部署执行

    • 根据环境配置执行相应的部署脚本
    • 自动完成部署流程

使用指南

配置文件说明

项目的核心配置文件是 .cnb.yml,它定义了所有环境的部署配置。配置文件结构如下:

$: tag_deploy.[环境名]: - name: [环境标识] stages: - name: [步骤名称] script: [执行脚本]

配置管理

  1. 修改环境配置

    • 直接编辑 .cnb.yml 文件
    • 在相应环境下添加或修改部署步骤
    • 保存更改后配置即时生效
  2. 添加新的部署步骤

    • 在对应环境的 stages 下添加新的配置项
    • 按照已有格式配置 namescript

部署命令

根据不同环境,使用以下命令进行部署:

  • Development 环境:cnb tag_deploy development
  • Staging 环境:cnb tag_deploy staging
  • Production 环境:cnb tag_deploy production

注意事项

环境特定注意事项

  1. Development 环境

    • 用于开发测试,可以频繁部署
    • 建议在此环境充分测试配置变更
  2. Staging 环境

    • 用于预发布测试
    • 建议模拟生产环境配置进行测试
  3. Production 环境

    • 生产环境部署,需要特别谨慎
    • 建议部署前进行完整的测试和验证
    • 重要更改需要进行审核

部署过程关键点

  1. 配置验证

    • 部署前检查配置文件格式是否正确
    • 确保环境变量配置完整
  2. 版本管理

    • 确保使用正确的 tag 版本
    • 保持版本命名规范统一
  3. 部署监控

    • 关注部署过程的输出信息
    • 及时处理可能出现的错误
  4. 回滚机制

    • 建议在部署前备份关键数据
    • 制定清晰的回滚策略

部署前置条件说明

通过 .cnb/tag_deploy.yml 文件进行部署环境配置,同时可以给环境配置部署前置条件,满足前置条件才可配置:

  • 环境:依赖的环境已经部署成功
  • 元数据:元数据值满足条件
  • 审批流程:审批通过