文档

管理代码类型组件的流水线

更新时间:

BizWorks支持新增自定义流水线和添加三方流水线。在部署应用时,如果您可以找到有满足条件的自定义流水线,则将无法使用默认流水线;如果您未找到满足条件的自定义流水线,则仍然可以使用默认流水线部署应用。本文介绍如何新建和管理自定义流水线,以及如何添加和管理代码类型组件的三方流水线。

前提条件

新增自定义流水线

  1. 登录BizWorks,在选择平台下拉列表中选中微服务开发平台image.png

  2. 单击页面右上角a7.png图标或其文本框区域,在下拉列表中单击目标项目名称后,单击应用页签。在应用列表页面单击目标托管应用名称。image.png

  3. 在目标托管应用导航栏中,选择部署管理 > 流水线管理

  4. 流水线管理页面的自定义流水线页签,单击新增自定义流水线image.png

  5. 新增自定义流水线面板,填写流水线名称描述(选填),在关联组件下拉列表中选中目标关联组件。1

    说明

    如果在关联组件下拉列表中没有可选项,您可以在应用组件页面添加代码类型的组件。具体操作,请参见添加代码类型组件

  6. 完成后单击保存

    保存成功后,您可以在自定义流水线页签查看所新增的自定义流水线。

    说明

    新增自定义流水线启用/停用开关默认为启用

设计自定义流水线

  1. 流水线管理页面的自定义流水线页签,单击目标自定义流水线右侧操作列下的设计流水线

  2. 在目标自定义流水线设计器画布中,您可以参考以下步骤添加任务。

    1. 在目标位置单击1图标。1

      说明

      您可以添加阶段节点的任务,或在阶段节点内添加任务。

    2. 添加任务面板,如果您选择编译构建1

      1. 编辑构建面板,您可以修改任务名称描述1

      2. 单击添加步骤,在添加面板,选择目标任务(支持NPM构建Yam构建Maven构建制作镜像并推送至项目的镜像仓库)后,单击确定1

        添加任务步骤后的图片示例如下。您可以对任务步骤中的相关参数进行修改或配置,例如,修改步骤名称镜像名称镜像Tag等。1

        相关参数说明请参见下表。

        参数

        说明

        步骤名称

        四种不同类型的任务步骤的步骤名称分别默认为:NPM构建Yam构建Maven构建制作镜像并推送至项目的镜像仓库

        编码

        默认生成,且不支持修改。

        镜像名称

        • 默认的镜像名称规则为:项目编码-应用编码-组件编码

        • 支持变量以占位符的方式使用,例如,${变量名}/1234

        镜像Tag

        • 默认的镜像Tag为:年月日时分秒

        • 支持变量以占位符的方式使用,例如,${变量名}/1234

        工作目录

        • 在此目录下执行docker build

        • 支持变量以占位符的方式使用,例如,${变量名}/1234

        Dockerfile路径

        支持变量以占位符的方式使用,例如,${变量名}/1234

    3. 添加任务面板,如果您选择部署

      1. 部署面板,您可以修改任务名称(默认为部署)和描述(默认为将制品部署到目标环境)。

      2. 单击添加步骤,您可以修改步骤名称(默认为部署到目标环境)、目标部署环境类型设置,在部署镜像下拉列表中,选择目标部署镜像。1

        重要
        • 一个流水线中最多只能有一个部署到目标环境的步骤。

        • 部署镜像下拉列表中如果不存在可选项,您需要先在编辑构建任务里添加制作镜像并推送至项目的镜像仓库任务步骤。具体操作,请参见添加任务

      3. 单击确定

    4. 添加任务面板,如果您选择流水线控制

      1. 流水线控制面板,您可以修改任务名称(默认为流水线控制)和描述(默认为增加人工审批等控制)。1

      2. 选择审批方式,支持会签或签

        说明
        • 会签:需要所有人审批同意。

        • 或签:只需一名审批人同意或拒绝即可。

      3. 选择审批人范围,支持指定成员指定角色

        说明
        • 指定成员,可选择如下角色的成员:企业管理员、当前项目的项目负责人、当前应用的应用负责人、应用开发、应用运维。

        • 指定角色,可选择如下角色:企业管理员、当前项目的项目负责人、当前应用的应用负责人、应用开发、应用运维。

      4. 审批人下拉列表,选择目标审批人(支持多选)。

      5. 设置审批界面业务信息说明,准备一个默认的业务信息说明,通过变量方式设置审批页中的业务描述内容。

      6. 单击确定

    5. 添加任务面板,如果您选择执行命令

      1. 执行命令面板,您可以修改任务名称(默认为执行命令)和描述(默认为执行Shell命令等进行功能扩展)。1

      2. 单击添加步骤,在执行Shell命令区域,您可以修改步骤名称(默认为执行Shell命令),在命令文本框中输入命令。1

        重要
        • 命令中您可以使用${变量名}的方式使用变量,变量会以占位符的方式在流水线运行时自动替换,例如:cd ${WORKDIR}

        • 流水线实例的最长运行时间为1天,超时后实例状态将会为失败。

        • 在流水线实例运行日志会记录执行命令和执行结果,请谨慎使用敏感信息。

      3. 单击确定

  3. 新增变量(自定义变量)。

    1. 单击流水线设计器页面左上角新增变量

    2. 新增变量对话框中,设置变量名称默认值(选填)、描述(选填)和运行时设置1

      说明

      如果您选中运行时设置,在部署中心应用实例时,选择自定义流水线后,则能够显示需要赋值的自定义变量,并且自定义变量的记录能够在实例操作记录、实例详情中出现,且能够参与到回滚中。

      更多信息,请参见部署中心应用实例

    3. 单击创建

      在流水线变量区域,您可以查看所创建的自定义变量。

      您可以单击目标变量右侧1图标、1图标或1图标,编辑、复制或删除自定义变量。1

  4. 可选:编辑或删除目标任务节点。单击流水线中的目标任务节点后,单击1图标或1图标,编辑或删除该节点信息。1

  5. 可选:编辑或删除目标阶段节点。单击流水线中的目标阶段节点的1图标或1图标,编辑或删除该阶段节点信息。1

    说明

    流水线源代码准备阶段节点不支持编辑和删除。

  6. 完成流水线设计后,单击保存

修改自定义流水线基础信息

  1. 流水线管理页面的自定义流水线页签,单击目标自定义流水线右侧操作列下的修改基础信息

  2. 修改基础信息面板,完成修改流水线名称描述信息后,单击保存

复制自定义流水线

  1. 流水线管理页面的自定义流水线页签,选择目标自定义流水线右侧操作列下的复制

  2. 复制面板,设置流水线名称,填写描述(选填),完成后单击保存

删除自定义流水线

流水线管理页面的自定义流水线页签,选择目标自定义流水线右侧操作列下的删除

说明

删除后将无法在部署应用时使用该流水线。

添加三方流水线

  1. 在目标托管应用导航栏中,选择部署管理 > 流水线管理

  2. 流水线管理三方流水线页签,单击添加三方流水线

  3. 添加第三方流水线面板,完成相关参数设置。1

    1. 选择三方流水线连接配置下拉列表:

      • 如果您选择添加三方流水线连接配置(页面会自动跳转至运维导航栏中的三方流水线集成页面),后续操作步骤,请参见创建和管理三方流水线连接配置1

      • 如果您选择的目标流水线连接配置类型为阿里云云效1Jenkins

        单击选择流水线,在选择流水线对话框的流水线ID列表中选中目标流水线ID,单击确定1

      • 如果您选择的目标流水线连接配置类型为阿里云大禹1,您还需在选择应用下拉列表中选择目标应用。1

        单击选择流水线,在选择流水线对话框的流水线ID列表中选中目标流水线ID,单击确定

    2. 设置流水线使用条件,包括使用此流水线的组件类型使用此流水线的目标部署环境类型,填写流水线描述信息(非必填)。

      • 使用此流水线的组件类型包括:代码类型(选中)、镜像类型

      • 使用此流水线的目标部署环境类型包括:测试环境开发环境预发环境生成环境

    3. 单击创建

    添加完成后,您可以在三方流水线管理页面查看所添加的流水线。

编辑三方流水线

  1. 流水线管理页面的三方流水线页签,单击目标流水线名称或目标流水线名称右侧操作列下的编辑

  2. 编辑第三方流水线面板,完成相关配置项修改后,单击保存

删除三方流水线

流水线管理页面的三方流水线页签,单击目标流水线名称右侧操作列下的删除

说明

删除后将无法在部署应用时使用该流水线。

查看默认流水线的运行记录

  1. 流水线管理页面的自定义流水线页签,单击目标自定义流水线右侧操作列下的查看运行记录
  2. 运行记录详情页面,您可以单击目标运行记录ID右侧操作列下的详情日志1
  3. 部署记录详情面板或流水线运行记录查看运行记录详情。

复制默认流水线为自定义流水线

  1. 流水线管理页面的默认流水线页签,单击目标流水线名称右侧操作列下的复制为自定义流水线
  2. 复制为自定义流水线面板,完成相关配置项设置后,单击保存

启用或停用默认流水线

流水线管理页面的默认流水线页签,单击目标流水线名称右侧启用/停用列下的启停开关,启用或停用默认流水线。