Arbess基础教程-创建流水线

Arbess(谐音阿尔卑斯) 是一款开源免费的 CI/CD 工具，本文将介绍如何使用 Arbess 配置你的第一条流水线，以快速入门上手。

 1. 创建流水线

根据不同需求来创建不同的流水线。

1.1 配置基本信息

配置流水线的基本信息，如分组，环境，权限，人员等。



属性说明：

字段	说明
流水线名称	流水线名称清晰地标识项目或对象，不能重复以及输入特别字符。
流水线分组	流水线分组便于组织和管理流水线。
流水线环境	流水线环境便于组织和管理流水线。
流水线权限	私有：只有创建者，以及流水线成员可以看到。 全局：系统内的所有人都可看到，查看。



1.2 选择不同的模版

Arbess提供了丰富的模板，使用者可以根据不同的需求选择不同的模板。





2. 配置流水线

配置流水线的任务，根据不同的需求添加不同的任务，源码，测试，部署，代码扫描，推送制品，拉取制品等几十种任务支持。

2.1 配置源码

流水线支持配置多种源码仓库，通用Git、Gitee、GitLab、GitHub、GitPuk、Svn等。

点击新阶段 --> 点击源码 --> 选择通用Git





属性说明：

字段	说明
git地址	git克隆的url
分支	选择克隆的分支
凭证	远程仓库的效验凭证。



2.2 配置代码扫描

Arbess集成了多种代码扫描工具，SonarQube代码扫描、SpotBugs-Java代码扫描等

点击新阶段 --> 点击代码扫描 --> 选择SpotBugs-Java代码扫描任务



属性说明：

字段	说明
扫描路径	默认为${DEFAULT_CODE_ADDRESS},也可输入绝对路径。
调试模式	可以输出更加详细的日志。
扫描断言	是否扫描代码中的断言。
扫描等级	等级越高，扫描的深度越大。
错误级别	等级越高，错误校验越严格。



2.3 配置构建

Arbess支持多种语言构建，npm、Maven、Docker等构建方式来构建出制品。

点击新阶段 --> 点击构建 --> 选择Maven构建





属性说明：

字段	说明
模块地址	默认为${DEFAULT_CODE_ADDRESS},也可输入绝对路径。
执行命令	执行的构建命令maven的默认命令为mvn clean package。



2.4 配置部署

Arbess支持多种部署方式来满足用户不同的需求，自定义部署，主机部署，Docker部署，K8s集群部署等。

点击新阶段 --> 点击部署 --> 选择主机部署。





属性说明：

字段	说明
部署方式	可选择自定义部署或者结构化部署。
主机地址	需要部署在那个主机上边。
部署文件	默认为${DEFAULT_CODE_ADDRESS},也可输入绝对路径。
部署文件匹配规则	配置部署文件，支持正则表达式。
部署位置	需要把文件部署在服务器的那个位置上。
部署命令	需要对部署文件进行怎样的操作。
部署策略	可选择每一批暂停部署或第一批暂停部署这两种方式。
部署主机数量	默认为1，如果有多个主机，可选择多个主机部署。



2.5 删除流水线配置

鼠标放在任务上面 --> 点击删除按钮 --> 点击确定即可删除任务配置，删除后无法恢复





3. 运行流水线

运行流水线，并实时查看流水线运行信息。

3.1 运行

配置完成，点击左上角运行即可运行流水线

• 选择执行端

可以选择在不同的agent中执行。



3.2 查看运行状态

可以实时查看流水线运行信息，点击任务的日志按钮可以查看任务的具体输出的日志。





3.3 查看日志详情

Arbess支持查看具体任务日志详情，可以看到任务的具体日志输出。



3.4 查看测试报告

可以查看代码的具体扫描结果，各种Bug数量，级别，bug的优先级，以及出现bug的原因，具体行数等信息。





属性说明：

字段	说明
一级问题	较大可能可以引起Bug的问题。
二级问题	警告信息，忽略有小概率引发Bug。
三级问题	可忽略的问题。
包路径	问题出现的包路径。
优先级	优先级越小，问题越严重。
Bug类型	出现的Bug类型。



4. 管理流水线

管理流水线的基本信息，人员，权限，角色，消息通知等信息。

4.1 成员管理

可以将不同的成员拉取流水线，让多个人来共同管理，维护流水线。





4.2 权限管理

可以为不同成员配置不同的权限。



属性说明：

字段	说明
角色类型	超级管理员：流水线创建者，唯一，不可添加，权限不可更改。 管理员：流水线管理员。 普通用户：普通用户。
创建方式	系统内置：流水线默认，不可删除。 自定义：用户额外添加的角色
成员类型	可添加用户，用户组，部门



4.3 消息通知

用户可以配置消息提醒



属性说明：

字段	说明
事件	事件触发时会发送消息提醒。
通知方式	配置当前事件的通知方式，可配置，企业微信，邮箱等通知方式。
通知成员	可添加用户，用户组，部门



4.4 基本信息

• 编辑流水线信息

编辑流水线基本信息，流水线名称，分组，环境，权限等。



属性说明：

字段	说明
流水线名称	流水线名称清晰地标识项目或对象
流水线分组	流水线分组便于组织和管理流水线
流水线环境	流水线环境便于组织和管理流水线
流水线权限	私有：只有创建者，以及流水线成员可以看到。 全局：所有人都可看到

• 删除流水线

点击左下角 --> 点击流水线信息 --> 点击流水线删除 --> 点击删除按钮 --> 输入流水线名称点击确定即可，流水线删除后不可恢复。





5. 帮助与支持

如果在安装过程中遇到了问题，可以查阅文档或进入社区进行反馈交流。

文档：

Arbess - 文档 (tiklab.net)

社区：

TikLab - 社区