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
2.創建工作目錄,為接下來的掛載自定義映射路徑做准備
mkdir -p /home/sonar/postgres/postgresql mkdir -p /home/sonar/postgres/data
3.創建網絡
docker network create sonarqube-tier
4.創建容器並運行
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:設置時區
- --restart always:容器退出時總是重啟
- --privileged=true:掛載主機目錄Docker訪問出現Permission denied的解決辦法
- --net sonarqube-tier:容器接入自定義網絡
- --network-alias mysql:給容器起個網絡別名
二、安裝 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。