第1章 概述

1.1 简述

本文档主要介绍基于苍穹gPaaS的轻轨线服务二开管理平台，制作二开补丁包并升级苍穹应用的完整流程，适用于熟悉苍穹二开的开发人员，设计人员和部署人员。

（基于苍穹二开管理平台轻轨线服务的研发流程）

1.2 环境准备

使用苍穹二开管理平台的轻轨线服务的前置条件：

1) 在gPaaS标准版的基础上，苍穹二开管理平台轻轨线服务已安装部署完成；

2) 测试网络，能正常访问容器服务、nexus、gitlab等组件；

3) 明确苍穹环境的信息参数，如mc的地址等。

（基于gPaaS的苍穹轻轨线服务二开管理平台的安装部署流程）

第2章 补丁制作流程

2.1 CICD服务首页预览

首先进入CICD服务首页，对整个服务的平台数据进行预览。

说明：发布历史需要轻轨线V2.9.4及以上版本才支持。

2.2 创建或关联苍穹环境

进行苍穹二开需要苍穹环境支持，我们可以对已有的苍穹环境进行关联，方便在后续CICD操作过程中进行引用。

操作路径：【控制台】→【苍穹环境管理】→【关联环境】

详细的操作流程可以参考说明：苍穹环境管理

2.3 创建项目

创建项目是进行苍穹二开工作的第二步，此处的“项目”需根据用户自己的业务特性进行定义，一个项目可以对标苍穹的全工程、或苍穹的一个云、或苍穹的一个应用，与代码工程的组织结构高度相关，同时关系到后续流水线配置。详细的说明可参考文档：项目与代码结构

回到创建项目的操作流程，要创建项目只需执行：【左上角菜单】→【项目管理】→【新建项目】，按弹框提示输入项目名称、项目编码以及项目描述，注意项目名称和项目编码不可与已有项目重复。

注意：新建项目成功后，系统会弹窗提示引导您创建苍穹devops方案，请您务必点击【确认】前往进行创建。

2.3.1 新建苍穹DevOps方案

新建苍穹DevOps方案，可以帮助用户基于创建的项目，一键生成二开所需的代码托管目录、流水线、制品库，以及相应的用户权限。为二开人员节省初始化工作时间。

操作路径为：左上角菜单→项目管理→苍穹DevOps方案→新建方案

需要手工关联项目和苍穹环境，系统会在代码仓库设置项默认生成一个示例代码工程，同时创建苍穹标准的CI、CD流水线，最后自动生成项目下的制品库。

说明：

1）如未使用轻轨线默认安装的gitlab，系统不会生成苍穹标准示例代码工程。

2）创建流水线模板时，可以选择“补丁包构建部署”和“镜像构建部署”方案，“镜像构建部署”方案需要轻轨线V2.9.4及以上版本才支持，点击查看镜像构建部署详情。

（关联项目和苍穹环境）

（生成苍穹标准示例代码工程）

（生成苍穹标准CICD流水线和制品仓库）

2.3.2 添加项目成员

项目完成了苍穹DevOps初始化后，如需对项目成员进行修改，可以通过【成员管理】界面进行操作。左侧【项目列表】，点击目标项目的项目名称，进入到项目详情页，【通用设置】里点击“成员管理”可以为项目添加不同角色的成员，并且可自定义同步到gitlab中。

说明：您也可以为不同的项目成员赋予不同的权限，点击查看详情。

2.3.3 查看gitlab中项目初始化

现在，我们可以在gitlab中验证一下刚才基于项目的苍穹DevOps方案的运行效果。点击左侧【云原生代码仓库】，即跳转到gitlab登陆页面，注意这里需要使用账户名或者邮箱登陆，手机号是无法登陆的，登陆密码与控制台密码一致。登陆进去之后即可看到在gitlab中初始化的项目了。

注意：这里的gitlab示例代码是在新建苍穹DevOps方案时生成，如果未采用系统默认安装的gitlab，而使用自己已有的gitlab，因系统无法获取相关权限，这里不会生成代码工程示例。

（初始化后自动生成的苍穹示例代码结构）

苍穹示意工程结构说明：

demo，即苍穹的示例工程仓库，内含一个 /demo/fi/app01 的初始代码路径，“app01”即一个示例苍穹应用，客户可根据自身实际创建更多应用。每个应用包括业务代码（Java）、元数据（metadata）和数据库脚本（dbscripts）三部分：

1．dbscripts，数据库结构（开发人员编写 sql 脚本手工提交）；

2．metadata，元数据（来自开发服务云迁入，元数据同步git查看这里  ）；

3 . java，代码包可能会包含多个jar包，由开发人员手工提交。

（苍穹应用中的标准路径）

staticfiles，即静态资源，由开发人员手工提交到此仓库。

node-debugger-server，即苍穹开发所需的初始化模板。

另外，执行苍穹DevOps方案后，在业务代码的存放路径下，可以看到一个build.gradle.server文件，里面记录了流水线构建所需的依赖信息。示例应用的java代码路径下，文件已经自动生成。

在示例模板中，苍穹应用的构建所需依赖已经提前内置在appstore。若客户的应用构建有自己的依赖组件，可以按下图示例，修改依赖组件路径。

2.3.4 苍穹应用管理

完成代码仓库配置后，下一步需要配置苍穹应用，以便在CI流水线时可以直接选择应用进行构建。每个应用会录入相关的元数据地址、数据库脚本地址、gradle文件路径等信息。

操作路径：左上角菜单→【项目管理】→ 点击”目标项目”进入项目详情页 → 【苍穹应用管理】→ 点击“新增”

参数说明：

• 元数据存放路径：选填，格式为:/demo/fi/app01/datamodels/metadata

• 数据库脚本存放路径：选填，格式为: /demo/fi/app01/dbscripts

• 工程信息：根据苍穹应用的代码工程实际情况填写，选填；gradle文件路径格式为:/demo/fi/app01/java/project01。
注意：元数据、数据库脚本、代码工程路径在填写时，要带上仓库名，以下图为例，仓库名为demo，元数据存放路径为：/demo/fi/app01/datamodels/metadata

2.4 流水线配置

回到项目管理页面，点击左侧【流水线列表】，即可看到创建苍穹DevOps方案时自动创建的CI/CD两条流水线，CI为补丁包制作流水线，CD为补丁包升级发布流水线。

2.4.1 CI流水线配置

（苍穹初始化方案生成的两条标准流水线）

生成的流水线已经包含了苍穹的标准升级脚本，按步骤配置参数即可运行。

注意：代码扫描节点需要V2.8.6及以上版本才支持，点击查看配置详情。

一、配置【全局变量】

点击CI流水线进入流程配置预览，点击下方【全局变量】进行流水线环境变量的配置，这里请务必细致严谨，流水线环境变量说明点击这里  ，配置完后点击右上角保存。

二、配置代码仓库

回到流水线编辑页，在流水线的“拉代码”节点和“拉静态资源“节点，配置代码仓库路径和构建分支。

三、选择构建的苍穹应用

在流水线的“构建补丁包”节点，选择此次构建的苍穹应用，支持多选。

构建组合比较灵活，客户可自行决定构建哪些应用（这些应用和代码的对应关系在步骤2.3.4中维护），或仅构建应用代码，仅构建元数据或静态资源等。

说明：从V2.9.11版本开始，我们不仅支持自定义选择苍穹应用，也支持按苍穹应用和工程进行顺序构建。具体操作步骤为：勾选“开启顺序构建”-鼠标移到要调整的已选应用或者代码工程，拖动方框即可完成顺序调整。

V2.9.11以下版本操作页面（不支持顺序构建）

V2.9.11及以上版本操作页面（支持顺序构建）

整条流水线配置完后点击右上角保存即可运行。由于流水线需要执行拉取代码、构建等操作，需要耐心等待一段时间，结点标绿打钩即表示运行成功并继续下一个结点，标红叹号即表示运行失败，从第一个运行失败结点开始，往后结点不再运行。运行日志可以点击运行记录查看，各个结点也可以查看对应运行日志，运行失败也可在日志里面查看失败原因。所有节点运行成功，即表示流水线运行成功。

CI流水线执行拉取代码、构建、打包的操作，运行成功之后会将zip包上传到制品库，可登陆制品库查看，回到控制台，点击【云原生制品库】，找到对应的项目仓库，即可查看并下载补丁包。

2.4.2  CD流水线的配置

CD流水线配置方式同上，CD流水线的变量配置依然可以参考文档：苍穹CI/CD流水线环境变量说明 。

在CD流水线中，可以一键引用苍穹环境的参数，各个环境参数维护详见：苍穹环境管理，相关参数均在这里配置。

注意环境变量配置中，RESTART_NODEPORT_ADDRESS（苍穹服务的对外访问地址）为：xxx.xxx.xxx.xxx/端口（使用非8080对应访问端口）。

配置完后点击保存，CI流水线执行成功之后再执行CD流水线进行补丁升级发布。CD流水线运行成功之后，即可登陆MC查看升级历史，并检验补丁是否升级成功。

注：CI执行完之后生成zip补丁包，当CD执行失败时，可通过制品库下载补丁包，MC中手动升级验证，此过程可用于初步定位流水线运行失败的原因。