1. SonarQube概述与环境规划
SonarQube是一个开源的代码质量检测工具，用于检测代码中的缺陷、漏洞和代码异味。SonarQube支持多种编程语言，是企业级开发中不可或缺的工具。更多学习教程www.fgedu.net.cn
1.1 SonarQube版本说明
SonarQube目前主要版本为9.x系列，本教程以SonarQube 9.9.0为例进行详细讲解。SonarQube 9.x版本相比之前版本在性能、稳定性和功能方面都有显著提升，支持更多的代码质量规则。
$ cat /opt/sonarqube/version.txt
# 查看系统版本
$ cat /etc/os-release
NAME=”Oracle Linux Server”
VERSION=”8.9″
ID=”ol”
PRETTY_NAME=”Oracle Linux Server 8.9″
# 查看内核版本
$ uname -r
5.4.17-2136.302.7.2.el8uek.x86_64
1.2 环境规划
本次安装环境规划如下：
sonarqube01.fgedu.net.cn (192.168.1.128) – SonarQube主服务器
sonarqube02.fgedu.net.cn (192.168.1.129) – SonarQube备用服务器
SonarQube版本：9.9.0
安装方式：二进制安装
数据库：PostgreSQL 14.0
2. 硬件环境要求
SonarQube作为代码质量检测工具，对硬件资源要求根据代码库大小和并发分析任务而定。学习交流加群风哥微信: itpux-com
2.1 物理主机环境要求
– CPU：至少4核
– 内存：至少8GB
– 磁盘：系统盘120GB SSD + 数据盘1TB SSD
# 检查SonarQube服务器资源
# free -h
total used free shared buff/cache available
Mem: 8G 2.4G 5.1G 128M 512M 5.4G
Swap: 4G 0B 4G
# 检查磁盘空间
# df -h
Filesystem Size Used Avail Use% Mounted on
/dev/sda1 120G 20G 100G 17% /
/dev/sdb1 1TB 100G 900G 10% /data
2.2 vSphere虚拟主机环境要求
– SonarQube服务器：
– vCPU：4核
– 内存：8GB
– 磁盘：系统盘120GB SSD + 数据盘1TB SSD
– 网络：VMXNET3网卡，1Gbps网络
资源池配置：
– CPU预留：2GHz
– 内存预留：4GB
– 内存限制：8GB
– CPU份额：正常
– 内存份额：正常
2.3 云平台主机环境要求
– SonarQube服务器：
– 实例规格：ecs.g6.2xlarge或同等规格
– vCPU：8核
– 内存：16GB
– 系统盘：SSD云盘 120GB
– 数据盘：SSD云盘 1TB
– 网络带宽：1Gbps以上
存储配置：
– OSS对象存储：用于存储备份数据
– NAS文件存储：用于共享配置文件
– 云盘快照：定期备份数据
3. 操作系统环境准备
在安装SonarQube之前，需要对操作系统进行必要的配置和优化。
3.1 操作系统版本检查
# cat /etc/os-release
NAME=”Oracle Linux Server”
VERSION=”8.9″
ID=”ol”
PRETTY_NAME=”Oracle Linux Server 8.9″
# 检查内核版本
# uname -r
5.4.17-2136.302.7.2.el8uek.x86_64
# 检查SELinux状态
# getenforce
Enforcing
# 检查防火墙状态
# systemctl status firewalld
● firewalld.service – firewalld – dynamic firewall daemon
Loaded: loaded (/usr/lib/systemd/system/firewalld.service; enabled; vendor preset: enabled)
Active: active (running)
3.2 依赖服务安装
# dnf install -y wget curl tar gzip java-11-openjdk-devel
# 关闭防火墙
# systemctl stop firewalld
# systemctl disable firewalld
# 关闭SELinux
# setenforce 0
# sed -i ‘s/SELINUX=enforcing/SELINUX=disabled/’ /etc/selinux/config
# 创建SonarQube用户
# useradd -r -s /bin/false sonarqube
# 创建目录结构
# mkdir -p /data/sonarqube/{config,bin,data}
# chown -R sonarqube:sonarqube /data/sonarqube
3.3 配置网络
# vi /etc/sysconfig/network-scripts/ifcfg-ens33
TYPE=Ethernet
BOOTPROTO=static
NAME=ens33
DEVICE=ens33
ONBOOT=yes
IPADDR=192.168.1.128
NETMASK=255.255.255.0
GATEWAY=192.168.1.1
DNS1=114.114.114.114
# 重启网络
# systemctl restart NetworkManager
# 验证网络
# ping -c 4 google.com
# 配置主机名
# hostnamectl set-hostname sonarqube01.fgedu.net.cn
# 配置hosts文件
# vi /etc/hosts
192.168.1.128 sonarqube01.fgedu.net.cn sonarqube01
192.168.1.129 sonarqube02.fgedu.net.cn sonarqube02
4. SonarQube安装配置
完成环境准备后，开始安装SonarQube。
4.1 安装PostgreSQL
# dnf install -y https://download.postgresql.org/pub/repos/yum/reporpms/EL-8-x86_64/pgdg-redhat-repo-latest.noarch.rpm
# 安装PostgreSQL
# dnf install -y postgresql14 postgresql14-server
# 初始化PostgreSQL
# /usr/pgsql-14/bin/postgresql-14-setup –initdb
# 启动PostgreSQL服务
# systemctl start postgresql-14
# systemctl enable postgresql-14
# 验证PostgreSQL状态
# systemctl status postgresql-14
# 创建SonarQube数据库和用户
# su – postgres
$ psql
postgres=# CREATE USER sonarqube WITH PASSWORD ‘password’;
postgres=# CREATE DATABASE sonarqube OWNER sonarqube;
postgres=# GRANT ALL PRIVILEGES ON DATABASE sonarqube TO sonarqube;
postgres=# \q
$ exit
4.2 安装SonarQube
# wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-9.9.0.65466.zip
# 解压SonarQube
# unzip sonarqube-9.9.0.65466.zip -d /opt/
# 创建软链接
# ln -s /opt/sonarqube-9.9.0.65466 /opt/sonarqube
# 修改权限
# chown -R sonarqube:sonarqube /opt/sonarqube
# 配置SonarQube服务
# vi /etc/systemd/system/sonarqube.service
[Unit]
Description=SonarQube
After=network.target postgresql-14.service
[Service]
Type=simple
LimitNOFILE=65536
ExecStart=/opt/sonarqube/bin/linux-x86-64/sonar.sh start
ExecStop=/opt/sonarqube/bin/linux-x86-64/sonar.sh stop
User=sonarqube
Restart=on-abort
[Install]
WantedBy=multi-user.target
# 启动SonarQube服务
# systemctl start sonarqube
# systemctl enable sonarqube
# 验证服务状态
# systemctl status sonarqube
4.3 初始化SonarQube
# 打开浏览器访问 http://sonarqube01:9000
# 登录SonarQube
# 用户名：admin
# 密码：admin
# 完成初始化向导
# 1. 更改默认密码
# 2. 配置数据库连接
# 3. 配置邮件通知
# 4. 完成初始化
5. SonarQube配置优化
为了提高SonarQube的性能和稳定性，需要进行一些配置优化。
5.1 基本配置优化
# vi /opt/sonarqube/conf/sonar.properties
sonar.jdbc.username=sonarqube
sonar.jdbc.password=password
sonar.jdbc.url=jdbc:postgresql://localhost:5432/sonarqube
sonar.web.host=0.0.0.0
sonar.web.port=9000
# 编辑JVM配置
# vi /opt/sonarqube/conf/wrapper.conf
wrapper.java.initmemory=4
wrapper.java.maxmemory=8
# 重启SonarQube服务
# systemctl restart sonarqube
5.2 高可用配置
# 1. 安装SonarQube到所有节点
# 2. 配置共享数据库
# 3. 配置负载均衡
# 配置负载均衡
# 编辑Nginx配置
# vi /etc/nginx/nginx.conf
upstream sonarqube {
server 192.168.1.128:9000;
server 192.168.1.129:9000;
}
server {
listen 80;
server_name sonarqube.fgedu.net.cn;
location / {
proxy_pass http://sonarqube;
proxy_set_header Host $host;
proxy_set_header X-Real-IP $remote_addr;
proxy_set_header X-Forwarded-For $proxy_add_x_forwarded_for;
}
}
6. SonarQube数据库配置
SonarQube需要使用PostgreSQL数据库存储配置和分析结果。
6.1 配置PostgreSQL
# vi /var/lib/pgsql/14/data/postgresql.conf
max_connections = 100
shared_buffers = 2GB
work_mem = 32MB
maintenance_work_mem = 1GB
effective_cache_size = 6GB
# 重启PostgreSQL服务
# systemctl restart postgresql-14
# 验证PostgreSQL配置
# su – postgres
$ psql
postgres=# SHOW max_connections;
postgres=# SHOW shared_buffers;
postgres=# \q
$ exit
6.2 优化PostgreSQL
# vi /var/lib/pgsql/14/data/postgresql.conf
autovacuum = on
autovacuum_max_workers = 4
autovacuum_naptime = 10min
autovacuum_vacuum_scale_factor = 0.1
autovacuum_analyze_scale_factor = 0.05
# 重启PostgreSQL服务
# systemctl restart postgresql-14
7. SonarQube安全配置
SonarQube提供了多种安全功能，包括用户认证、授权、TLS加密等。
7.1 认证配置
# 打开浏览器访问 http://sonarqube01:9000
# 创建用户
# 1. 点击左侧菜单 “Administration” -> “Security” -> “Users”
# 2. 点击 “Create user”
# 3. 填写用户信息
# – Login: developer
# – Name: Developer
# – Email: developer@fgedu.net.cn
# – Password: 设置密码
# – Local: Yes
# 4. 点击 “Create”
# 创建组
# 1. 点击左侧菜单 “Administration” -> “Security” -> “Groups”
# 2. 点击 “Create group”
# 3. 填写组信息
# – Name: developers
# 4. 点击 “Create”
# 分配用户到组
# 1. 点击左侧菜单 “Administration” -> “Security” -> “Users”
# 2. 选择刚才创建的用户
# 3. 点击 “Groups”
# 4. 选择刚才创建的组
# 5. 点击 “Add”
7.2 TLS加密配置
# mkdir -p /opt/sonarqube/conf/ssl
# openssl req -newkey rsa:2048 -nodes -keyout /opt/sonarqube/conf/ssl/sonarqube.key -x509 -days 365 -out /opt/sonarqube/conf/ssl/sonarqube.crt
# 配置SonarQube使用HTTPS
# vi /opt/sonarqube/conf/sonar.properties
sonar.web.https.port=9000
sonar.web.https.key=/opt/sonarqube/conf/ssl/sonarqube.key
sonar.web.https.cert=/opt/sonarqube/conf/ssl/sonarqube.crt
# 重启SonarQube服务
# systemctl restart sonarqube
8. SonarQube性能优化
在生产环境中，需要对SonarQube进行性能优化以提高代码分析效率。from:www.itpux.com
8.1 内存优化
# vi /opt/sonarqube/conf/wrapper.conf
wrapper.java.initmemory=4
wrapper.java.maxmemory=8
# 编辑SonarQube配置文件
# vi /opt/sonarqube/conf/sonar.properties
sonar.search.javaOpts=-Xmx4G -Xms2G -XX:MaxMetaspaceSize=512m
# 重启SonarQube服务
# systemctl restart sonarqube
8.2 数据库优化
# vi /var/lib/pgsql/14/data/postgresql.conf
max_connections = 200
shared_buffers = 4GB
work_mem = 64MB
maintenance_work_mem = 2GB
effective_cache_size = 12GB
# 重启PostgreSQL服务
# systemctl restart postgresql-14
8.3 网络优化
# vi /etc/sysctl.conf
net.core.somaxconn = 65535
net.ipv4.tcp_max_syn_backlog = 65535
net.ipv4.tcp_fin_timeout = 30
net.ipv4.tcp_keepalive_time = 300
net.ipv4.tcp_keepalive_probes = 5
net.ipv4.tcp_keepalive_intvl = 15
# 应用配置
# sysctl -p
9. SonarQube升级迁移
本节介绍SonarQube的版本升级和数据迁移方法。
9.1 SonarQube版本升级
# tar -czf /backup/sonarqube-$(date +%Y%m%d).tar.gz /opt/sonarqube /var/lib/pgsql/14/data
# 停止SonarQube服务
# systemctl stop sonarqube
# 下载新版本SonarQube
# wget https://binaries.sonarsource.com/Distribution/sonarqube/sonarqube-10.0.0.68432.zip
# 解压SonarQube
# unzip sonarqube-10.0.0.68432.zip -d /opt/
# 更新软链接
# rm /opt/sonarqube
# ln -s /opt/sonarqube-10.0.0.68432 /opt/sonarqube
# 修改权限
# chown -R sonarqube:sonarqube /opt/sonarqube
# 启动SonarQube服务
# systemctl start sonarqube
# 验证升级
# 打开浏览器访问 http://sonarqube01:9000
9.2 SonarQube数据迁移
# pg_dump -U sonarqube -d sonarqube > /backup/sonarqube-$(date +%Y%m%d).sql
# 在新服务器上恢复数据
# psql -U sonarqube -d sonarqube < /backup/sonarqube-20230405.sql
# 安装SonarQube
# 重复安装步骤
# 启动SonarQube服务
# systemctl start sonarqube
# 验证迁移
# 打开浏览器访问 http://sonarqube01:9000
10. SonarQube备份恢复
本节介绍SonarQube的备份和恢复方法。
10.1 SonarQube备份
# vi /data/sonarqube/scripts/backup.sh
#!/bin/bash
BACKUP_DIR=”/backup/sonarqube”
DATE=$(date +%Y%m%d)
# 创建备份目录
mkdir -p $BACKUP_DIR
# 停止SonarQube服务
systemctl stop sonarqube
# 备份配置文件
cp -r /opt/sonarqube/conf $BACKUP_DIR/config-$DATE
# 备份数据
pg_dump -U sonarqube -d sonarqube > $BACKUP_DIR/data-$DATE.sql
# 启动SonarQube服务
systemctl start sonarqube
# 清理旧备份（保留7天）
find $BACKUP_DIR -type f -mtime +7 -exec rm -f {} \;
# 添加执行权限
# chmod +x /data/sonarqube/scripts/backup.sh
# 添加定时任务
# crontab -e
0 0 * * * /data/sonarqube/scripts/backup.sh
10.2 SonarQube恢复
# systemctl stop sonarqube
# 清理现有数据
# psql -U postgres -c “DROP DATABASE sonarqube;”
# psql -U postgres -c “CREATE DATABASE sonarqube OWNER sonarqube;”
# 恢复数据
# psql -U sonarqube -d sonarqube < /backup/sonarqube/data-20230405.sql
# 恢复配置文件
# cp -r /backup/sonarqube/config-20230405/* /opt/sonarqube/conf/
# 启动SonarQube服务
# systemctl start sonarqube
# 验证恢复
# 打开浏览器访问 http://sonarqube01:9000
10.3 SonarQube监控脚本
# vi /data/sonarqube/scripts/monitor.sh
#!/bin/bash
LOG_FILE=”/var/log/sonarqube_monitor.log”
ALERT_EMAIL=”admin@fgedu.net.cn”
check_sonarqube_status() {
echo “$(date): Checking sonarqube status…” >> $LOG_FILE
status=$(systemctl status sonarqube | grep Active | awk ‘{print $2}’)
if [ “$status” != “active” ]; then
echo “$(date): SonarQube is not running” >> $LOG_FILE
echo “SonarQube is not running” | mail -s “SonarQube Alert” $ALERT_EMAIL
systemctl start sonarqube
else
echo “$(date): SonarQube is running” >> $LOG_FILE
fi
}
check_sonarqube_web() {
echo “$(date): Checking sonarqube web…” >> $LOG_FILE
response=$(curl -s -o /dev/null -w “%{http_code}” http://sonarqube01:9000)
if [ “$response” != “200” ]; then
echo “$(date): SonarQube web is not accessible, response code: $response” >> $LOG_FILE
echo “SonarQube web is not accessible, response code: $response” | mail -s “SonarQube Alert” $ALERT_EMAIL
else
echo “$(date): SonarQube web is accessible” >> $LOG_FILE
fi
}
check_postgresql_status() {
echo “$(date): Checking postgresql status…” >> $LOG_FILE
status=$(systemctl status postgresql-14 | grep Active | awk ‘{print $2}’)
if [ “$status” != “active” ]; then
echo “$(date): PostgreSQL is not running” >> $LOG_FILE
echo “PostgreSQL is not running” | mail -s “SonarQube Alert” $ALERT_EMAIL
systemctl start postgresql-14
else
echo “$(date): PostgreSQL is running” >> $LOG_FILE
fi
}
main() {
check_sonarqube_status
check_sonarqube_web
check_postgresql_status
}
main
# 添加执行权限
# chmod +x /data/sonarqube/scripts/monitor.sh
# 添加定时任务
# crontab -e
*/15 * * * * /data/sonarqube/scripts/monitor.sh
通过以上步骤，SonarQube安装配置、性能优化、升级迁移、备份恢复等内容已全部完成。SonarQube作为开源代码质量检测工具，能够高效地检测代码中的缺陷、漏洞和代码异味，是企业级开发的重要工具。
本文由风哥教程整理发布,仅用于学习测试使用,转载注明出处:http://www.fgedu.net.cn/10327.html
