Arbess从基础到实践(20) - 集成GitHub+SonarQube实现Java项目自动化部署 - 教程
<style>pre { white-space: pre !important; word-wrap: normal !important; overflow-x: auto !important; display: block !important; font-family: "Consolas", "Monaco", "Courier New", monospace !important; font-size: 14px !important; line-height: 1.6 !important; padding: 16px !important; margin: 16px 0 !important; background-color: rgba(248, 248, 248, 1) !important; border: 1px solid rgba(225, 228, 232, 1) !important; border-radius: 6px !important; tab-size: 4 !important; -moz-tab-size: 4 !important; max-width: 100% !important; box-sizing: border-box !important }code { font-family: "Consolas", "Monaco", "Courier New", monospace !important; font-size: 14px !important; white-space: pre !important; word-wrap: normal !important; word-break: normal !important; overflow-wrap: normal !important; display: inline !important; background: rgba(0, 0, 0, 0) !important; border: none !important; padding: 0 !important; margin: 0 !important; line-height: inherit !important }
pre code { background: rgba(0, 0, 0, 0) !important; border: 0 !important; border-radius: 0 !important; display: block !important; line-height: 1.6 !important; margin: 0 !important; max-width: none !important; overflow: visible !important; padding: 0 !important; white-space: pre !important; word-wrap: normal !important; word-break: normal !important; color: inherit !important }
.token.comment, .token.prolog, .token.doctype, .token.cdata { color: rgba(112, 128, 144, 1) !important; font-style: italic !important }
.token.punctuation { color: rgba(153, 153, 153, 1) !important }
.token.atrule, .token.attr-value, .token.keyword { color: rgba(0, 119, 170, 1) !important; font-weight: bold !important }
.token.function, .token.class-name { color: rgba(221, 74, 104, 1) !important; font-weight: bold !important }
.token.selector, .token.attr-name, .token.string, .token.char, .token.builtin, .token.inserted { color: rgba(102, 153, 0, 1) !important }
.token.property, .token.tag, .token.boolean, .token.number, .token.constant, .token.symbol, .token.deleted { color: rgba(153, 0, 85, 1) !important }
.cnblogs-markdown pre, .cnblogs-post-body pre { white-space: pre !important; word-wrap: normal !important; overflow-x: auto !important; background-color: rgba(248, 248, 248, 1) !important; border: 1px solid rgba(225, 228, 232, 1) !important; border-radius: 6px !important; padding: 16px !important; margin: 16px 0 !important }
pre, pre, pre { white-space: pre !important; word-wrap: normal !important; overflow-x: auto !important }</style>
<div class="htmledit_views atom-one-dark" id="content_views"><p>Arbess 是一款开源免费的 CI/CD 设备，支持免费私有化部署，一键安装零安装。本文将详细介绍如何使用安装设置SonarQube、Arbess体系，使用流水线拉取GitHub源码、使用SonarQube代码扫描、构建安装包并进行主机部署。</p><h2>1、GitHub 配置</h2><p>本章节将介绍如何创建GitHub个人访问令牌，提供给Arbess克隆源码。</p><h3>1.1 设置</h3><p>登录GitHub仓库，登录后点击右上角头像，选择Settings进入设置。</p><p style="text-align: center"><img alt="" height="990" src="https://i-blog.csdnimg.cn/direct/ad277984fae94b84af6f9e39b8be79eb.png" width="1731">进入设置</p><p>进入设置后，点击Developer settings→Personal access tokens，进入个人令牌界面。点击创建令牌。</p><p style="text-align: center"><img alt="" height="989" src="https://i-blog.csdnimg.cn/direct/90a05f17cf55470294d59eedc34ed31e.png" width="1735">创建个人令牌</p><p>根据自身需求，输入名称、到期时间、访问仓库、权限等信息。</p><p style="text-align: center"><img alt="" height="1272" src="https://i-blog.csdnimg.cn/direct/d4e0383bec4f4cee8868f9f4a69e9a09.png" width="2560">创建个人令牌</p><p>创建完毕之后，保存创建的个人令牌，后续提供给Arbess调用使用。</p><h2>2、SonarQube 安装与配置</h2><p>本章节将介绍如何使用CentOS9搭建SonarQube25.1服务，在SonarQube创建任务，提供给Arbess调用。</p><h3>2.1 安装</h3><ul><li>安装依赖</li></ul><p>首先需要Java17和PostgreSQL。安装PostgreSQL数据库之后，执行如下命令，创建数据库sonarqube→创建用户名密码→赋予权限。</p><blockquote><p><code>sudo -u postgres psql</code></p><p><code>CREATE DATABASE sonarqube WITH ENCODING 'UTF8' TEMPLATE template0;</code></p><p><code>CREATE USER sonar WITH PASSWORD 'sonar';</code></p><p><code>GRANT ALL PRIVILEGES ON DATABASE sonarqube TO sonar;</code></p></blockquote><p style="text-align: center"><img alt="" height="250" src="https://i-blog.csdnimg.cn/direct/c9b990396da74220bc8b8e5c0dedd806.png" width="917">创建SonarQube数据库</p><p>数据库创建完成之后，可以修改数据库认证配置，编辑<code>/var/lib/pgsql/15/data/pg_hba.conf</code>，在最下方添加如下内容，并重启服务。</p><p>host sonarqube sonar 127.0.0.1/32 scram-sha-256</p><ul><li>安装SonarQube</li></ul><p>依赖安装完毕之后，安装SonarQube 25.1。</p><blockquote><p><code>wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-25.1.0.77747.zip</code></p><p><code>sudo unzip sonarqube-*.zip -d /opt</code></p><p><code>sudo mv /opt/sonarqube-* /opt/sonarqube</code></p></blockquote><p>创建专用用户。</p><blockquote><p><code>sudo useradd -M -d /opt/sonarqube -s /bin/false sonar</code></p><p><code>sudo chown -R sonar:sonar /opt/sonarqube</code></p></blockquote><p>修改SonarQube数据连接信息。编辑<code>/opt/sonarqube/conf/sonar.properties</code>。</p><blockquote><p><code>sonar.jdbc.url=jdbc:postgresql://localhost:5432/sonarqube</code></p><p><code>sonar.jdbc.username=sonar</code></p><p><code>sonar.jdbc.password=sonar</code></p><p><code>sonar.web.port=9000</code></p></blockquote><p>修改完成后进入，启动SonarQube服务。</p><blockquote><p>sudo -u sonar /opt/sonarqube/bin/linux-x86-64/sonar.sh start</p></blockquote><p style="text-align: center"><img alt="" height="599" src="https://i-blog.csdnimg.cn/direct/6caab711218547f1a57e6de896bba70d.png" width="1220">启动SonarQube服务</p><p>安装成功后访问 http://127.0.0.1:9000 地址利用用户名密码：admin\admin，访问SonarQube。</p><h3>2.2 配置</h3><p>登录SonarQube系统后，需要创建项目，以及将代码导入项目进行分析。在SonarQube首页，点击Create Project，创建项目。输入项目名称、项目Key，点击下一步进行创建。</p><p style="text-align: center"><img alt="" height="737" src="https://i-blog.csdnimg.cn/direct/961f070d3d4a485bb07fb31bf6bf0587.png" width="1934">创建SonarQube项目</p><p>工程创建完成之后，需要生成方案Token，点击右上角头像 → My Account → Security<strong>。</strong>输入Token名称 → 点击 Generate ， 复制生成的Token。</p><p style="text-align: center"><img alt="" height="989" src="https://i-blog.csdnimg.cn/direct/661e4ca1d2084bd3bcb3f0139ed6e6f9.png" width="1921">创建Token</p><p>创建完毕之后，得记住token和项目名称，Arbess集成SonarQube需要用到。</p><h2>3、Arbess 安装与配置</h2><h3>3.1 安装</h3><p>本文以CentOS操作系统为例。</p><ul><li>下载，CentOS安装包下载地址：<span contenteditable="false" tabindex="-1">Arbess下载</span>，点击CentOS下载，下载完成后得到类似tiklab-arbess-x.x.x.rpm的文件。</li><li>安装，上传到服务器上，在文件同级目录执行命令安装。</li></ul><blockquote><p><code>rpm -ivh tiklab-arbess-x.x.x.rpm</code></p></blockquote><ul><li>启动，体系默认安装路径为/opt目录，进入/opt/tiklab-arbess/bin目录下，执行./arbess start即可启动成功。</li></ul><p style="text-align: center"><img alt="" height="300" src="https://i-blog.csdnimg.cn/direct/53de808c54414f9b88589c9dd55eee86.png" width="1216">启动Arbess体系</p><p>运用 http://ip:9200 进行访问。使用初始用户名密码admin\123456登录。成功登录后展示Arbess首页。</p><p style="text-align: center"><img alt="" height="1089" src="https://i-blog.csdnimg.cn/direct/ffae98b6a6b54336bc628e38946ed1cd.png" width="1805">Arbess首页</p><h3>3.2 配置</h3><p>Arbess流水线采用可视化设计，达成Java项目自动化部署，在流水线中可克隆GitHub仓库代码、集成SonarQube进行代码扫描。创建流水线，进入流水线设计页面进行执行。</p><h4>3.2.1 配置GitHub源码</h4><ul><li>配置GitHub服务集成</li></ul><p>流水线配置GitHub源码任务之前，要求添加GitHub服务集成，在体系设置→集成与开放→服务集成页面添加相关服务。授权类型选择GitHub、填写名称、AccessTocken(个人密钥，即文章1.1部分创建的个人访问令牌)。</p><p style="text-align: center"><img alt="" height="990" src="https://i-blog.csdnimg.cn/direct/00e177465b064835987e6054acb871cd.png" width="1734">添加源码集成</p><ul><li>添加GitHub源码任务</li></ul><p>服务集成添加完毕之后，进入流水线设计，点击新阶段→源码→GitHub。需要填入任务名称、Git版本、GitHub授权信息（AccessTocken）、仓库、分支等信息。</p><p style="text-align: center"><img alt="" height="990" src="https://i-blog.csdnimg.cn/direct/6d2081cea59047b292612a56c175eb7a.png" width="1732">添加GitHub源码任务</p><table><tbody><tr><td colspan="1" rowspan="1"><p>字段</p></td><td colspan="1" rowspan="1"><p>描述</p></td></tr><tr><td colspan="1" rowspan="1"><p>任务名称</p></td><td colspan="1" rowspan="1"><p>任务名称清晰地标识项目或对象。</p></td></tr><tr><td colspan="1" rowspan="1"><p>Git版本</p></td><td colspan="1" rowspan="1"><p>Arbess所在服务器Git安装路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>GitHub授权信息</p></td><td colspan="1" rowspan="1"><p>私人令牌，AccessTocken。</p></td></tr><tr><td colspan="1" rowspan="1"><p>仓库</p></td><td colspan="1" rowspan="1"><p>选择授权信息后点击仓库，程序会自动获取凭证权限下的仓库列表，管理者只需选择需要配置的仓库即可。</p></td></tr><tr><td colspan="1" rowspan="1"><p>分支</p></td><td colspan="1" rowspan="1"><p>选择代码的分支。填写必须拉取远程仓库具体的分支，不填默认为master分支，填写错误会导致任务执行失败。</p></td></tr></tbody></table><h4>3.2.2 配置SonarQube代码扫描</h4><ul><li>配置SonarQube服务集成</li></ul><p>在架构设置→集成与开放→服务集成页面添加相关服务。授权类型选择Sonar、填写名称、服务地址、认证类型（用户名密码、密钥）、用户名、密码。</p><p style="text-align: center"><img alt="" height="876" src="https://i-blog.csdnimg.cn/direct/8ada4b6776e14ab2b696bafee42c4625.png" width="1735">添加SonarQube服务</p><p>新版本SonarQube只拥护个人令牌的方式扫描代码，服务地址认证方式需要选择密钥，填写个人密钥。</p><p style="text-align: center"><img alt="" height="992" src="https://i-blog.csdnimg.cn/direct/69acfa708e7c4e009a37c482ad5efea0.png" width="1735">添加SonarQube密钥</p><ul><li>添加SonarQube代码扫描任务</li></ul><p>服务集成添加完毕之后，进入流水线设计，点击新阶段→代码扫描→SonarQube代码扫描。添加成功之后，弹出代码扫描的配备。</p><p style="text-align: center"><img alt="" height="992" src="https://i-blog.csdnimg.cn/direct/8aeb921232b0414ab9f97c35de424726.png" width="1735">调整SonarQube代码扫描任务</p><table><tbody><tr><td colspan="1" rowspan="1"><p>字段</p></td><td colspan="1" rowspan="1"><p>描述</p></td></tr><tr><td colspan="1" rowspan="1"><p>任务名称</p></td><td colspan="1" rowspan="1"><p>任务名称清晰地标识工程或对象。</p></td></tr><tr><td colspan="1" rowspan="1"><p>扫描代码语言</p></td><td colspan="1" rowspan="1"><p>扫描代码语言。</p></td></tr><tr><td colspan="1" rowspan="1"><p>JDK版本</p></td><td colspan="1" rowspan="1"><p>所在服务器JDK安装路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>Maven版本</p></td><td colspan="1" rowspan="1"><p>所在服务器Maven安装路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>项目名称</p></td><td colspan="1" rowspan="1"><p>扫描的项目名称，在SonarQube中创建的项目名称。</p></td></tr><tr><td colspan="1" rowspan="1"><p>扫描代码地址</p></td><td colspan="1" rowspan="1"><p>扫描代码存放路径，默认为${DEFAULT_CODE_ADDRESS}，也可输入绝对路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>SonarQube服务</p></td><td colspan="1" rowspan="1"><p>安装SonarQube的服务器地址、用户名、密码。</p></td></tr></tbody></table><h4>3.2.3 配置Maven构建任务</h4><p>代码扫描添加完毕之后，添加构建安装包任务。根据代码构建方式选择Maven构建，点击新阶段→构建→Maven构建。输入构建信息，输入完成后，点击空白处进行保存。</p><p style="text-align: center"><img alt="" height="992" src="https://i-blog.csdnimg.cn/direct/003f2d06044946f88ebe034019f62426.png" width="1735">部署Maven构建任务</p><table><tbody><tr><td colspan="1" rowspan="1"><p>字段</p></td><td colspan="1" rowspan="1"><p>描述</p></td></tr><tr><td colspan="1" rowspan="1"><p>任务名称</p></td><td colspan="1" rowspan="1"><p>任务名称清晰地标识项目或对象。</p></td></tr><tr><td colspan="1" rowspan="1"><p>JDK版本</p></td><td colspan="1" rowspan="1"><p>Arbess所在服务器JDK安装路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>Maven版本</p></td><td colspan="1" rowspan="1"><p>Arbess所在服务器Maven安装路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>模块地址</p></td><td colspan="1" rowspan="1"><p>构建路径，默认为${DEFAULT_CODE_ADDRESS}，也可输入绝对路径。</p></td></tr><tr><td colspan="1" rowspan="1"><p>执行命令</p></td><td colspan="1" rowspan="1"><p>执行Maven构建的命令。</p></td></tr></tbody></table><h4>3.2.4 配置主机部署任务</h4><p>点击新阶段→部署→主机部署。输入部署信息，部署的内容可以使用变量，添加变量后使用${变量名称}进行引用，输入完成后，点击空白处进行保存。</p><p style="text-align: center"><img alt="" height="1025" src="https://i-blog.csdnimg.cn/direct/d52454ce38434a6796944e6d1fde189d.png" width="1595">安装主机部署任务</p><table><tbody><tr><td colspan="1" rowspan="1"><p>字段</p></td><td colspan="1" rowspan="1"><p>描述</p></td></tr><tr><td colspan="1" rowspan="1"><p>任务名称</p></td><td colspan="1" rowspan="1"><p>任务名称清晰地标识工程或对象。默认主机部署。</p></td></tr><tr><td colspan="1" rowspan="1"><p>主机地址</p></td><td colspan="1" rowspan="1"><p>部署主机远程SSH认证凭证。</p></td></tr><tr><td colspan="1" rowspan="1"><p>部署文件</p></td><td colspan="1" rowspan="1">需要部署的材料，许可写绝对路径，也可以写泛路径，泛路径需配合部署文件规则来匹配到部署档案。</td></tr><tr><td colspan="1">部署文件匹配规则</td><td colspan="1">资料匹配规则，协助正则表达式。</td></tr><tr><td colspan="1" rowspan="1"><p>部署位置</p></td><td colspan="1" rowspan="1">部署远程主机位置。</td></tr><tr><td colspan="1" rowspan="1"><p>部署命令</p></td><td colspan="1" rowspan="1"><p>材料部署命令。</p></td></tr></tbody></table><p>至此流水线设计完毕，下面介绍流水线运行以及查看代码扫描报告。</p><h2>4、运行流水线</h2><ul><li>运行流水线</li></ul><p>流水线设计完毕之后，Arbess支持自动触发、Webhook触发、手动触发三种运行模式。点击右上角“运行”按钮，手动触发流水线。</p><p style="text-align: center"><img alt="" height="1025" src="https://i-blog.csdnimg.cn/direct/59847b0cd9db423f9985847103d38eeb.png" width="1595">运行流水线</p><p>流水线运行同时，点击认为标签右下角“日志”，可查看运行实时日志。</p><p style="text-align: center"><img alt="" height="1024" src="https://i-blog.csdnimg.cn/direct/0f2348d94806416e83cfdb5e8e811735.png" width="1595">查看详细日志</p><ul><li>查看代码扫描日志</li></ul><p>全部任务显示为√则运行成功，运行完毕之后，可以在测试报告页面查看SonarQube代码扫描报告，点击测试报告→代码扫描→SonarQube，查看SonarQube代码扫描报告。</p><p style="text-align: center"><img alt="" height="992" src="https://i-blog.csdnimg.cn/direct/51c6212ce8a146869ed1a62b718e7af6.png" width="1735">查看SonarQube测试报告</p><p>点击SonarQube代码扫描报告名称，进入跳转到SonarQube查看详细报告。</p><p style="text-align: center"><img alt="" height="992" src="https://i-blog.csdnimg.cn/direct/dae58a19c532402da8707b6ce4ae91e4.png" width="1735">查看SonarQube详细报告</p><ul><li>查看运行历史</li></ul><p>能够在Arbess历史页面查看到流水线运行历史。点击运行历史序号，即可查看详细的运行日志。</p><p style="text-align: center"><img alt="" height="1025" src="https://i-blog.csdnimg.cn/direct/48cf8f9103c74f688f66bc0ee2e394a2.png" width="1595">运行历史</p><p>至此，使用Arbess成功搭建流水线，用来拉取GitHub源码、使用SonarQube代码扫描，构建安装包并进行主机部署。</p></div><br><br>
来源：https://www.cnblogs.com/jzssuanfa/p/19496949
頁:
[1]