使用Docker安裝SonarQube的詳細教學

2021-10-11 19:02:16

Docker安裝SonarQube的教學如下所示：

1.拉取映象

1.1拉取相關映象並執行

1.1.1拉取相關映象

# 拉取sonarqube映象
$ docker pull sonarqube:9.1.0-community (推薦使用) /  $ docker pull sonarqube:7.6-community
# 拉取postgres映象
$ docker pull postgres:9.6.23

1.1.2執行映象

# 執行postgres資料庫
$ docker run --name postgresqldb --restart=always -p 5432:5432 
-e POSTGRES_USER=root 
-e POSTGRES_PASSWORD=123456  
-d postgres:9.6.23

# 進入postgres容器，建立使用者名稱和密碼
$ docker exec -it postgresqldb bash

# 登入資料庫
psql -U root -W
# 建立使用者名稱和密碼
create user sonar with password 'sonar';
create database sonar owner sonar;
grant all privileges on database sonar to sonar;

# 不連線postgres資料庫執行命令(不推薦)
docker run --name sonarqube --restart=always -p 9000:9000 -d naumy/hitrend-sonarqube:v1.0

# 執行sonarqube容器
docker run -d --name sonarqube --restart=always 
-p 9000:9000  
-e sonar.jdbc.username=sonar 
-e sonar.jdbc.password=sonar 
-e sonar.jdbc.url=jdbc:postgresql://139.198.176.140:5432/sonar 
sonarqube:9.1.0-community

接著存取：http://localhost:9000/ 就可以了，預設管理員使用者和密碼為：admin/admin。

嵌入式資料庫應僅用於評估目的、嵌入式資料庫無法擴充套件，不支援升級到SonarQube的較新版本，也不支援將資料從中遷移到其他資料庫引擎。

1.2儲存並提交已修改的映象

# 儲存已經修的映象
docker commit -a "naumy"  -m "安裝中文外掛" 19f1cc24dc98 hitrend-sonarqube:v1.0
# 把舊映象的名字，改成倉庫要求的新版名字
docker tag hitrend-sonarqube:v1.0 naumy/hitrend-sonarqube:v1.0
# 登入到docker hub
docker login       
# 推播
docker push naumy/hitrend-sonarqube:v1.0

2.安裝成功

3.外掛安裝

3.1安裝Chinese外掛

SonarQube提供了強大的外掛管理功能，以中文語言套件為範例，講解如何安裝外掛：

登入成功後，選擇Administration-Marketplace-Plugins，在搜尋方塊輸入Chinese就可以選擇安裝了。

當狀態顯示為Install Pending時，說明外掛安裝完成，點選Restart Server即可生效。

之後，就顯示為中文了。

同時安裝findbug外掛

4.docker安裝gitlab

4.1.Gitlab映象拉取

# gitlab-ce為穩定版本，後面不填寫版本則預設pull最新latest版本
$ docker pull gitlab/gitlab-ce

4.2執行gitlab映象

$ docker run -d  -p 443:443 -p 80:80 -p 222:22 --name gitlab --restart always -v /home/gitlab/config:/etc/gitlab -v /home/gitlab/logs:/var/log/gitlab -v /home/gitlab/data:/var/opt/gitlab gitlab/gitlab-ce

# -d：後臺執行
# -p：將容器內部埠向外對映
# --name：命名容器名稱
# -v：將容器內資料資料夾或者紀錄檔、設定等資料夾掛載到宿主機指定目錄

按上面的方式，gitlab容器執行沒問題，但在gitlab上建立專案的時候，生成專案的URL存取地址是按容器的hostname來生成的，也就是容器的id。

作為gitlab伺服器，我們需要一個固定的URL存取地址，於是需要設定gitlab.rb（宿主機路徑：/home/gitlab/config/gitlab.rb）。

# gitlab.rb檔案內容預設全是註釋
$ vim /home/gitlab/config/gitlab.rb

# 設定http協定所使用的存取地址,不加埠號預設為80
external_url 'http://192.168.199.231'

# 設定ssh協定所使用的存取地址和埠
gitlab_rails['gitlab_ssh_host'] = '192.168.199.231'
gitlab_rails['gitlab_shell_ssh_port'] = 222 # 此埠是run時22埠對映的222埠
:wq #儲存組態檔並退出

# 重啟gitlab容器
$ docker restart gitlab

此時專案的倉庫地址就變了。如果ssh埠地址不是預設的22，就會加上ssh:// 協定頭
開啟瀏覽器輸入ip地址(因為我的gitlab埠為80，所以瀏覽器url不用輸入埠號，如果埠號不是80，則開啟為：ip:埠號)

4.3設定root使用者名稱和密碼

進入目錄 /home/gitlab/config/initial_root_password，檢視密碼

xwCsS7lMYx+8x3o6KIBw+Ia6Lg3VqvtHLzxzYfPNtxk=

或者進入gitlab容器後修改密碼。

root@ba96cb6a1f47:/# gitlab-rails console
--------------------------------------------------------------------------------
 Ruby:         ruby 2.7.4p191 (2021-07-07 revision a21a3b7d23) [x86_64-linux]
 GitLab:       14.3.2 (92acfb1b8a9) FOSS
 GitLab Shell: 13.21.1
 PostgreSQL:   12.7
--------------------------------------------------------------------------------

irb(main):005:0> user = User.where(id: 1).first
=> #<User id:1 @root>
irb(main):006:0> user.password=12345678
=> 12345678
irb(main):007:0> user.password_confirmation=12345678
=> 12345678
irb(main):008:0> user.save!
Enqueued ActionMailer::MailDeliveryJob (Job ID: 4fc2d685-2fd6-41d9-893e-2dabc7c3b366) to Sidekiq(mailers) with arguments: "DeviseMailer", "password_change", "deliver_now", {:args=>[#<GlobalID:0x00007fc6c59b5b48 @uri=#<URI::GID gid://gitlab/User/1>>]}
=> true
irb(main):009:0> quit

執行後的效果圖

4.4儲存映象並推播dockerhub

# 儲存已經修的映象
docker commit -a "naumy"  -m "初始化gitlab" ba96cb6a1f47 gitlab:v1.0
docker commit -a "naumy"  -m "sonarqube:7.6-community " e70c6cbe2e0b sonarqube-7.6-community:v1.0
docker tag sonarqube-7.6-community:v1.0 naumy/sonarqube-7.6-community:v1.0
docker push naumy/sonarqube-7.6-community:v1.0
# 把舊映象的名字，改成倉庫要求的新版名字
docker tag gitlab:v1.0 naumy/gitlab:v1.0
# 登入到docker hub
docker login       
# 推播
docker push naumy/gitlab:v1.0

5.碰到的問題

5.1虛擬記憶體不夠

啟動容器後過了十幾秒。容器自動退出。

Error: max virtual memory areas vm.max_map_count [65530] is too low, increase to at least [262144]

執行容器後，容器馬上退出。

# 使用命令檢視執行紀錄檔
docker logs 容器名稱/容器ID

在/etc/sysctl.conf檔案最後新增一行

vm.max_map_count=262144

執行/sbin/sysctl -p立即生效

6.整合Sonar和gitlab

6.1安裝Gitlab-runner

6.1.1獲取gitlab-Token

進入gitlab後，選擇runner，進行相應的Token獲取。

6.1.2安裝gitlab-runner

# 拉取映象
docker pull gitlab/gitlab-runner:v13.2.4

# 建立容器對映目錄
mkdir -p /dwz/docker-volume/gitlab-runner/config

# 建立容器並執行
docker run -d --name gitlab-runner 
--restart always 
-v /dwz/docker-volume/gitlab-runner/config:/etc/gitlab-runner 
-v /var/run/docker.sock:/var/run/docker.sock 
gitlab/gitlab-runner:v13.2.4

進入gitlab-runner容器後，設定相應的引數設定：

docker exec -it gitlab-runner gitlab-runner register -n 
--url http://139.198.166.208 
--registration-token 9zEbBYXSyqJqpNb9QSNh 
--executor docker 
--description "Docker Runner" 
--docker-image "sonarsource/sonar-scanner-cli:latest" 
--docker-volumes /var/run/docker.sock:/var/run/docker.sock

再次載入gitlab頁面，出現runner設定項。

6.2設定sonarqube的使用者名稱和密碼

設定當前的sonarqube的使用者面和密碼為admin和123456

6.3進行專案分析(手動新增專案)

是否需要整合自己喜歡的CI，使用gitlab進行持續整合和持續部署。

第一步選擇需要檢測專案程式碼型別：

新建組態檔sonar-project.properties：

sonar.projectKey=gitlab-sonorqube
sonar.qualitygate.wait=true
sonar.language=py

第二步：新增環境變數

令牌金鑰：b23fe46d142fcfb052b05d5b3fd6fc823df0b682

按照要求新增相應的環境變數：

6.4進行CI/CD（sonar與gitlab）

6.4.1版本為sonarqube-7.6-community

建立一個gitlab專案，實驗使用的專案為python專案。

.gitlab-ci.yml檔案內容為

# This file is a template, and might need editing before it works on your project.
# To contribute improvements to CI/CD templates, please follow the Development guide at:
# https://docs.gitlab.com/ee/development/cicd/templates.html
# This specific template is located at:
# https://gitlab.com/gitlab-org/gitlab/-/blob/master/lib/gitlab/ci/templates/Getting-Started.gitlab-ci.yml

# This is a sample GitLab CI/CD configuration file that should run without any modifications.
# It demonstrates a basic 3 stage CI/CD pipeline. Instead of real tests or scripts,
# it uses echo commands to simulate the pipeline execution.
#
# A pipeline is composed of independent jobs that run scripts, grouped into stages.
# Stages run in sequential order, but jobs within stages run in parallel.
#
# For more information, see: https://docs.gitlab.com/ee/ci/yaml/index.html#stages

stages:          # List of stages for jobs, and their order of execution
  - build
  - test
  - deploy

build-job:       # This job runs in the build stage, which runs first.
  stage: build
  script:
    - echo "Compiling the code..."
    - echo "Compile complete."

unit-test-job:   # This job runs in the test stage.
  stage: test    # It only starts when the job in the build stage completes successfully.
  script:
    - echo "Running unit tests... This will take about 60 seconds."
    - sleep 60
    - echo "Code coverage is 90%"

lint-test-job:   # This job also runs in the test stage.
  stage: test    # It can run at the same time as unit-test-job (in parallel).
  script:
    - echo "Linting code... This will take about 10 seconds."
    - sleep 10
    - echo "No lint issues found."

deploy-job:      # This job runs in the deploy stage.
  stage: deploy  # It only runs when *both* jobs in the test stage complete successfully.
  script:
    - echo "Deploying application..."
    - echo "Application successfully deployed."
    
image: 
  name: sonarsource/sonar-scanner-cli:latest
  entrypoint: [""]

sonarqube-check:
  script: 
    - sonar-scanner -X  -Dsonar.projectKey=gitlab-sonorqube -Dsonar.host.url=http://139.198.176.140:9000 -Dsonar.login=cbd26f998beeb61d7a991e0282efc430b020d9f1 -Dsonar.login=admin -Dsonar.password=admin -Dsonar.language=py  -Dsonar.java.binaries=build/  -Dsonar.projectVersion=1.0 -Dsonar.sources=. 
  allow_failure: true
  only:
    - main # or the name of your main branch

提交程式碼後，可以獲取到相應的測試資訊。

https://sm.ms/image/ykYPlDgZVvuhzsq

6.4.2版本為sonarqube-9.1-community

.gitlab-ci.yml檔案內容為

sonarqube-check:
  image: 
    name: sonarsource/sonar-scanner-cli:latest
    entrypoint: [""]
  variables:
    SONAR_USER_HOME: "${CI_PROJECT_DIR}/.sonar"  # Defines the location of the analysis task cache
    GIT_DEPTH: "0"  # Tells git to fetch all the branches of the project, required by the analysis task
  cache:
    key: "${CI_JOB_NAME}"
    paths:
      - .sonar/cache
  script: 
    - sonar-scanner -X  -Dsonar.projectKey=gitlab-sonorqube -Dsonar.host.url=http://139.198.176.140:9000 -Dsonar.login=7f9e3408ac11e0699e2f8afdb21a662cc8ab2698 -Dsonar.login=admin -Dsonar.password=123456 -Dsonar.language=py  -Dsonar.java.binaries=build/  -Dsonar.projectVersion=1.0 -Dsonar.sources=. 
  allow_failure: true
  only:
    - main # or the name of your main branch

提交程式碼後gitlab會自動進行CI/CD：