sonarQube 是一款开源代码检测工具。本篇介绍通过 docker 来安装。大概的一个运作流程是这样的,先通过 sonar-scanner 插件扫描代码,把数据存储到数据库,sonarQube 读取数据库,将数据库展现在 web 平台。
一、docker 安装 mysql 或 postgresql
首先需要安装数据库,开源的可以用 mysql 或者 postgresql 。官网上已经声明 sonarQube 7.9 版本以上不再支持 mysql 了,我们为了以后升级新版本不做数据库迁移,尽量使用 postgresql 。下面介绍这两种数据库安装配置方法:
mysql
1.先拉取 mysql 镜像(sonarqube:7.4 不支持 mysql:5.7 以上):
docker pull mysql:5.7
2.创建工作目录,为接下来的挂载自定义映射路径做准备
mkdir -p /usr/mysql/conf
mkdir -p /usr/mysql/logs
mkdir -p /usr/mysql/data
3.创建网络
docker network create sonarqube-tier
4.创建容器并运行
docker run --name mysql -d -p 3306:3306--net sonarqube-tier -v /usr/mysql/conf:/etc/my.cnf.d -v /usr/mysql/logs:/logs -v /usr/mysql/data:/var/lib/mysql \
-e MYSQL_ROOT_PASSWORD=123456 \
--restart always \
--privileged=true \
--network-alias mysql \
mysql:5.7
- -p 3306:3306:将容器 3306 映射到宿主机端口 3306
- -v /usr/mysql/conf:/etc/my.cof.d:将容器下的 /etc/my.cof.d 挂载到宿主机 /usr/mysql/conf
- -e MYSQL_ROOT_PASSWORD=123456:设置 root 密码 123456
- --restart always:容器退出时总是重启
- --privileged=true:挂载主机目录Docker访问出现Permission denied的解决办法
- --net sonarqube-tier:容器接入自定义网络
- --network-alias mysql:给容器起个网络别名
查看容器是否运行正常
5.允许外网访问
先进入容器
docker exec -it mysql /bin/bash
操作mysql
mysql -uroot -p # 密码 123456
GRANT ALL ON *.* TO 'root'@'%'; #所有网络都可访问
create database sonar; #创建 sonarqube 数据库
# 添加远程登录用户:sonar ,并授予权限。
CREATE USER 'sonar'@'%' IDENTIFIED WITH mysql_native_password BY 'sonar';
GRANT ALL PRIVILEGES ON *.* TO 'sonar'@'%';
flush privileges; # 刷新权限
postgresql
1.拉取 postgresql 镜像
docker pull postgresql:latest
mkdir -p /home/sonar/postgres/postgresql
mkdir -p /home/sonar/postgres/data
docker network create sonarqube-tier
docker run --name postgres -d -p 5432:5432 --net sonarqube-tier \
-v /home/sonar/postgres/postgresql:/var/lib/postgresql \
-v /home/sonar/postgres/data:/var/lib/postgresql/data \
-v /etc/localtime:/etc/localtime:ro \
-e POSTGRES_USER=sonar \
-e POSTGRES_PASSWORD=sonar \
-e POSTGRES_DB=sonar \
-e TZ=Asia/Shanghai \
--restart always \
--privileged=true \
--network-alias postgres \
postgres:latest
- -p 5432:5432:将容器 5432 映射到宿主机端口 5432
- -v /home/sonar/postgres/postgresql:/var/lib/postgresql:将容器下的 /var/lib/postgresql 挂载到宿主机 /home/sonar/postgres/postgresql
- -v /etc/localtime:/etc/localtime:ro:设置容器与宿主机时间一致
- --e POSTGRES_USER=sonar:设置数据库用户名
- -e POSTGRES_PASSWORD=sonar:设置数据库密码
- -e POSTGRES_DB=sonar:新建db
- -e TZ=Asia/Shanghai:设置时区
二、安装 sonarQube
1.拉取镜像,我这里拉取的是 tag 是 7.4-community(7.6及以上的版本与 jenkins 的 sonar-scanner 插件暂时不兼容,以后官方会解决兼容问题)
docker pull sonarqube:7.4-community
2.创建工作目录
mkdir -p /data/sonarqube
3.修改系统参数
echo "vm.max_map_count=262144" > /etc/sysctl.conf
sysctl -p
4.运行一个test容器
docker run -d --name sonartest sonarqube:7.4-community
将容器内重要文件复制到宿主机
docker cp sonartest:/opt/sonarqube/conf /data/sonarqube
docker cp sonartest:/opt/sonarqube/data /data/sonarqube
docker cp sonartest:/opt/sonarqube/logs /data/sonarqube
docker cp sonartest:/opt/sonarqube/extensions /data/sonarqube
然后删除此容器
docker rm sonartest
修改文件夹权限
chmod -R 777 /data/sonarqube/
5.创建容器并运行
sonarQube + mysql
docker run -d --name sonar -p 9090:9000 \
-e ALLOW_EMPTY_PASSWORD=yes \
-e SONARQUBE_DATABASE_USER=sonar \
-e SONARQUBE_DATABASE_NAME=sonar \
-e SONARQUBE_DATABASE_PASSWORD=sonar \
-e SONARQUBE_JDBC_URL="jdbc:mysql://mysql:3306/sonar?useUnicode=true&characterEncoding=utf8&rewriteBatchedStatements=true&useConfigs=maxPerformance&useSSL=false" \
--net sonarqube-tier \
--privileged=true \
-v /data/sonarqube/logs:/opt/sonarqube/logs \
-v /data/sonarqube/conf:/opt/sonarqube/conf \
-v /data/sonarqube/data:/opt/sonarqube/data \
-v /data/sonarqube/extensions:/opt/sonarqube/extensions\
sonarqube:7.4-community
sonarQube + postgresql
方法一
docker run -d --name sonar -p 9090:9000 \
-e ALLOW_EMPTY_PASSWORD=yes \
-e SONARQUBE_DATABASE_USER=sonar \
-e SONARQUBE_DATABASE_NAME=sonar \
-e SONARQUBE_DATABASE_PASSWORD=sonar \
-e SONARQUBE_JDBC_URL="jdbc:postgresql://postgres:5432/sonar" \
--net sonarqube-tier \
--privileged=true \
--restart always \
-v /data/sonarqube/logs:/opt/sonarqube/logs \
-v /data/sonarqube/conf:/opt/sonarqube/conf \
-v /data/sonarqube/data:/opt/sonarqube/data \
-v /data/sonarqube/extensions:/opt/sonarqube/extensions\
sonarqube:7.4-community
若这种方式出现连不上数据库 postgres 的问题,可参照第二种方法
方法二
1)找到 /data/sonarqube/conf/ 路径下的文件 sonar.properties,修改如下并保存
# 找到如下配置去掉注释。并赋值 username,password
sonar.jdbc.username=sonar
sonar.jdbc.password=sonar
# 去掉 sonar.jdbc.url 注释,配置url
#----- PostgreSQL 9.3 or greater
# By default the schema named "public" is used. It can be overridden with the parameter "currentSchema".
sonar.jdbc.url=jdbc:postgresql://postgres:5432/sonar
2)使用docker命令创建容器
docker run -d --name sonar -p 9090:9000 \
--net sonarqube-tier \
--privileged=true \
--restart always \
-v /data/sonarqube/logs:/opt/sonarqube/logs \
-v /data/sonarqube/conf:/opt/sonarqube/conf \
-v /data/sonarqube/data:/opt/sonarqube/data \
-v /data/sonarqube/extensions:/opt/sonarqube/extensions\
sonarqube:7.4-community
6.浏览器输入http://ip:9090,开始初始化数据库,这个时间过程比较长,大概几分钟。初始化成功后进入登录界面,账号:admin 密码:admin
7.新版本sonaqube可以去市场搜索中文语言包如下。我这个为了兼容jenkins插件,用的是7.4版本,需要去官网下对应的中文包。
中文语言包下载地址:https://github.com/SonarQubeCommunity/sonar-l10n-zh/tags 。找到自己版本对应的中文包。
将 jar 包放入 /data/sonarqube/extensions/plugins ,重启 sonarqube。