企业DevOps研发管理平台技术管理规范.doc

企业DevOps研发管理平台技术管理规范

PAGE45/NUMPAGES45

企业DevOps研发管理平台技术规范

信息科技部

20XX年XX月

目录

TOC\o1-3\h\z\u20892目录 2

120461.制定说明 4

150651.1.概述说明 4

170901.2.内容说明 4

87311.3.编写目的 4

297001.4.目标读者 5

283771.5.术语说明 5

111002.平台简介 7

129942.1.平台定位 7

230252.2.技术架构 7

40143.岗位职责 8

5873.1.行方项目经理 9

281383.2.DevOps项目组 9

91773.3.应用项目组 9

36114.平台规范 9

20064.1.平台接入原则 9

69294.2.代码管理规范 10

87844.2.1.代码库结构管理规范 10

172044.2.2.代码库分支管理规范 11

41804.2.3.代码库提交操作规范 12

241914.2.4.代码库合并周期建议 13

175504.3.介质管理规范 13

33584.3.1.介质库分类规范 13

158434.3.2.介质库命名规范 14

235924.3.3.应用介质命名规范 14

163264.4.组件管理规范 15

105184.5.版本管理规范 15

6054.5.1.版本介绍 15

4694.5.2.版本规范 16

165644.6.环境资源规范 17

283404.7.构建管理规范 17

321364.7.1.构建定义名称 17

154874.7.2.提供编译脚本 17

234144.7.3.环境配置规范 17

205934.8.部署管理规范 19

29574.8.1.发布定义名称 19

74194.8.2.应用发布规范 19

116764.8.3.应用备份策略 20

177684.8.4.环境配置规范 20

制定说明

概述说明

本文档是XX企业DevOps研发管理平台规范。

本文档重点在于阐述本行研发项目接入DevOps研发管理平台规范。用于指导项目在使用DevOps研发管理平台进行研发及运维支撑，减少技术沟通的过程和成本，使用项目在平台进行进行代码管理、文档管理、介质管理、构建管理、部署管理等过程，在接入使用过程中都需要遵循本规范。

内容说明

本文档包含平台简介、岗位职责、平台技术规范三部分内容。

编写目的

DevOps研发管理平台作为我司研发支撑平台，为了规范研发过程、提升研发质量、服务于研发人员，用于指导、约束我司各应用系统使用DevOps研发管理平台开展研发管理工作。编写该文档的主要目标有下面几个方面:

加强我司项目研发过程的统筹管理，明确DevOps研发管理平台的适用范围，基于项目类型、应用场景，选择合适的接入模式。

制定DevOps研发管理平台代码管理规范、文档管理规范、构建管理规范、部署管理规范、介质管理规范等，从而实现应用系统规以标准化接入DevOps研发管理平台。

目标读者

本文档涉及到接入DevOps研发管理平台项目的技术标准和系统约定，目标读者主要包括:

1、信息科技部应用研发及应用运维人员。

2、项目实施厂商的项目经理、技术经理、开发人员、测试人员以及配置管理人员。

3、DevOps项目组成员。

术语说明

序号

术语

术语说明

1

Nexus

介质仓库，用于存放投产应用发版介质。

2

Jenkins

用于执行构建、部署、交付时使用的第三方工具，可按照环境类型配置多个引擎。

3

代码仓库

管理源码工具，支持：GitHub、GitLab、SVN，目前我司以Gitlab为代码仓库。

4

Maven

Maven项目对象模型(POM)，可以通过一小段描述信息来管理项目的构建、报告和文档的项目管理工具软件。

5

组件

组件是DevOps平台部署的最小单元，比如对于微服务架构的系统，一个微服务就是一个组件。组件分多种类型，比如程序、数据、配置类型。

6

流水线

服务发版编排的任务集合，主要在持续集成与持续部署中使用。

7

持续集成

持续集成是一种软件开发实践，即团队频发集成他们的工作，每次集成都通过自动化的构建（包括编译，发布，自动化测试）来验证，从而尽早地发现集成错误。

8

持续交付

软件产出过程在一个短周期内完成，以保证软件可以稳定、持续的保持在随时可以发布的状况。目标在于让软件的构建、测试与发布变