SonaQube：安装服务器

概览

本节介绍单节点 SonarQube 实例。 有关集群设置的详细信息，请参阅将服务器安装为集群。

实例组件

SonarQube 实例包含三个组件：

 

• 1.SonarQube 服务器运行以下进程：
  • 一个为SonarQube用户界面服务的网络服务器。
  • 一个基于Elasticsearch的搜索服务器。
  • 负责处理代码分析报告并将其保存在SonarQube数据库中的计算引擎。
• 存储以下内容的数据库：
  • 代码扫描期间产生的代码质量和安全的指标和问题。
  • SonarQube实例配置。
• 一个或多个扫描器在你的构建或持续集成服务器上运行，以分析项目。

主机和位置

为了获得最佳性能，SonarQube 服务器和数据库应该安装在不同的主机上，并且服务器主机应该是专用的。 服务器和数据库主机应位于同一网络中。

所有主机都必须是时间同步的。

安装数据库

支持多个数据库引擎。 请务必遵循为您的数据库列出的要求。 它们是真正的要求而不是建议。

创建一个空架构和一个 sonarqube 用户。 授予此 sonarqube 用户权限以创建、更新和删除此架构的对象。

Microsoft SQL Server

排序规则必须区分大小写 (CS) 和区分重音 (AS)。

READ_COMMITED_SNAPSHOT 必须在 SonarQube 数据库上设置。

MS SQL 数据库的共享锁策略可能会影响 SonarQube 运行时。 确保 is_read_committed_snapshot_on 设置为 true 以防止 SonarQube 在重负载下面临潜在的死锁。

检查 is_read_committed_snapshot_on 的查询示例：

SELECT is_read_committed_snapshot_on FROM sys.databases WHERE name='YourSonarQubeDatabase';

更新 is_read_committed_snapshot_on 的查询示例：

ALTER DATABASE YourSonarQubeDatabase SET READ_COMMITTED_SNAPSHOT ON WITH ROLLBACK IMMEDIATE;

综合安全

要使用集成安全性：

• 下载 Microsoft SQL JDBC Driver 9.2.0 包并将 mssql-jdbc_auth-9.2.0.x64.dll 复制到您路径中的任何文件夹。

 

• .如果您将 SonarQube 作为 Windows 服务运行，请确保运行该服务的 Windows 帐户有权连接您的 SQL 服务器。 该帐户应具有 db_owner 数据库角色成员资格。

如果您从命令提示符运行 SonarQube 服务器，则运行命令提示符的用户应具有 db_owner 数据库角色成员资格。

• 确保 sonar.jdbc.username 或 sonar.jdbc.password 属性被注释掉，否则 SonarQube 将使用 SQL 身份验证。

sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar;integratedSecurity=true

SQL验证

要使用 SQL 身份验证，请使用以下连接字符串。 还要确保 sonar.jdbc.username 和 sonar.jdbc.password 设置正确：

sonar.jdbc.url=jdbc:sqlserver://localhost;databaseName=sonar

sonar.jdbc.username=sonarqube

sonar.jdbc.password=mypassword

 

Oracle

如果在同一个 Oracle 实例上有两个 SonarQube 模式，特别是如果它们用于两个不同的版本，SonarQube 会感到困惑并选择它找到的第一个。 为了避免这个问题：

• 应减少与 SonarQube Oracle 用户相关联的权限
• 或者应在 Oracle 端定义触发器以在建立新连接时自动更改 SonarQube Oracle 用户会话：

Oracle JDBC 驱动程序版本 12.1.0.1 和 12.1.0.2 存在重大错误，不建议与 SonarQube 一起使用（查看更多详细信息）。

 

PostgreSQL

如果您想使用自定义架构而不是默认的“公共”架构，则必须设置 PostgreSQL search_path 属性：

ALTER USER mySonarUser SET search_path to mySonarQubeSchema

 

从 ZIP 文件安装 SonarQube

首先，检查要求。 然后下载并解压缩发行版（不要解压缩到以数字开头的目录）。

SonarQube 不能在基于 Unix 的系统上以 root 身份运行，因此如有必要，请为 SonarQube 创建一个专用用户帐户。

$SONARQUBE-HOME（如下）指的是 SonarQube 发行版解压后的目录路径。

设置对数据库的访问

编辑 $SONARQUBE-HOME/conf/sonar.properties 以配置数据库设置。 模板可用于每个受支持的数据库。 只需取消注释并配置您需要的模板并注释掉专用于 H2 的行：

Example for PostgreSQL

sonar.jdbc.username=sonarqube

sonar.jdbc.password=mypassword

sonar.jdbc.url=jdbc:postgresql://localhost/sonarqube

添加 JDBC 驱动程序

已提供支持的数据库（Oracle 除外）的驱动程序。 不要更换提供的驱动程序； 他们是唯一支持的。

对于 Oracle，将 JDBC 驱动程序复制到 $SONARQUBE-HOME/extensions/jdbc-driver/oracle。

配置 Elasticsearch 存储路径

默认情况下，Elasticsearch 数据存储在 $SONARQUBE-HOME/data 中，但不建议将其用于生产实例。 相反，您应该将此数据存储在其他地方，最好是在具有快速 I/O 的专用卷中。 除了保持可接受的性能外，这样做还可以简化 SonarQube 的升级。

编辑 $SONARQUBE-HOME/conf/sonar.properties 以配置以下设置：

sonar.path.data=/var/sonarqube/data

sonar.path.temp=/var/sonarqube/temp

用于启动 SonarQube 的用户必须对这些目录具有读写权限。

启动 Web 服务器

默认端口为“9000”，上下文路径为“/”。 这些值可以在 $SONARQUBE-HOME/conf/sonar.properties 中更改：

sonar.web.host=192.168.0.1

sonar.web.port=80

sonar.web.context=/sonarqube

执行以下脚本来启动服务器：

• 在Linux上：bin/linux-x86-64/sonar.sh start
• 在MacOS上： bin/macosx-universal-64/sonar.sh start
• 在Windows上： bin/windows-x86-64/StartSonar.bat

 

调整 Java 安装

如果您的服务器上安装了多个 Java 版本，您可能需要明确定义所使用的 Java 版本。

要更改 SonarQube 使用的 Java JVM，请编辑 $SONARQUBE-HOME/conf/wrapper.conf 并更新以下行：

wrapper.java.command=/path/to/my/jdk/bin/java

高级安装功能

• 在Windows或Linux上以服务形式运行SonarQube
• 在代理服务器后面运行SonarQube
• 监控和调整Java进程内存

从Docker镜像中安装SonarQube

请按照以下步骤进行首次安装：

• 创建以下卷有助于防止在更新到新版本或升级到更高版本时丢失信息：
  • osonarqube_data - 包含数据文件，如嵌入式H2数据库和Elasticsearch索引。
  • osonarqube_logs - 包含SonarQube关于访问、网络进程、CE进程和Elasticsearch的日志
  • sonarqube_extensions - 将包含你安装的任何插件和Oracle JDBC驱动程序（如果需要）。

使用以下命令创建卷：

$> docker volume create --name sonarqube_data

$> docker volume create --name sonarqube_logs

$> docker volume create --name sonarqube_extensions

确保您使用的是上述命令所示的卷，而不是绑定挂载。 使用绑定安装会阻止插件正确填充。

 

• 已提供支持的数据库（Oracle 除外）的驱动程序。 如果您使用的是 Oracle 数据库，则需要将 JDBC 驱动程序添加到 sonar_extensions 卷。 去做这个：

 

a. 使用嵌入式 H2 数据库启动 SonarQube 容器：

$ docker run --rm \

    -p 9000:9000 \

    -v sonarqube_extensions:/opt/sonarqube/extensions \

    

b. 一旦 SonarQube 正常启动就退出。

c. 将 Oracle JDBC 驱动程序复制到 sonarqube_extensions/jdbc-driver/oracle。

 

3. 使用 -e 环境变量标志定义的数据库属性运行映像：

$> docker run -d --name sonarqube \

    -p 9000:9000 \

    -e SONAR_JDBC_URL=... \

    -e SONAR_JDBC_USERNAME=... \

    -e SONAR_JDBC_PASSWORD=... \

    -v sonarqube_data:/opt/sonarqube/data \

    -v sonarqube_extensions:/opt/sonarqube/extensions \

    -v sonarqube_logs:/opt/sonarqube/logs \

    

 

有关更多配置环境变量，请参阅 Docker 环境变量。

环境变量 SONARQUBE_JDBC_USERNAME、SONARQUBE_JDBC_PASSWORD 和 SONARQUBE_JDBC_URL 的使用已被弃用，并将在未来版本中停止使用。

Docker Compose 配置示例

如果您使用 Docker Compose，请在配置 .yml 文件时使用以下示例作为参考。 单击下面的标题以展开 .yml 文件。

下面的示例将使用最新版本的 SonarQube Docker 映像。 如果要使用 SonarQube 的 LTS 版本，您需要使用 sonarqube:lts-community 图像标签更新示例。

下一步

安装并运行服务器后，您可能还需要安装插件。 然后您就可以开始分析源代码了。

故障排除/常见问题

无法通过代理连接到市场

仔细检查 $SONARQUBE_HOME/conf/sonar.properties 中的代理设置是否正确设置。 请注意，如果您的代理用户名包含反斜杠，则应将其转义 - 例如文件中的用户名“域\用户”应如下所示：

http.proxyUser=domain\\user

对于某些代理，异常“java.net.ProtocolException: Server redirected too many times”可能意味着配置了不正确的用户名或密码。

异常 java.lang.RuntimeException：无法以 root 身份运行 elasticsearch

SonarQube 启动一个 Elasticsearch 进程，并且运行 SonarQube 本身的帐户将用于 Elasticsearch 进程。 由于 Elasticsearch 不能以 root 身份运行，这意味着 SonarQube 也不能。 您必须选择其他非 root 帐户来运行 SonarQube，最好是专用于此目的的帐户。

Sonarqube DNS 缓存

在向 DevOps 平台报告 Quality Gate 状态时，SonarQube 使用 30 秒的 DNS 缓存生存时间策略。 如有必要，您可以在 JVM 中更改此设置：

echo "networkaddress.cache.ttl=5" >> "${JAVA_HOME}/conf/security/java.security"

请注意，低值会增加 DNS 欺骗攻击的风险。