Arbess 是一款国产开源免费的 CI/CD 工具,工具支持一键部署,页面简洁易用。本文将详细介绍如何安装配置使用GitPuk、sourcefare、Arbess系统,使用流水线拉取GitPuk源码、使用sourcefare代码扫描、构建安装包并进行主机部署。
1、GitPuk 安装与配置
GitPuk是TikLab DevOps下一款开源免费代码管理工具,本章节将介绍如何使用CentOS搭建GitPuk服务器,并将代码存放在GitPuk服务器,提供给Arbess克隆。
1.1 安装
本文以CentOS操作系统为例。
- 下载,CentOS安装包下载地址:GitPuk下载,点击CentOS下载,下载完成后得到类似tiklab-gitpuk-x.x.x.rpm的文件。
- 安装,上传到服务器上,在文件同级目录执行rpm命令安装。
rpm -ivh --replacefiles --nodeps tiklab-gitpuk-x.x.x.rpm
- 启动,系统默认安装路径为/opt目录,进入/opt/tiklab-gitpuk/bin目录下,执行sh startup.sh即可启动成功。
启动GitPuk系统
使用 http://ip:9800 进行访问。使用初始用户名密码admin\123456登录,首次登录需要修改管理员密码。成功登录后展示GitPuk首页。
GitPuk首页
1.2 配置
GitPuk登录成功,需要添加代码仓库,GitPuk支持新建仓库上传代码和从其他软件导入仓库两种方式。
- 新建仓库
在仓库页面点击右上角“新建仓库”。
创建仓库
新建的仓库可通过HTTP和SSH方式按步骤上传代码。
上传代码
- 导入仓库
GitPuk也支持从外部仓库导入。
导入仓库
以私有Gitlab为例,导入需要提供私有Gitlab地址,以及访问密钥。添加外部仓库信息完成后,选择Gitlab的仓库,进行导入。
导入仓库
2、sourcefare 安装与配置
sourefare是TikLab DevOps下一款开源免费代码扫描工具,本章节将介绍如何使用CentOS搭建sourcefare服务,提供给Arbess调用进行代码扫描。
2.1 安装
本文以CentOS操作系统为例。
- 下载,服务端安装包含Agent安装,CentOS安装包下载地址:Sourcefare下载,点击CentOS下载,下载安装包如tiklab-sourcefare-x.x.x.rpm。
- 安装,上传到服务器上,在文件同级目录执行npm命令安装。
rpm -ivh --replacefiles --nodeps tiklab-gitpuk-x.x.x.rpm
- 启动,系统默认安装路径为/opt目录,进入/opt/tiklab-sourcefare/bin目录下,执行sh startup.sh即可启动成功。
启动SourceFare系统
使用 http://ip:9900 进行访问。使用初始用户名密码admin\123456登录,首次登录需要修改管理员密码。成功登录后展示sourcefare首页。
sourcefare首页
2.2 配置
SourceFare登录成功,需要添加项目,以及代码扫描计划,Arbess运行代码扫描需要代码扫描计划ID,代码扫描报告会归类到相应代码扫描计划。
在项目页面点击新建项目按钮进行新建。输入项目名称以及项目访问信息(公开、私密)进行创建。
新建项目
成功创建扫描计划后,在扫描计划页面,需要记住ProjectKey,后期Arbess集成SourceFare需要用到,也可查看Arbess调用的历史扫描计划报告。
创建扫描计划
3、Arbess 安装与配置
3.1 安装
本文以CentOS操作系统为例。
- 下载,服务端安装包含Agent安装,CentOS安装包下载地址:Arbess下载,点击CentOS下载,下载完成后得到类似tiklab-arbess-x.x.x.rpm的文件。
- 安装,上传到服务器上,在文件同级目录执行npm命令安装。
rpm -ivh --replacefiles --nodeps tiklab-arbess-x.x.x.rpm
- 启动,系统默认安装路径为/opt目录,进入/opt/tiklab-arbess/bin目录下,执行sh startup.sh即可启动成功。
启动Arbess系统
使用 http://ip:9200 进行访问。使用初始用户名密码admin\123456登录,首次登录需要修改管理员密码。成功登录后展示Arbess首页。
Arbess首页
3.2 配置
Arbess流水线采用可视化设计,实现Java项目自动化部署,在流水线中可克隆GitPuk仓库代码、集成SourceFare进行代码扫描。创建流水线,进入流水线设计页面进行操作。
3.2.1 配置GitPuk源码
- 配置GitPuk服务集成
流水线配置GitPuk源码任务之前,需要添加GitPuk服务集成,在在系统设置→集成与开放→服务集成页面添加相关服务。授权类型选择GitPuk、填写名称、服务地址(即文章1部分安装的GitPuk地址)、用户名、密码。
添加源码集成
- 添加GitPuk源码任务
服务集成添加完毕之后,进入流水线设计,点击新阶段→源码→自建GitPuk。
添加GitPuk源码任务
字段 | 描述 |
任务名称 | 任务名称清晰地标识项目或对象。 |
Git版本 | Arbess所在服务器Git安装路径。 |
自建GitPuk服务 | 自建GitPuk服务地址。 |
仓库 | 选择授权信息后点击仓库,程序会自动获取凭证权限下的仓库列表,管理者只需选择需要配置的仓库即可。 |
分支 | 选择代码的分支。填写需要拉取远程仓库具体的分支,不填默认为master分支,填写错误会导致任务执行失败。 |
3.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代码扫描任务
字段 | 描述 |
任务名称 | 任务名称清晰地标识项目或对象。 |
扫描代码语言 | 扫描代码语言。 |
JDK版本 | 所在服务器JDK安装路径。 |
Maven版本 | 所在服务器Maven安装路径。 |
sourcefare服务 | 安装sourcefare的服务器地址、用户名、密码。 |
sourcefare Scanner版本 | 安装sourcefare Scanner的安装路径。 |
项目ID | 扫描的项目ID,在sourcefare中创建的项目ID。 |
扫描代码地址 | 扫描代码存放路径,默认为${DEFAULT_CODE_ADDRESS},也可输入绝对路径。 |
3.2.3 配置Node.js构建任务
代码扫描添加完毕之后,添加构建安装包任务。根据代码构建方式选择Node构建,点击新阶段→构建→Node构建。输入构建信息,输入完成后,点击空白处进行保存。
配置Node.js构建任务
字段 | 描述 |
任务名称 | 任务名称清晰地标识项目或对象。 |
Node版本 | Arbess所在服务器Node安装路径。 |
模块地址 | 构建路径,默认为${DEFAULT_CODE_ADDRESS},也可输入绝对路径。 |
执行命令 | 执行Node构建的命令。 |
3.2.4 配置主机部署任务
点击新阶段→部署→主机部署。输入部署信息,部署的内容可以使用变量,添加变量后使用${变量名称}进行引用,输入完成后,点击空白处进行保存。
配置主机部署任务
字段 | 描述 |
任务名称 | 任务名称清晰地标识项目或对象。默认主机部署。 |
主机地址 | 部署主机远程SSH认证凭证。 |
部署文件 | 需要部署的文件,可以写绝对路径,也可以写泛路径,泛路径需要配合部署文件规则来匹配到部署文件。 |
部署文件匹配规则 | 文件匹配规则,支持正则表达式。 |
部署位置 | 部署远程主机位置。 |
部署命令 | 文件部署命令。 |
至此流水线设计完毕,下面介绍流水线运行以及查看代码扫描报告。
4、运行流水线
- 运行流水线
流水线设计完毕之后,Arbess支持自动触发、Webhook触发、手动触发三种运行模式。点击右上角“运行”按钮,手动触发流水线。
运行流水线
流水线运行同时,点击认为标签右下角“日志”,可查看运行实时日志。
查看日志
- 查看代码扫描报告
点击测试报告→代码扫描→sourcefare,查看sourcefare代码扫描报告。
查看sourcefare测试报告
点击sourcefare代码扫描报告名称,进入跳转到sourcefare查看详细报告。
查看sourcefare详细报告
问题TAB显示详细问题列表,点击问题列表的问题名称,还可以查看代码详细问题。
查看sourcefare详细问题
sourcefare还可以查看代码重复率、复杂度、覆盖率等信息。
查看sourcefare代码重复率
- 查看运行历史
可以在Arbess历史页面查看到流水线运行历史。点击运行历史序号,即可查看详细的运行日志。
运行历史
至此,使用Arbess成功搭建流水线,用来拉取GitPuk源码、使用sourcefare代码扫描,构建安装包并主机部署。