检测到您已登录华为云国际站账号,为了您更好的体验,建议您访问国际站服务网站 https://www.huaweicloud.com/intl/zh-cn
不再显示此消息
流水线(CodeArts Pipeline)使用流程 流水线服务本质上是一个可视化的自动化任务调度平台,需配合CodeArts中编译构建、代码检查、测试计划、部署等服务的自动化任务使用。 根据实际需要,如开发测试环境应用部署、生产环境应用部署等,对这些自动化任务进行自定义编排,一
新建流水线(图形化) 准备工作 新建项目。 使用CodeArts Repo代码源:新建代码仓库。 新建CodeArts服务扩展点:用于提升CodeArts Repo代码库的操作权限,或连接非CodeArts的第三方代码库。 新建流水线 访问CodeArts Pipeline首页。
示例2:停止流水线 场景描述 本章将指导您通过API根据流水线ID停止流水线任务。 API的调用方法请参见4.2.5如何调用AP。 约束限制 已有流水线,并且流水线正在执行中。 涉及接口 通过用户token、流水线id停止流水线。 操作步骤 查看项目下构建任务列表。 接口信息 URI:POST
示例3:获取流水线状态 场景描述 本章将指导您通过API获取流水线状态。 API的调用方法请参见3-如何调用API。 约束限制 流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数获取流水线状态。 操作步骤 查询流水线任务执行状态。 接口信息 URI:POST
Token认证:通过Token认证调用请求,访问流水线服务用户界面默认使用Token认证。 AK/SK认证:通过AK(Access Key ID)/SK(Secret Access Key)加密调用请求。推荐使用AK/SK认证,其安全性比Token认证要高。请参见AK/SK鉴权。关
新建流水线分组 功能介绍 新建流水线分组 调用方法 请参见如何调用API。 URI POST /v5/{project_id}/api/pipeline-group/create 表1 路径参数 参数 是否必选 参数类型 描述 project_id 是 String 参数解释: CodeArts项目ID。
示例1: 执行流水线 场景描述 本章将指导您通过API执行流水线任务。 API的调用方法请参见3-如何调用API。 约束限制 待执行流水线任务已经在流水线服务中创建。 涉及接口 通过用户token、流水线id等请求参数启动流水线。 操作步骤 执行流水线任务。 接口信息 URI:POST
ins服务执行Jenkins任务等,可以通过新建扩展点来实现与相应服务的连接。 CodeArts支持以下扩展点。 表1 服务扩展点 类型 使用场景 Docker repository 用于连接Docker镜像仓库,连接成功后可以通过部署服获取仓库中的Docker镜像。 Jenkins
发布管理环境变量使用示例 用户可以在以下两种场景中使用环境变量。 配置发布管理发布策略时,在所编排任务的YAML路径参数中,可以使用“${变量名}”引用环境变量,如:“滚动升级”任务中的“工作负载YAML路径”参数。 图1 引用环境变量 在发布策略关联的YAML配置文件中使用“{{变量名}}”引用环境变量。
触发流水线执行、操作合并请求时触发流水线执行和创建标签时触发流水线执行。 具体配置方法和触发机制请查看配置流水线执行计划。 父主题: 功能使用
升级的工作负载YAML路径,填写YAML文件的相对路径。 当前目录为代码分支的根目录。 仅支持单个YAML文件。 YAML路径可以使用“${变量名}”引用环境变量,YAML文件中可以使用“{{变量名}}”引用环境变量。 灰度起负载插件 灰度起负载包括两种部署方式:镜像升级和YAML部署。 镜像创建
发布单展示负载名称、负载类型和命名空间。 人工卡点 发布单展示卡点时长、操作时间、卡点说明、卡点状态等信息。 父主题: 发布管理(CodeArts Release)使用指南
任务发布的环境类别,对发布管理的环境类型,目前支持开发环境、测试环境、预发环境和生产环境。 环境 需要发布的环境,详见新建发布管理环境。 产物地址 部署发布时使用的镜像地址,如:swr.example.com/demo/springboot-helloworld:v1.1,可以通过“${}”引用流水线参数,如:swr
默认值,required属性为false时,如不在流水线上重新输入,则默认使用此值 "required": true, # true则流水线编辑时必须重新填值,false则不填使用默认值 "label":
的更新事件,提交代码时,会触发该合并请求的更新事件,如果该合并请求的目标分支在流水线监听范围内,则会触发执行相应的流水线。 父主题: 功能使用
控制是否通过接口获取选项。 联动属性 建立其他所选组件和接口的联动关系,可以进行参数传递,当组件的值更新时,会使用新值作为参数对接口进行重新调用。 URL 仅支持HTTPS协议。 返回数据路径 使用的控件需为列表数据。如以下响应体示例的返回数据路径为“result.parameters”。 {
约束与限制 购买须知 流水线不支持单独购买,需开通CodeArts套餐后使用。 不同区域购买的资源不能跨区使用,需慎重选择。 使用须知 禁止构造存在风险的使用场景,对服务进行恶意攻击,如:DDos、Redos攻击等。 如果您使用CodeArts Pipeline服务开展特定行业的业务,如:
流水线参数env 使用env以键值对的形式定义环境变量,定义后可在流水线的任意任务中引用。 示例 env: version: 1.0.0 如上定义可在任意任务中使用“${version}”或“${{ env.version }}”的方式进行引用。 推荐使用“${{ env.version
可生效。 图5 配置Webhook触发 表2 配置Webhook触发 参数项 说明 Webhook触发源 将该地址复制到第三方系统触发器,使用Post方法调用,即可运行流水线。 IAM认证 启用IAM认证,需要将用户IAM Token加入接口请求头,调用示例如下: curl --header
在执行条件中定义不管前置任务(任务ID为“job_1”)运行成功或失败,均执行当前任务,表达式语法如下: ${{ jobs.job_1.status == 'COMPLETED' || jobs.job_1.status == 'FAILED' }} 配置完任务,单击“确定”,完成任务添加,可根据实际需要编辑、复制、删除、移动任务。