引言:
大型项目协同是DevOps要面对的一个重要场景,其中多项目发布上线协同,更是一个重要关键场景,一键发布就是为了解决这个场景而生的。本文主要介绍一键发布的界面设计、模型设计以及接口设计等。
目录:
1. 简介
2. 关键模型设计
3. 关键界面设计
4. 关键接口设计
5. 关键表设计
6. 总结
1. 简介
大型项目协同是DevOps要面对的一个重要场景,其中多项目发布上线协同,更是一个重要关键场景,一键发布就是为了解决这个场景而生的。
一键发布是指在一个项目群中,对其子项目的发布定义进行编排,成为一个发布流水线,然后对发布流水线执行一键发布。
1、应用场景
1)多项目同时上线,项目之间有依赖关系
2)版本火车
2、关键能力
1)编排需要支持串行、并行、聚合能力
2)发布流水线能够指定某些环境发布,并支持环境权限控制
3)一键发布时,可以对发布定义和发布任务进行筛选
4)能够实时看到每一个发布定义和发布任务的状态,及其详细执行日志
2. 关键模型设计
关键模型说明:
1)发布流水线:发布定义编排,可以配置环境类型,进行权限控制等;它的执行实例叫发布流水线实例。
2)发布定义:发布环境编排;它的执行实例叫发布实例。
3)发布环境:配置环境类型,进行权限控制,配置执行引擎,部署任务编排等;它的执行实例叫发布环境实例。
4)引擎流水线:引擎流水线任务编排;它的执行实例叫引擎流水线实例。
5)引擎流水线任务:最小的执行单元,比如拉代码,部署springboot等;在构建流水线中,一般叫构建任务;在部署流水线中,一般叫部署任务;它的执行实例叫引擎流水线任务实例。
6)引擎流水线任务属性:具体的流水线任务属性。
3.关键界面设计
1、发布流水线编排界面
发布流水线编排关键功能:
1)支持选择子项目中的发布定义。
2)支持串行。
3)支持并行。
4)支持聚合。
5)支持环境设置。
2、发布流水线发布预览界面
发布预览界面关键功能:
1)支持配置发布流水号,也可以自动生成。
2)支持对某一个发布定义可以选择是否执行。
3)支持对发布环境中的流水线任务可以选择是否执行。
3、发布流水线发布历史界面
发布历史界面关键功能:
1)支持查看发布流水行历史发布记录。
2)支持查看发布起止时间、进度、状态、日志等。
4、发布流水线发布实例详情界面
发布实例详情界面关键功能:
1)支持查看每一个发布定义的发布进度和结果。
2)支持查看某一个发布定义下的日志。
5、发布流水线发布日志界面
发布流水线的发布日志关键功能:
1)支持查看任何一个子项目的发布定义的日志。
2)支持在树形菜单上可以选择查看某一个发布环境,或者某一个引擎流水线任务的日志。
3)支持对日志进行全屏显示。
6、发布定义配置界面
发布定义配置关键功能:
1)支持发布环境编排:串行、并行、聚合等。
2)支持环境类型设定,引擎指定。
3)支持审批、确认类型配置
4)支持通知配置
7、引擎流水线任务编排界面
引擎流水线任务编排关键功能:
1)支持流水线任务编排:串行、并行、聚合等。
2)支持流水线任务属性配置。
3)支持流水线任务失败策略、失效等配置。
4.关键接口设计
1、发布流水线接口
代码语言:javascript复制//创建发布流水线
ReleasePipeline createReleasePipeline(ReleasePipeline releasePipeline)
//删除发布流水线
ReleasePipeline removeReleasePipeline(String releasePipelineId)
//启动发布流水线,注意:需要传递启动的发布定义,以及不执行的流水线任务
ReleasePipelineInstance startReleasePipeline(String releasePipelineId, String[] releaseDefinitionIds, String[] disableEngineStageIds)
//查询某一个发布流水线下的所有发布流水线实例
PageResultList<ReleasePipelineInstance> queryReleasePipelineInstances(String releasePipelineId, boolean cascadeReleaseInstance, int pageIndex, int pageSize)
(左右滑动查看全部代码)
发布流水线接口关键功能:
1)编辑:创建、修改、克隆、删除发布流水线等
2)操作:启动、终止发布流水线等
3)查询:查询发布流水线实例的进度、状态等
2、发布定义接口
代码语言:javascript复制//创建发布定义
ReleaseDefinition createReleaseDefinition(ReleaseDefinition releaseDefinition)
//删除发布定义
ReleaseDefinition removeReleaseDefinition(String releaseDefinitionId)
//启动发布定义,注意:需要传递要部署的发布环境,以及不执行的流水线任务
ReleaseInstance startRelease(String releaseDefinitionId, String[] releaseEnvIds, String[] disableEngineStageIds)
//查询某一个发布定义下的所有发布实例
PageResultList<ReleaseInstance> queryReleaseInstances(String releaseDefinitionId, boolean cascadeReleaseEnvInstance, boolean cascadeEngineStageInstance, int pageIndex, int pageSize)
// 获取发布环境的部署日志
BuildLog getReleaseEnvDeployLog(String releaseDefinitionId, String releaseInstanceId, String releaseEnvInstanceId, int start)
(左右滑动查看全部代码)
发布定义接口关键功能:
1)编辑:创建、修改、克隆、删除发布定义等
2)操作:
① 启动、终止发布定义等
② 部署、取消、审批发布环境等
3)查询:
① 查询发布实例的进度、状态等
② 查询发布环境实例的进度、状态、日志等
3、引擎流水线接口
代码语言:javascript复制//创建引擎流水线
EnginePipeline createEnginePipeline(EnginePipeline enginePipeline)
//删除引擎流水线
EnginePipeline removeEnginePipeline(String enginePipelineId)
//执行引擎流水线
EnginePipelineInstance executeEnginePipeline(String jobNamePrefix, EnginePipeline enginePipeline, Map<String, Object> pipelineContext)
//获取引擎流水线任务日志
BuildLog getEnginePipelineStageLog(String enginePipelineInstanceId, String engineStageInstanceId, int start)
(左右滑动查看全部代码)
引擎流水线接口关键功能:
1)编辑:创建、修改、克隆、删除引擎流水线等
2)操作:启动、终止引擎流水线等
3)查询:
① 查询引擎流水线实例的进度、状态、日志等
② 查询引擎流水线任务实例的进度、状态、日志等
5.关键表设计
1、发布流水线表
发布流水线表关键字段:
ENV_TYPE:环境类型,允许的部署环境类型设置,多个逗号分隔
2、发布流水线和定义编排表
发布流水线和定义编排表关键字段:
1)RELEASE_DEFINITION_ID:子项目的发布定义ID
2)PRE_RELEASE_DEFINITIONS:前续发布定义ID列表,多个逗号分隔
3)EXTEND:扩展信息,一般用于前端显示布局位置信息
3、发布流水线实例表
发布流水线和定义编排表关键字段:
1)RELEASE_DEFINITION_IDS:选择的发布定义ID列表,多个逗号分隔
2)INSTANCE_STATUS:实例状态,成功,失败,发布中
3)BEGIN_TIME:发布开始时间
4)END_TIME:发布结束时间
5)ESTIMATED_DURATION:预估持续时间,用于计算进度
6)DURATION:实际持续时间
其他实例表(发布实例表、发布环境实例表、引擎流水线实例表、引擎流水线任务实例表)字段类似
4、发布定义表
5、发布环境表
发布环境表关键字段:
1)PRE_RELEASE_ENVS:前续发布环境ID列表,多个逗号分隔
2)ENV_TYPE:环境类型,部署目标的环境类型设置,多个逗号分隔
3)ENGINE_PIPELINE_ID:引擎流水线ID
6、引擎流水线表
引擎流水线表关键字段:
1)STAGE_IDS:流水线任务ID列表(包含任务顺序),多个逗号分隔
2)ENGINE_ID:执行引擎ID,多个逗号分隔(多个时,选择最空闲的引擎)
3)ENGINE_NODE:执行引擎节点
7、引擎流水线任务表
8、引擎流水线任务属性表
6.总结
一键发布涉及多项目的部署,在具体实现过程中涉及很多方面,比如构建、部署;有时候在某个环节,可能还需要定时,人工审批,权限控制等,是一个很长且复杂的批处理过程。
一键发布是多项目并行开发过程中,一起上线一定会遇到的场景,如果通过人工操作来实现(现在很多企业的现状),对于上线的稳定性,效率都会有很大的不确定性,但是通过DevOps实现一键发布,则会完全不同,能够很容易的多次演练,避免人为的不确定性和效率低下的问题。所以,一键发布是DevOps解决大型项目协同场景的一个关键核心能力。
精选提问:
问:为什么要区分发布流水线和引擎流水线?能简述一下引擎流水线的技术实现吗?
答:发布流水线,是项目群一键发布的概念。引擎流水线是devops底层基础实现,一个引擎流水线会生成一个jenkins job。