Arbess实践指南(1) - 使用Arbess+sourcefare实现Java项目自动化部署 + 代码扫描

原创已于 2025-11-28 10:25:57 修改 · 1k 阅读

CC 4.0 BY-SA版权

文章标签：

#Tiklab DevOps #Arbess CICD #sourcefare代码扫描

于 2025-11-01 17:22:10 首次发布

Arbess 是 Tiklab 生态链中一款国产开源免费的 CI/CD 工具，sourcefare是 Tiklab 生态链中一款国产开源免费的代码扫描工具。本文将详细介绍如何安装Arbess和sourcefare，创建配置流水线，克隆通用git代码，自动化执行代码扫描及构建部署。

1、sourcefare 安装与配置

本章节将介绍如何使用CentOS搭建sourcefare服务，提供给Arbess调用进行代码扫描。

1.1 安装

本文以CentOS操作系统为例。

下载，CentOS安装包下载地址：Sourcefare下载，点击CentOS下载，下载安装包如tiklab-sourcefare-x.x.x.rpm。
安装，上传到服务器上，在文件同级目录执行以下命令安装。

rpm -ivh tiklab-gitpuk-x.x.x.rpm

启动，系统默认安装路径为/opt目录，进入/opt/tiklab-sourcefare/bin目录下，执行./sourcefare start即可启动成功。

启动系统

使用 http://ip:8900 进行访问。使用初始用户名密码admin\123456登录，首次登录需要修改管理员密码。成功登录后展示sourcefare首页。

首页

2.2 配置

sourcefare登录成功，需要添加项目，以及代码扫描计划，Arbess运行代码扫描需要代码扫描计划ID，代码扫描报告会归类到相应代码扫描计划。

在项目页面点击新建项目按钮进行新建。输入项目名称以及项目访问信息（公开、私密）进行创建。

新建项目

成功创建扫描计划后，在扫描计划页面，需要记住ProjectKey，后期Arbess集成sourcefare需要用到，也可查看Arbess调用的历史扫描计划报告。

创建扫描计划

2、Arbess 安装与配置

2.1 安装

本文以CentOS操作系统为例。

下载，服务端安装包含Agent安装，CentOS安装包下载地址：Arbess下载，点击CentOS下载，下载完成后得到类似tiklab-arbess-x.x.x.rpm的文件。

wget -O tiklab-arbess-2.0.8.rpm https://install.tiklab.net/app/install/arbess/V2.0.8/tiklab-arbess-2.0.8.rpm

安装，上传到服务器上，在文件同级目录执行以下命令安装。

rpm -ivh tiklab-arbess-x.x.x.rpm

启动，系统默认安装路径为/opt目录，进入/opt/tiklab-arbess/bin目录下，执行./arbess start即可启动成功。

启动Arbess

使用 http://ip:9200 进行访问。使用初始用户名密码admin\123456登录，首次登录需要修改管理员密码。成功登录后展示Arbess首页。

Arbess首页

2.2 配置

Arbess流水线采用可视化设计，在流水线中克隆通用Git仓库代码、执行sourcefare代码扫描及构建部署。创建流水线，进入流水线设计页面进行操作。

2.2.1 配置Gitee源码任务

进入流水线设计，点击新阶段→源码→通用Git。

添加通用Git源码任务

字段	描述
任务名称	任务名称清晰地标识项目或对象。
Git版本	Arbess所在服务器Git安装路径。
Git仓库地址	通用Git仓库地址。
分支	选择代码的分支。填写需要拉取远程仓库具体的分支，不填默认为master分支，填写错误会导致任务执行失败。
认证	通用Git仓库方式，支持用户名密码和密钥。

2.2.2 配置sourcefare代码扫描

配置sourcefare服务集成

流水线配置sourcefare任务之前，需要添加sourcefare服务集成，在系统设置→集成与开放→服务集成页面添加相关服务。授权类型选择sourcefare、填写名称、服务地址、认证类型（用户名密码、密钥）、用户名、密码。

添加sourcefare服务

配置sourcefare Scanner工具集成

还需要配置sourcefare Scanner工具，进入下载地址：SourceFareAgent下载。下载对应系统文件。在系统设置→集成与开放→工具集成页面添加相关服务。授权类型选择Sonar Scanner、填写名称、安装方式选择安装包，上传sourcefare Scanner工具安装包。

添加sourcefare Scanner工具

上传sourcefare Scanner工具安装包，系统会自动解析运行文件地址。

添加sourcefare Scanner工具

配置sourcefare服务集成

服务配置完成后，进入流水线设计页面，点击新阶段→代码扫描→sourcefare代码扫描。添加成功之后，弹出代码扫描的配置。

配置sourcefare代码扫描任务

字段	描述
任务名称	任务名称清晰地标识项目或对象。
扫描类型	客户端扫描：扫描流水线配置代码源。服务端扫描：选择sourcefare客户端配置的扫描方案。
sourcefare Scanner版本	安装sourcefare Scanner的安装路径。
扫描代码语言	扫描代码语言。
JDK版本	所在服务器JDK安装路径。
Maven版本	所在服务器Maven安装路径。
扫描代码地址	扫描代码存放路径，默认为${DEFAULT_CODE_ADDRESS}，也可输入绝对路径。
是否开启覆盖性扫描	选择是否开启代码覆盖性扫描。
sourcefare服务	安装sourcefare的服务器地址、用户名、密码。
项目KEY	选择在sourcefare中创建的项目名称。

2.2.3 配置Maven构建任务

代码扫描添加完毕之后，添加构建安装包任务。根据代码构建方式选择Maven构建，点击新阶段→构建→Maven构建。输入构建信息，输入完成后，点击空白处进行保存。

配置Maven构建任务

字段	描述
任务名称	任务名称清晰地标识项目或对象。
JDK版本	Arbess所在服务器JDK安装路径。
Maven版本	Arbess所在服务器Maven安装路径。
模块地址	构建路径，默认为${DEFAULT_CODE_ADDRESS}，也可输入绝对路径。
执行命令	执行Maven构建的命令。

2.2.4 配置主机部署任务

点击新阶段→部署→主机部署。输入部署信息，部署的内容可以使用变量，添加变量后使用${变量名称}进行引用，输入完成后，点击空白处进行保存。

配置主机部署任务

字段	描述
任务名称	任务名称清晰地标识项目或对象。默认主机部署。
主机地址	部署主机远程SSH认证凭证。
部署文件	需要部署的文件，可以写绝对路径，也可以写泛路径，泛路径需要配合部署文件规则来匹配到部署文件。
部署文件匹配规则	文件匹配规则，支持正则表达式。
部署位置	部署远程主机位置。
部署命令	文件部署命令。