从零开始针对 .NET 应用的 DevOps 运营实践 - Jenkins & SonarQube 安装配置

2024-01-09 13:01:04

一、Overview

继续 DevOps 实施的相关内容，在上一篇的博客中，完成了对于工具链中使用到的软件所需的运行环境的配置，在这一篇的博客中，将聚焦于我们使用到的两个主要的软件：Jenkins 与 SonarQube 在 Windows 服务器上的部署安装，为后续 DevOps 的实施，构建软件基础

二、Contents

三、Step by Step

3.1、前言

在 Jenkins 与 SonarQube 的版本选择上，这里我选择的都是最新的 LTS 版本，也就是长期支持版本，如果你没有什么特定的需求的话，建议不要选择过于古老的软件版本

这里请重点关注 SonarQube 的版本问题，对于自动化代码检查的数据，SonarQube 支持持久化到常见的数据库中（默认使用的是 H2 数据库），然而 8.x 之后的版本只支持持久化到 Oracle、SQL Server 以及 PostgreSQL，嗯，同 Gitlab 一样，没有 MySQL

因此，如果你需要持久化数据到 MySQL 数据库，最后一个能选择的版本则是 7.7 版本（电梯直达），并且这个版本只支持 MySQL 5.6、5.7，考虑到后续已经不再支持 MySQL 数据库的缘故，请谨慎考虑是否一定要采用该版本

3.2、Jenkins

3.2.1、程序安装

打开 Jenkins 官网，找到下载页面（https://www.jenkins.io/download/），选择最新的 LTS 版本下载，针对 Windows 平台，可以通过 war 包运行，在 docker 中运行，以及通过 msi 安装包安装之后，作为一个 Windows 服务运行

作为一个需要持续运行的服务，这里我选择通过 msi 方式的来完成程序的部署

双击 msi 安装文件，配置软件的安装路径，对于这种基础的软件服务，建议还是放在默认的位置

因为 Jenkins 在安装之后，是会作为一个独立的 Windows 服务的，如果你需要使用域账户或本地账户作为服务的运行方来运行该服务的话，这里需要进行配置账户、密码

Jenkins 默认使用 8080 端口，可以点击下方的 Test Port 按钮来测试当前设定的端口是否已经被占用

在上一篇中有提到 Jenkins 是基于 Java 进行开发的，在软件的安装过程中，安装程序默认会带出来我们配置的 Java SDK 信息，当然，你也可以在这里针对 Jenkins 设置不同的 Java SDK

完成所需运行环境的配置之后，将 Jenkins 服务所使用的 8080 端口添加到防火墙的白名单中，从而允许别的机器可以访问到该服务

当配置完成之后，点击 Install 等待安装完成即可，当安装向导提示安装完成时就可以通过浏览器访问 Jenkins

3.2.2、基础配置

打开浏览器，按照页面上的提示，我们需要找到位于指定路径上的密码，复制到页面上的输入框，来完成 Jenkins 的解锁，从而继续后续的操作

解锁之后，Jenkins 会提示你安装一些必要的插件，这里如果你因为网络问题没有安装成功或者压根没有弹出这个页面，也没有关系，后续可以在程序中手动的选择需要安装的插件

等待插件的安装完成 or 直接跳过插件的安装，创建一个管理员账户，用来管理我们的 Jenkins 系统，点击下一步，会需要我们配置一个 Jenkins URL，这个地址采用默认的地址即可，这里一定要注意，如果你调整了该 URL 的配置，后续一定要通过 Web 服务器进行反向代理，否则后续会出现各种问题

点击保存并完成之后，基本的 Jenkins 运行环境就安装配置完成了，当然，为了实现我们的需求，还需要后续在此基础上，安装各种所需的插件，从而实现构建流水线来完成持续集成的功能

3.3、SonarQube

3.3.1、程序安装

同 Jenkins 一样，SonarQube 同样选择最新的 LTS 版本进行下载了（电梯直达）

SonarQube 下载完成的是一个压缩包，解压压缩包，找到 bin 目录，里面列出了在不同操作系统运行程序的方式，因为我们是在 Windows 平台，所以这里选择 windows-x86-64 文件夹。同样的，作为一个需要常驻的服务，这里最好也将应用作为 Windows 服务进行运行

右击 InstallNTService.bat 选择以管理员身份运行，再使用管理员身份运行 StartNTService.bat 即可

打开浏览器，SonarQube 默认使用 9000 端口，等待一段时间，如果可以看到如下的页面，则代表应用已经安装成功，点击右上角的 Log in，输入默认的账户、密码即可登录到系统中（默认的账户、密码都是 admin）

PS：如果 9000 端口已经被占用了，可以找到 conf 文件下的 sonar.properties 文件修改 sonar.web.port 配置然后重启服务即可

3.3.2、数据持久化

对于自动化的代码检查数据，是具有一定的价值的，因为目前数据还是存储在 SonarQube 内置的 H2 数据库中，为了便于后续的使用，这里选择持久化到 SQL Server 数据库中

PS：请关注你使用的 SonarQube 所支持的数据库版本信息

新建一个数据库，这里必须调整数据库的排序规则为 CS（case-sensitive，区分大小写）、AS（accent-sensitive，区分重低音），例如这里我选择的排序规则为 Chinese_PRC_CS_AS

数据库创建之后，需要执行如下的 SQL 语句，确保当前库的 is_read_committed_snapshot_on 属性设置为 true，这里的 sonar 就是我新建的数据库名称

-- 查看 is_read_committed_snapshot_on 是否启用
SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name='sonar';

-- 打开 is_read_committed_snapshot_on
ALTER DATABASE sonar SET READ_COMMITTED_SNAPSHOT ON WITH ROLLBACK IMMEDIATE;

数据库设置完成之后，我们需要下载 Microsoft SQL JDBC Driver 7.2.2 package 这个 SQL Server 的 JDBC 驱动到本地，这里选择下载压缩包

找到下载之后的压缩包解压，选择 auth 路径下的 x64 文件夹，获取到这个 64 位的 sqljdbc_auth.dll 文件，拷贝到 SonarQube 的路径下，这里我在 \extensions\jdbc-driver 路径下新建了一个 mssql 文件夹用来存放这个 dll 文件

驱动下载完成后，找到 conf 文件下的 sonar.properties 文件，修改数据库连接信息，重新启动 SonarQube 服务，等待数据库表的创建完成，嗯，这个过程比较慢，耐心等待

等待应用的重新启动完成，与 Jenkins 相同，我们可以安装各种插件来丰富 SonarQube，这里我们可以在登录系统后，点击 Administration 菜单，在 Marketplace 中，下载所需的插件，例如这里可以下载中文的语言包，重启之后，系统就变成了中文

同样的，针对服务器无法连接外网的同学，我们可以从网络上找到需要的插件进行下载，然后放到程序运行路径下的 \extensions\plugins 文件夹中，重启服务即可

3.4、总结

自此，Jenkins 和 SonarQube 就已经安装配置完成了，当然，为了实现我们的需求，在实际使用时 Jenkins 还需要安装一些必须的插件，在下一章中，就可以通过与 Gitlab 进行串接，完成 .NET 应用的持续集成工作

码农公寓