CI持續整合系統環境--Gitlab+Gerrit+Jenkins完整對接
近年來,由於開源專案、社群的活躍熱度大增,進而引來持續整合(CI)系統的誕生,也越發的聽到更多的人在說協同開發、敏捷開發、迭代開發、持續整合和單元測試這些拉風的術語。然而,大都是僅僅聽到在說而已,國內也很少有公司能有完整的 CI 體系流程。反之一些開源專案都有完整的 CI體系,比如openstack。
為了實現程式碼託管->程式碼稽核->程式碼釋出的一套自動化流程,我特意在IDC伺服器上部署了Gitlab+Gerrit+Jenkins對接環境,以下記錄了操作過程:
----------------------------------------------------------------------------------------------------------------------------------------
1)Gitlab上進行程式碼託管
在gitlab上建立的專案設定成Private,普通使用者對這個專案就只有pull許可權,不能直接進行push
Git自帶code review功能
強制Review :在 Gitlab 上建立的專案,指定相關使用者只有Reporter許可權,這樣使用者沒有許可權使用git push功能,只能git review到Gerrit 系統上,Jenkins在監聽Gerrit上的專案事件會觸發構建任務來測試程式碼, Jenkins 把測試結果通過 ssh gerrit 給這個專案打上 Verified (資訊校驗)成功或失敗標記,成功通知其它人員
Review(程式碼稽核) 。
Gitlab保護Master 分支:在 Gitlab 上建立的專案可以把 Master 分支保護起來,普通使用者可以自己建立分支並提交程式碼到自己的分支上,沒有許可權直接提交到Master分支,使用者最後提交申請把自己的分支 Merge 到 Master ,管理員收到 Merge 請求後, Review 後選擇是否合併。
可以將gitlab和gerrit部署在兩臺機器上,這樣gitlab既可以託管gerrit程式碼,也可以作為gerrit的備份。
因為gitlab和gerrit做了同步,gerrit上的程式碼會同步到gitlab上。
這樣即使gerrit部署機出現故障,它裡面的程式碼也不會丟失,可以去gitlab上拿。
2)Gerrit稽核程式碼
Gerrit是一款被Android開源專案廣泛採用的code review(程式碼稽核)系統。普通使用者將gitlab裡的專案clone到本地,修改程式碼後,雖不能直接push到程式碼中心 ,但是可以通過git review提交到gerrit上進行稽核。gerrit相關稽核員看到review資訊後,判斷是否通過,通過即commit提交。然後,gerrit程式碼會和gitlab完成同步。
grrit的精髓在於不允許直接將本地修改同步到遠端倉庫。客戶機必須先push到遠端倉庫的refs/for/*分支上,等待稽核。
gerrit上也可以對比程式碼稽核提交前後的內容狀態。
3)jenkins程式碼釋出
當使用者git review後,程式碼通過jenkins自動測試(verified)、人工review 後,程式碼只是merge到了Gerrit的專案中,並沒有merge到 Gitlab的專案中,所以需要當 Gerrit 專案倉庫有變化時自動同步到Gitlab的專案倉庫中。Gerrit 自帶一個 Replication 功能,同時我們在安裝 Gerrit 時候預設安裝了這個 Plugin,通過新增replication.config 給 Gerrit即可(下文有介紹)
----------------------------------------------------------------------------------------------------------------------------------------
一、基礎環境搭建(參開下面三篇文件)
CI持續整合系統環境---部署gerrit環境完整記錄
CI持續整合系統環境---部署Gitlab環境完整記錄
CI持續整合系統環境---部署Jenkins完整記錄
二、Gitlab+Gerrit+Jenkins的對接
1)Gitlab配置
gitlab上的管理員賬號是gerrit,郵箱是gerrit@xqshijie.cn
建立了一個普通賬號wangshibo,郵箱是wangshibo@xqshijie.cn
[root@115]# su - gerrit
[gerrit@115 ~]$ ssh-keygen -t rsa -C gerrit@xqshijie.cn //產生公私鑰
[gerrit@115 ~]$ cat ~/.ssh/id_rsa.pub
將上面gerrit賬號的公鑰內容更新到Gitlab上。
使用gerrit賬號登陸Gitlab,點選頁面右上角的Profile Settings - 點選左側的SSH Keys小鑰匙圖示 - 點選Add SSH Key。
在Key對應的輸入框中輸入上段落$cat .ssh/id_rsa.pub顯示的公鑰全文,點選Title,應該會自動填充為gerrit@xqshijie.cn。如下:
在Gitlab上建立wangshibo使用者
然後在機器上生成wangshibo公鑰(先提前在機器上建立wangshibo使用者,跟上面一樣操作),然後將公鑰內容更新到Gitlab上(用wangshibo賬號登陸Gitlab)
用gerrit登陸Gitlab,新建group組為dev-group,然後建立新專案test-project1(在dev-group組下,即專案的Namespace為dev-group,將wangshibo使用者新增到dev-group組內,許可權為Reporter),具體如下截圖:
建立的專案設定成Private即私有的,這樣普通使用者這它就只有pull許可權,沒有push許可權。
在test-project1工程裡建立檔案,建立過程此處省略......
檔案建立後,如下:
在linux系統上登入wangshibo賬號下,克隆工程test-project1.git,測試許可權
[root@115]# su - wangshibo
[wangshibo@115 ~]$ git clone git@103.10.86.30:dev-group/test-project1.git
Initialized empty Git repository in /home/wangshibo/test-project1/.git/
remote: Counting objects: 15, done.
remote: Compressing objects: 100% (9/9), done.
remote: Total 15 (delta 0), reused 0 (delta 0)
Receiving objects: 100% (15/15), done.
[wangshibo@115 ~]$ cd ~/test-project1/
[wangshibo@115 ~]$ git config --global user.name 'wangshibo'
[wangshibo@115 ~]$ git config --global user.email 'wangshibo@xqshijie.cn'
[wangshibo@115 ~]$ touch testfile
[wangshibo@115 ~]$ git add testfile
[wangshibo@115 ~]$ git commit -m 'wangshibo add testfile'
[wangshibo@115 ~]$git push
GitLab: You are not allowed to push code to this project.
fatal: The remote end hung up unexpectedly
上面有報錯,因為普通使用者沒有直接push的許可權。需要先review到gerrit上進行稽核並commit後,才能更新到程式碼中心倉庫裡。
2)Gerrit配置
在linux伺服器上切換到gerrit賬號下生成公私鑰
[gerrit@115]$ ssh-keygen -t rsa -C gerrit@xqshijie.cn
將id_rsa.pub公鑰內容更新到gerrit上(管理員gerrit賬號登陸)的SSH Public Keys裡
同樣的,將gerrit的其他兩個普通賬號wangshibo和jenkins也在linux伺服器上生產公私鑰,郵箱分別是wangshibo@xqshijie.cn和jenkins@xqshijie.cn
並將兩者的公鑰id_rsa.pub內容分別更新到各自登陸的gerrit的SSH Public Keys裡
3)Jenkins配置
Jenkins系統已經建立了管理員賬戶jenkins並安裝了Gerrit Trigger外掛和Git plugin外掛
在“系統管理”->“外掛管理"->”可選外掛"->搜尋上面兩個外掛進行安裝
使用jenkins賬號登陸jenkins,進行Jenkins系統的SMTP設定 (根據具體情況配置)
“主頁面->系統管理->系統設定”,具體設定如下:
首先管理員郵件地址設定成jenkins@xqshijie.cn
設定SMTP的伺服器地址,點選“高階”
jenkins@xqshijie.cn的密碼要確認填對,然後測試郵件傳送功能,如果如下出現successfully,就成功了! 點選“儲存”
接下來設定Gerrit Trigger
Add New Server : Check4Gerrit
勾選 Gerrit Server With Default Configurations
具體設定如下:
設定好之後,點選“Test Connection”,如果測試連線出現如下的Success,即表示連線成功!
點選左下方的Save儲存。
-----------------------------------------------------------------------------------------
如果上一步在點選“Test Connection”測試的時候,出現下面報錯:
解決辦法:
管理員登入gerrit
Projects->List->All-Projects
Projects->Access
Global Capabilities->Stream Events 點選 Non-Interactive Users
新增 Jenkins@zjc.com 使用者到 ‘Non-Interactive Users’ 組
-----------------------------------------------------------------------------------------
4)Gerrit 和 Jenkins 整合
讓Gerrit支援Jenkins
如果安裝Gerrit時沒有或者沒有選擇新增Verified標籤功能[‘lable Verified’],需要自己新增。
如下是手動新增Verified標籤功能的設定(由於我在安裝Gerrit的時候已經選擇安裝Verified標籤功能了,所以下面橙色字型安裝操作可省略)
[如果在安裝gerrit的時候沒有選擇安裝這個標籤功能,就需要在此處手動安裝下。具體可以登陸gerrit,ProjectS->list->All-Projects->Access->Edit->Add Permission 看裡面是否有Verfied的選項]
# su - gerrit
$ git init cfg; cd cfg
$ git config --global user.name 'gerrit'
$ git config --global user.email 'gerrit@xqshijie.cn'
$ git remote add origin ssh://gerrit@103.10.86.30:29418/All-Projects
$ git pull origin refs/meta/config
$ vim project.config
[label "Verified"]
function = MaxWithBlock
value = -1 Fails
value = 0 No score
value = +1 Verified
$ git commit -a -m 'Updated permissions'
$ git push origin HEAD:refs/meta/config
$ rm -rf cfg
用gerrit管理員賬號登入Gerrit
現在提交的Review請求只有Code Rivew稽核,我們要求的是需要Jenkins的Verified和Code Review雙重保障,在 Projects 的 Access 欄裡,針對 Reference: refs/heads/ 項新增 Verified 功能,如下如下:
Projects -> List -> All-Projects
Projects -> Access -> Edit -> 找到 Reference: refs/heads/* 項 -> Add Permission -> Label Verified -> Group Name 裡輸入 Non-Interactive Users -> 回車 或者 點選Add 按鈕 -> 在最下面點選 Save Changes 儲存更改。
(注意:提前把jenkins使用者新增到Non-Interactive Users組內)
許可權修改結果如下:
截圖如下:
新增Verified後的許可權如下
Gitlab上設定test-project1工程
前面我們在Gitlab上搭建了一個 test-project1 的工程,普通使用者是沒有辦法去 push 的,只能使用 git review 命令提交. 而 git review 命令需要 .gitreview 檔案存在於專案目錄裡。
用 gerrit使用者新增.gitreview 檔案
[root@115]# su - gerrit
[gerrit@115]$ git clone git@103.10.86.30:dev-group/test-project1.git
[gerrit@115]$ cd test-project1
[gerrit@115]$ vim .gitreview
1
2
3
4
|
[gerrit] host=103.10.86.30 port=29418 project= test -project1.git |
新增.gitreview到版本庫
[gerrit@115]$git add .gitreview
[gerrit@115]$git config --global user.name 'gerrit'
[gerrit@115]$git config --global user.email 'gerrit@xqshijie.cn'
[gerrit@115]$git commit .gitreview -m 'add .gitreview file by gerrit.'
[gerrit@115]$git push origin master
用gerrit使用者新增.testr.conf 檔案
Python 程式碼我使用了 testr,需要先安裝 testr 命令
[root@115]# easy_install pip
[root@115]# pip install testrepository
在 test-project1 這個專案中新增 .testr.conf 檔案
[root@115]#su - gerrit
[gerrit@115]$cd test-project1
[gerrit@115]$vim .testr.conf
1
2
3
4
5
6
7
|
[DEFAULT] test_command=OS_STDOUT_CAPTURE=1 OS_STDERR_CAPTURE=1 OS_TEST_TIMEOUT=60 ${PYTHON:-python}
-m subunit.run discover -t ./ ./ $LISTOPT $IDOPTION test_id_option=--load-list
$IDFILE test_list_option=-list |
提交到版本庫中
[gerrit@115]$git add .testr.conf
[gerrit@115]$git commit .testr.conf -m 'add .testr.conf file by gerrit'
[gerrit@115]$git push origin master
Gerrit上設定 test-project1工程
在Gerrit上建立 test-project1 專案
要知道review是在gerrit上,而gerrit上現在是沒有專案的,想讓gitlab上的專案能在gerrit上review的話,必須在gerrit上建立相同的專案,並有相同的倉庫檔案.
用gerrit使用者在 Gerrit 上建立 test-project1 專案
[root@115]# su - gerrit
[gerrit@115]$ ssh-gerrit gerrit create-project test-project1 (gerrit環境部署篇裡已經設定好的別名,方便連線gerrit)
登陸gerrit介面,發現test-project1工程已經建立了。(這種方式建立的專案是空的)
clone --bare Gitlab上的倉庫到 Gerrit (gerrit上的專案最好是從gitlab上git clone --bare過來,並且專案不要為空)
因為gerrit使用者無訪問gitlab的許可權。所以要先看是否gerrit使用者下已經存在了id_rsa金鑰,如果沒有則建立,然後把公鑰加入到gitlab的管理員賬戶上(因為後面Gerrit系統還會有個複製git庫到 Gitlab的功能需要管理員許可權)(這個測試環境,gitlab和gerrit的管理員我用的都是gerrit,所以祕鑰也是共用)
[gerrit@115]$ cd /home/gerrit/gerrit_site/git/ //即登陸到gerrit安裝目錄的git下
[gerrit@115 git]$ rm -fr test-project1.git
[gerrit@115 git]$ git clone --bare git@103.10.86.30:dev-group/test-project1.git //建立並將遠端gitlab上的這個專案內容釋出到gerrit上
[gerrit@115 git]$ ls
All-Projects.git test-project1.git
[gerrit@115 git]$ cd test-project1.git/
[gerrit@115 git]$ ls //即test-project1工程和gerrit裡預設的All-Projects.git工程結構是一樣的了
branches config description HEAD hooks info objects packed-refs refs
同步 Gerrit的test-project1 專案到 Gitlab 上的 test-project1 專案目錄中
當使用者git review後,程式碼通過 jenkins 測試、人工 review 後,程式碼只是 merge 到了 Gerrit 的 test-project1 專案中,並沒有 merge 到 Gitlab 的 test-project1 專案中,所以需要當 Gerrit test-project1 專案倉庫有變化時自動同步到 Gitlab 的 test-project1
專案倉庫中。
Gerrit 自帶一個 Replication 功能,同時我們在安裝 Gerrit 時候預設安裝了這個 Plugin。
現在只需要新增一個 replication.config 給 Gerrit
[gerrit@115]$ cd /home/gerrit/gerrit_site/etc/
[gerrit@115]$ vim replication.config
1
2
3
4
5
6
7
|
[remote "test-project1" ] projects
= test -project1 url
= git@103.10.86.30:dev-group /test-project1 .git push
= +refs /heads/ *:refs /heads/ * push
= +refs /tags/ *:refs /tags/ * push
= +refs /changes/ *:refs /changes/ * threads
= 3 |
設定gerrit使用者的 ~/.ssh/config
[gerrit@115]$ vim /home/gerrit/.ssh/config
1
2
3
|
Host
103.10.86.30: IdentityFile
~/. ssh /id_rsa PreferredAuthentications
publickey |
在gerrit使用者的~/.ssh/known_hosts 中,給103.10.86.30 新增 rsa 金鑰
[gerrit@115]$ sh -c "ssh-keyscan -t rsa 103.10.86.30 >> /home/gerrit/.ssh/known_hosts"
[gerrit@115]$ sh -c "ssh-keygen -H -f /home/gerrit/.ssh/known_hosts"
----------------------------------------------特別注意----------------------------------------------
上面設定的~/.ssh/config檔案的許可權已定要設定成600
不然會報錯:“Bad owner or permissions on .ssh/config“
----------------------------------------------------------------------------------------------------
重新啟動 Gerrit 服務
[gerrit@115]$/home/gerrit/gerrit_site/bin/gerrit.sh restart
Gerrit 的複製功能配置完畢
在 gerrit 文件中有一個 ${name} 變數用來複制 Gerrit 的所有專案,這裡並不需要。如果有多個專案需要複製,則在 replication.config 中新增多個 [remote ….] 欄位即可。務必按照上面步驟配置複製功能。
在 Jenkins 上對 test-project1 專案建立構建任務
Jenkins上首先安裝git外掛:Git Plugin
登陸jenkins,“系統管理”->“管理外掛”->“可選外掛”->選擇Git Pluin外掛進行安裝
Jenkins上建立專案
新增 test-project1工程
下面新增url:http://103.10.86.30:8080/p/test-project1.git
新增分支:origin/$GERRIT_BRANCH
如下:
構建Excute Shell,新增如下指令碼
cd $WORKSPACE
[ ! -e .testrepository ] && testr init
testr run
測試
linux系統上用wangshibo賬號提交一個更改
用wangshibo登入
刪除目錄 test-project1
克隆 test-project1 工程
進入 test-project1 目錄
新增檔案、提交
git review 增加 review 到Gerrit
[root@115]# su - wangshibo
[wangshibo@115]$ rm -rf test-project1/
[wangshibo@115]$ git clone git@103.10.86.30:dev-group/test-project1.git
[wangshibo@115]$ cd test-project1/
[wangshibo@115]$ touch testfile
[wangshibo@115]$ git add testfile
[wangshibo@115]$ git commit -m "wangshibo add this testfile"
[wangshibo@115]$ git review //提交review程式碼稽核請求
The authenticity of host '[103.10.86.30]:29418 ([103.10.86.30]:29418)' can't be established.
RSA key fingerprint is 83:ff:31:e8:68:66:6d:49:29:08:91:aa:ef:36:77:3e.
Are you sure you want to continue connecting (yes/no)? yes
Creating a git remote called "gerrit" that maps to:
ssh://wangshibo@103.10.86.30:29418/test-project1.git
Your change was committed before the commit hook was installed
Amending the commit to add a gerrit change id
remote: Resolving deltas: 100% (1/1)
remote: Processing changes: new: 1, refs: 1, done
To ssh://wangshibo@103.10.86.30:29418/test-project1.git
* [new branch] HEAD -> refs/publish/master
----------------------------------------小提示----------------------------------------
安裝git-review
[root@115]# git clone git://github.com/facebook/git-review.git
[root@115]# cd git-review
[root@115]# python setup.py install
[root@115]# pip install git-review==1.21
[root@115]# yum install readline-devel
--------------------------------------------------------------------------------------
程式碼稽核處理
用gerrit管理員賬號登入 Gerrit ,點選"All“->”Open“-> 開啟提交的review
開啟後就能看見jenkins使用者已經Verified【原因下面會提到】。
然後點選Review進行稽核
由於上面已經配置了gerrit跟jenkins的對接工作,所以當git review命令一執行,jenkins上的test-project1工程的測試任務就會自動觸發
如下:如果任務自動執行成功了,就說明jenkins測試通過,然後jenkins會利用ssh連線gerrit並給提交的subject打上verified資訊校驗結果,然後稽核人員再進行review。
所以用gerrit管理員登陸後發現,jenkins已經通過了Verified,如下
注意:
等到jenkins上Verified通過後,即看到下圖右下角出現“Verified +1 jenkins"後
才能點選"Code-Review+2",如下:
然後點選“Submit",提交稽核過的程式碼
再次檢視,review請求已被稽核處理,並且已經Merged合併了!
最後登入 Gitlab檢視 test-project1 工程,可以看到新增加檔案操作已經同步過來了
注意:在稽核人員進行review和submit操作前,要先等到jenkins測試並通過ssh方式連上gerrit給相應提交稽核的subjects帶上Verified通過後才能進行。(gitlab+gerrit+jenkins環境配置後,提交到gerrit上稽核的subjects的review人員中會預設第一個是jenkins,jenkins有結果並verified後,其他人員才能veriew和submit。也就是說當開發人員使用git review上報gerrit進行code review後,jenkins會自動觸發測試任務,通過後會在gerrit的subject稽核介面顯示verified結果,當顯示的結果是“verified +1 jenkins“後就可以進行Review和submit了,最後同步到gitlab中心倉庫。)
檢視同步日誌:
可以在gerrit伺服器上檢視replication日誌:
[gerrit@115 logs]$ pwd
/home/gerrit/gerrit_site/logs
[gerrit@115 logs]$ cat replication_log
.........................
[2016-07-14 15:30:13,043] [237da7bf] Replication to git@103.10.86.30:dev-group/test-project1.git completed in 1288 ms
[2016-07-14 15:32:29,358] [] scheduling replication test-project1:refs/heads/master => git@103.10.86.30:dev-group/test-project1.git
[2016-07-14 15:32:29,360] [] scheduled test-project1:refs/heads/master => [03b983c0] push git@103.10.86.30:dev-group/test-project1.git to run after 15s
[2016-07-14 15:32:44,360] [03b983c0] Replication to git@103.10.86.30:dev-group/test-project1.git started...
[2016-07-14 15:32:44,363] [03b983c0] Push to git@103.10.86.30:dev-group/test-project1.git references: [RemoteRefUpdate[remoteName=refs/heads/master, NOT_ATTEMPTED, (null)...dda55b52b5e5f78e2332ea2ffcb7317120347baa, srcRef=refs/heads/master, forceUpdate, message=null]]
[2016-07-14 15:32:48,019] [03b983c0] Replication to git@103.10.86.30:dev-group/test-project1.git completed in 3658 ms
----------------------------------------------------------------------------------------------------
關於jenkins上的結果:
如上,在伺服器上wangshibo賬號下
git review命令一執行,即程式碼稽核只要一提出,Jenkins 就會自動獲取提交資訊並判斷是否verified
如下,當jenkins上之前建立的工程test-project1執行成功後,那麼jenkins對提交到gerrit上的review請求
就會自動執行Verified(如上)
----------------------------------------------注意----------------------------------------------
有個發現:
jenkins上測試並返回給gerrit上提交的subject打上Verified資訊核實通過的標籤後,會將程式碼拿到自己本地相應工程的workspace目錄下
這裡的jenkins程式碼路徑是:/usr/local/tomcat7/webapps/jenkins/workspace/test-project1
不過值得注意的是,jenkins拿過來的程式碼只是每次git review修改前的程式碼狀態
可以把這個當做每次程式碼修改提交前的備份狀態
即:程式碼修改後,在gerrit裡面稽核,commit後同步到gitlab,修改前的程式碼狀態存放在jenkins裡面
-----------------------------------------------------------------------------------------------
手動安裝gerrit外掛
[gerrit@115r ~]$ pwd
/home/gerrit
[gerrit@115r ~]$ ls
gerrit-2.11.3.war gerrit_site
進行外掛安裝,下面安裝了四個外掛
[gerrit@115r ~]$ java -jar gerrit-2.11.3.war init -d gerrit_site --batch --install-plugin replication
Initialized /home/gerrit/gerrit_site
[gerrit@115r ~]$ java -jar gerrit-2.11.3.war init -d gerrit_site --batch --install-plugin reviewnotes
Initialized /home/gerrit/gerrit_site
[gerrit@115r ~]$ java -jar gerrit-2.11.3.war init -d gerrit_site --batch --install-plugin commit-message-length-validator
Initialized /home/gerrit/gerrit_site
[gerrit@115r ~]$ java -jar gerrit-2.11.3.war init -d gerrit_site --batch --install-plugin download-commands
Initialized /home/gerrit/gerrit_site
檢視plugins目錄,發現已經有外掛了
[gerrit@115r ~]$ cd gerrit_site/plugins/
[gerrit@115r ~]$ ls
commit-message-length-validator.jar download-commands.jar replication.jar reviewnotes.jar
檢視安裝了哪些外掛
[gerrit@115r ~]$ ssh-gerrit gerrit plugin ls
Name Version Status File
-------------------------------------------------------------------------------
commit-message-length-validator v2.11.3 ENABLED commit-message-length-validator.jar
download-commands v2.11.3 ENABLED download-commands.jar
replication v2.11.3 ENABLED replication.jar
reviewnotes v2.11.3 ENABLED reviewnotes.jar
或者登陸gerrit也可檢視
------------------------------------------------注意------------------------------------------------
gerrit手動同步程式碼到gitlab中心倉庫上
[gerrit@115r ~]$ ssh-gerrit gerrit --help //檢視幫助,發現gerrit COMMAND --help可查詢命令幫忙
[gerrit@115r ~]$ ssh-gerrit replication start --help //檢視replication同步命令的用法
replication start [PATTERN ...] [--] [--all] [--help (-h)] [--url PATTERN] [--wait]
PATTERN : project name pattern
-- : end of options
--all : push all known projects
--help (-h) : display this help text
--url PATTERN : pattern to match URL on
--wait : wait for replication to finish before exiting
[gerrit@115r ~]$ ssh-gerrit replication start --all //同步所有工程
-------------------------------------------------------------------------------------------------------
過載replication的同步服務
[gerrit@115r ~]$ ssh-gerrit gerrit plugin reload replication
如果報錯:fatal: remote plugin administration is disabled
解決辦法:
在/home/gerrit/gerrit_site/etc/gerrit.config檔案裡新增下面內容:
[plugins]
allowRemoteAdmin = true
然後重啟gerrit服務即可:
[gerrit@115r ~]$ /home/gerrit/gerrit_site/bin/gerrit.sh restart
Stopping Gerrit Code Review: OK
Starting Gerrit Code Review: OK
----------------------------------------------------------------------
ssh-gerrit是別名
[gerrit@115r ~]$ cat ~/.bashrc
# .bashrc
# Source global definitions
if [ -f /etc/bashrc ]; then
. /etc/bashrc
fi
alias ssh-gerrit='ssh -p 29418 -i ~/.ssh/id_rsa 103.10.86.30 -l gerrit'
# User specific aliases and functions
-------------------------------------------------------------------------------------------
多個工程在Gitlab上可以放在不同的group下進行管理
如下面兩個工程(多個工程,就在後面追加配置就行)
dev-group /test-project1
app/xqsj_android
多個工程的replication
[gerrit@Zabbix-server etc]$ cat replication.config
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
|
[remote "test-project1" ] projects
= test -project1 url
= git@103.10.86.30:dev-group /test-project1 .git push
= +refs /heads/ *:refs /heads/ * push
= +refs /tags/ *:refs /tags/ * push
= +refs /changes/ *:refs /changes/ * threads
= 3 [remote "xqsj_android" ] projects
= xqsj_android url
= git@103.10.86.30:app /xqsj_android .git push
= +refs /heads/ *:refs /heads/ * push
= +refs /tags/ *:refs /tags/ * push
= +refs /changes/ *:refs /changes/ * threads
= 3 |
然後在每個程式碼庫裡新增.gitreview和.testr.conf 檔案,
注意.gitreview檔案裡的專案名稱
按照上面同步配置後,Gerrit裡面的程式碼就會自動同步到Gitlab上,包括master分支和其他分支都會自動同步的。
如果,自動同步失效或者有問題的話,可以嘗試手動同步(下面有提到)
另外:為了減少錯誤,建議在配置的時候,gitlab和gerrit裡的賬號設定成一樣的,共用賬號/郵箱/公鑰
gerrit預設的兩個project:All-Project和All-Users絕不能刪除!!
--------------------------------------------去掉jenkins測試的方式---------------------------------------------
如果gerrit不跟jenkins結合,不通過jenkins測試並返回verified核實的方式,可以採用下面的程式碼稽核流程(必須先對提交的稽核資訊進行verified核實,然後再進行程式碼的review稽核,最後submit提交):
[去掉上面gerrit和jenkins對接設定,即關閉jenkins服務(關停對應的tomcat應用),gerrit的access授權項verified裡刪除“Group Non-Interactive Users”(在這個組內踢出jenkins使用者),並刪除gerrit上的jenkins使用者]
1)上傳程式碼者(自己先verified核實,然後通知稽核者稽核)
修改程式碼,驗證後提交到 Gerrit 上。
程式碼提交後登陸 Gerrit,自己檢查程式碼(重點看縮排格式跟原檔案是否一致;去掉紅色空格部分;修改內容是否正確;命名是否有意義;註釋內容是否符合要求等)。
自己檢查沒問題後,點 “Reply”按鈕,在“Verified”中 +1,在“Code Review”中 +1,並點“Post“
在”Reviewer”欄中,點選”Add"新增稽核者 [如果不新增稽核者,上傳者自己也可以稽核並完成提交。注意:只有Review是+2的時候,才能出現submit的提交按鈕]
如果程式碼稽核沒有通過,請重複步驟1,2,3。
流程截圖:
程式碼提交後,上傳者自行登陸gerrit,找到提交的subject,點選"Reply"
2)稽核者
收到郵件通知後登陸 Gerrit,稽核程式碼。
如果稽核通過,點 “Reply”按鈕,在“Verified”中 +1,在“Code Review”中 +2,並點“Post”,最後點選“Submit“提交!
如果程式碼稽核沒有通過,點 “Review”按鈕,在“Code Review”中 -2,寫好評論後,點“Post”。
流程截圖:
如上,subject的owner新增稽核者後,稽核者登陸gerrit進行review
點選“Reply"
這樣,就完成了一個程式碼的稽核全部過程!
登陸gitlab,就會發現gerrit上稽核通過並提交後的程式碼已經同步過來了!
注意:
如上的設定,在gerrit裡授權的時候:
Revified許可權列表裡新增“Project Owners“(-1和+1)和稽核者組(-1和+1)
Review許可權列表裡新增“Project Owners“和稽核者組(都要設定-2和+2)
附授權截圖:
------------------------------------讓非管理員使用者也有gitweb訪問許可權--------------------------------------
發現在gerrit與gitweb整合後,預設情況下,只有gerrit的管理員才有gitweb的訪問許可權,普通使用者點選gitweb連結顯示404錯誤。
最後發現使用gitweb需要有【refs/*】下所有的read許可權和【refs/meta/config】的read許可權!
預設情況下:
【refs/*】下的read許可權授予物件是:Administrators和Anonymous Users(所有使用者都是匿名使用者,這個範圍很大,已預設包括所有使用者)
【refs/meta/config】的read許可權授予物件是:Administrators和Project Owners
如想要比如上面的xqsh-app組內的使用者能正常訪問gitweb,那麼就在【refs/meta/config】分支下授予這個組的Allow許可權即可!!
截圖如下:
使用普通使用者wangshibo(在xqsj-app組內)登陸gerrit,發現能開啟xqsj_android專案的gitweb超連結訪問了
---------------------------------------------------------------------------------------------------------
後續應開發人員的要求:Gitlab+gerrit+jenkins環境下,gerrit有幾個細節,都是需要設定好的:
1)專案A的開發人員對於除A以外的專案沒有訪問許可權;
2)每個開發人員應該有+2和submit,以及建立分支的許可權;
3)給teamleader配置force push的許可權;
設定方案:
第1個要求:
在gerrit裡面設定read許可權,即"refs/*"下的"Read"許可權。
先保持將All-Projects預設許可權不變!
然後重新Edit專案A的許可權去覆蓋掉All-Projects繼承過來的這個許可權(下面會提到)
如下截圖(前面的Exclusive一定要打勾,覆蓋效果才能生效)
其實,開發人員是沒有必要開通gitlab賬號!只要gerrit提前和gitlab做好同步對接工作,那麼直接設定好gerrit許可權,開發人員可直接通過ssh方式登陸gerrit進行程式碼操作(git clone程式碼,然後修改,提交稽核,自動同步等)所以,只需要給開發人員開通gerrit賬號即可!
<如下,通過ssh方式連線gerrit上的專案,進行git clone程式碼或git pull操作等>
如下:
按照gerrit上的ssh連線方式clone專案程式碼(前提是把本地伺服器的公鑰上傳到gerrit上)
可以複製下圖中的clone或clone with commit-msg hook地址在本地進行程式碼clone
第2個要求:
a)在gerrit裡面設定,建立組比如xqsj-app,然後把這個組新增到gerrit介面相對應專案的”access“授權裡的“refs/heads/*”->Label Code-Review內,以及Submit內,這樣就保證每個開發人員有+2和submit許可權
b)將上面建立的xqsh-app組新增到gerrit介面相對應專案的”access“授權裡的“refs/heads/*”->“Create Reference”內,這樣就能保證每個開發人員有建立分支的許可權了。
第3個要求:
建立teamleader組,比如xqsj-app-teamleader,將這個組新增到A專案編輯的下面兩個許可權裡,去覆蓋從All-Projects繼承過來的許可權!
“refs/heads/*”->"Push"
“refs/meta/config”->“Push”
這兩個地方地Push許可權最好只賦給Administrators管理員和teamleader組,這樣就保證了每個teamleader有force push的許可權了。
(注意,勾上在後面的“force push”前的小框,如下截圖)
這樣,xqsj-app-teamleader組內的使用者通過ssh方式連線gerrit,git clone下載程式碼,修改後可直接git push了(不需要review稽核)
在這裡還講一下下面/refs/for/refs/*的兩個Push許可權,這個All-Projects裡預設是賦予Registered Users註冊使用者的
那麼,在給專案新編輯許可權去覆蓋的時候,最好把許可權賦予物件改成專案所在的組!
(如上面所說的,修改程式碼push的中心倉庫的許可權就只關聯到上面兩個許可權,跟這個無關)
如下:
將wangshibo使用者拉到xqsj-app-teamleader組內,上面已經設定了“Force Push”許可權,所以wangshibo使用者連線gerrit
修改後的程式碼可直接push了!然後同步到gitlab!
[wangshibo@115 ~]$ git clone ssh://wangshibo@103.10.86.30:29418/xqsj_android
Initialized empty Git repository in /home/wangshibo/www/xqsj_android/.git/
remote: Counting objects: 653, done
remote: Finding sources: 100% (653/653)
remote: Total 653 (delta 180), reused 653 (delta 180)
Receiving objects: 100% (653/653), 2.86 MiB, done.
Resolving deltas: 100% (180/180), done.
[wangshibo@Zabbix-server www]$ ls
xqsj_android
[wangshibo@115 ~]$ cd xqsj_android/
[wangshibo@115 ~]$ vim testfile //修改程式碼
[wangshibo@115 ~]$ git add testfile
[wangshibo@115 ~]$ git commit -m "222"
[master 87a02b7] 222
1 files changed, 1 insertions(+), 0 deletions(-)
[wangshibo@115 ~]$ git push //直接push即可!如果wangshibo不在teamleader組內,就不能直接push了,就只能git review稽核了!
Counting objects: 5, done.
Delta compression using up to 32 threads.
Compressing objects: 100% (2/2), done.
Writing objects: 100% (3/3), 261 bytes, done.
Total 3 (delta 1), reused 0 (delta 0)
remote: Resolving deltas: 100% (1/1)
remote: Processing changes: refs: 1, done
To ssh://wangshibo@103.10.86.30:29418/xqsj_android
1840a0c..87a02b7 master -> master
這樣,一個專案的開發人員在修改程式碼並提交gerrit後,就可以指定有相應許可權的人員進行review和submit了。
另外注意:
修改gerrit上建立的group組名或增刪等操作,可以直接在伺服器上的mysql裡面操作。
---------------------------------------------------特別注意-------------------------------------------------------
如果要想讓新建立的專案不繼承或不完全繼承All-Project專案許可權,可以自己重新修改或新增許可權,以便去覆蓋掉不想繼承的許可權!
這裡以我測試環境的一個專案xqsj_android做個例子說明:
首先在gerrit上建立一個組xqsj_android,將wangshibo普通使用者放到這個組內!
1)想要wangshibo登陸gerrit後,只能訪問它所在的專案xqsj_android
設定方法:
上面已講到,即將All-Projects的access裡的"refs/*"-"Read"許可權只給Administors(就只保留管理員的這個read許可權),這樣,project工程就只有管理員許可權才能訪問到了!
<因為其他新建的專案預設都是繼承All-Projects許可權的,設定上面的Read許可權只保留Administors後,其他的專案如果不Edit自己的許可權去覆蓋繼承過來的許可權,那麼這些專案內的使用者登陸後,都訪問不了這些專案的>
然後再在xqsj_android專案上建立Reference許可權,去覆蓋繼承過來的All-Project許可權!
特別注意下面的“Exclusive”,這個一定要勾上!!勾上了才能生效,才能覆蓋All-Project專案的許可權。
截圖如下:
如上截圖,發現“refs/*”的“Read”許可權除給了管理員Administrators,也新增了xqsj_android組,由於wangshibo在這個組內,
所以wangshibo登陸gerrit後,有訪問xqsj_android專案的許可權。
注意:
All-Projects預設的許可權最好都保持不變,不要動!
新建專案有的許可權可以自行Edit編輯,然後去覆蓋All-Projects繼承過來的許可權(新建的Reference時,後面的Exclusive一定要在前面的小方框內打上勾,這樣覆蓋才能生效!)
下面貼一下本人線上的gerrit專案修改後的許可權:
------------------------------------------------------------------------------------------------------
git clone下載程式碼,可以根據gitlab上的ssh方式克隆,也可以根據gerrit上的ssh方式克隆程式碼。
具體採用哪種,根據自己的需要判斷。
注意:當稽核未通過打回時,我們再修改完成之後,執行:
git add 檔名
git commit --amend ##注意會保留上次的 change-id ,不會生成新的評審任務編號,重用原有的任務編號,將該提交轉換為老評審任務的新補丁集
git review
-------------------------------------------------------------------------------------------------------
如果想讓某個使用者只有讀許可權,沒有寫許可權。即登陸gerrit後只能檢視,不能進行下載,上傳提交等操作
解決:
1)建立一個read的使用者組,然後將這個只讀使用者拉到這個read組內
2)在相應專案的access授權裡新增這個使用者組,如下,只需新增下面兩個地方的Read部分即可:
其中,“refs/meta/config”裡的Read授權,可以讓使用者檢視到gitlab
----------------------------------------------新增tag許可權----------------------------------------------
如上,已經給teamleader使用者組內的使用者授權直接push了,但是後面發現teamleader裡的使用者只能直接push推送程式碼到gerrit裡,
而不能直接push推送tag標籤到gerrit裡!
這是因為上面的push許可權是針對“refs/heads/*”和“refs/meta/config”設定的
而push tag需要針對“refs/tags/*”進行設定
所以,需要新增refs/tags/*部分的設定,並給與push許可權,如下:
--------------------------------------------------------------------------------------------------------------
gerrit完整遷移
將遠端gerrit上的程式碼遷移到本地新的gerrit上
要求:
遠端gerrit裡的程式碼分支和提交記錄都要遷移過來,【即Git倉庫遷移而不丟失log】(push的時候使用--mirrot映象方式即可)
流程:
1)將遠端gerrit的專案比如A進行git clone –bare克隆裸版本庫到本地
2)在本地新的gerrit上建立同名專案A(建立空倉庫)
3)然後將克隆過來的A專案內容git push --mirror到本地新gerrit上的專案A內
git push --mirror git@gitcafe.com/username/newproject.git (新gerrit上專案A的訪問地址)
這種方式就能保證分支和提交記錄都能完整遷移過來了!!!
----------------------------------------------------------------------------------------------------------
後續對專案程式碼進行操作,在登陸gerrit稽核後,檢視程式碼(對比程式碼提交前後的內容)時候出現了一個錯誤,具體如下:
其實程式碼review通過並submit後,檢視程式碼有兩種方式:
1)通過專案的gitweb檢視。當然,這種方法檢視也比較繁瑣,沒有下面的第(2)種方法檢視起來方便
2)通過submit提交後的介面(也就是merged合併後的介面),如下點選紅色方框內的稽核程式碼進行檢視:
但是點選上面紅色方框內的稽核程式碼進行檢視,出現如下報錯:
經過排查,發現造成這個報錯的原因是由於nginx的反代配置有誤造成的,如下:
proxy_pass http://103.10.86.30:8080/;
需要將上面的反向代理改為:
proxy_pass http://103.10.86.30:8080;
也就是說代理後的url後面不能加"/",這個細節在前期配置的時候沒有注意啊!!
gerrit.conf最後完整配置如下:
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
|
[root@localhost
vhosts] #
pwd /usr/local/nginx/conf/vhosts [root@localhost
vhosts] #
cat gerrit.conf server
{ listen
80; server_name
localhost; #charset
koi8-r; #access_log
/var/log/nginx/log/host.access.log main; location
/ { auth_basic "Gerrit
Code Review" ; auth_basic_user_file /home/gerrit/gerrit_site/etc/passwords ; proxy_pass
http: //103 .10.86.30:8080; proxy_set_header
X-Forwarded-For $remote_addr; proxy_set_header
Host $host; } } [root@localhost
vhosts] #
/usr/local/nginx/sbin/nginx -s reload |
對比程式碼在review前後的狀態:修改了哪些內容(右邊部分是review修改後的程式碼狀態。點選右邊"Patch Set 1"後面的圖示,可以下載或修改程式碼)
-------------------------------------------------------------------------------------------------------------
以上部署環境中,有一個不安全的地方,就是使用者提交程式碼後,自己對程式碼都有review最終稽核許可權,即"使用者自己review提交稽核-自己+1/+2稽核-自己submit",這樣設計不是很合理!
現在做下調整:
使用者自己review提交程式碼後,自己只有Code-Review +2的許可權和Submit,Verfied +1的許可權統一交由專門的稽核人員去處理,比如teamleader組。
這樣,程式碼稽核的過程:
1)使用者自己review提交程式碼稽核
2)teamleader組內人員收到稽核後,通過Verfied +1稽核
3) 使用者自己通過Code-Review +2稽核
4)使用者自己Submit提交,Merged合併處理。
具體的許可權設定調整如下:
----------------------------------------------------------------------------------------------------------------------------------
有一個問題:
如果給某個賬號開了push許可權,他在程式碼commit提交後,就可以直接git push上傳到gerrit裡面,可以不經過git review稽核提交的程式碼。如下授權截圖:
但是這樣直接git push的話,在gerrit介面的Merged處就追蹤不到這個賬號提交程式碼的記錄了,也就是說,只有經過review稽核提交的程式碼記錄才能在gerrit介面的Merged下追蹤到!如下:
如上所說,那麼直接push提交程式碼的記錄該怎麼追蹤到呢?
莫慌!
其實不管是push直接提交程式碼的記錄,還是經過review稽核提交的程式碼記錄,都可以在gitweb的log裡追蹤到的!
雖然授權了push許可權,但是也還是可以使用git review命令進行稽核的,這樣在gerrit介面的Merged裡也能追蹤到提交記錄了。
如果是直接git push的,那麼提交程式碼的時候就會直接繞過review稽核了,這樣當然不會在gerrit的Merged裡留有記錄。
----------------------------------------------------------------------------------------------------------------------------------
到此!
gerrit環境部署及其中遇到的一些問題,許可權設定等已經收錄完成,希望對有用到gerrit的朋友們有所幫助!!
轉:http://www.cnblogs.com/kevingrace/p/5651447.html
相關文章
- [原創]CI持續整合系統環境--Gitlab+Gerrit+Jenkins完整對接GitlabJenkins
- [原創]CI持續整合系統環境---部署Gitlab環境完整記錄Gitlab
- [原創]CI持續整合系統環境---部署Jenkins完整記錄Jenkins
- 容器環境持續整合優化,Drone CI 提速 500%優化
- 利用Jenkins+Gitlab搭建持續整合(CI)環境JenkinsGitlab
- 淺談持續整合(CI)、持續交付(CD)、持續部署(CD)
- CI 持續整合 - 阿里云云效阿里
- jenkins + Git 搭建持續整合環境JenkinsGit
- CI/CD 持續整合部署實踐
- GitLab CI持續整合 - .gitlab-ci.ymlGitlab
- 前端專案基於GitLab-CI的持續整合/持續部署(CI/CD)前端Gitlab
- Artifactory & GitLab CI持續整合實踐Gitlab
- ET·ci —持續整合驗證平臺
- GitLab CI持續整合-GitLab RunnerGitlab
- 持續整合服務 Travis CI 教程
- 前端er,Jenkins持續化整合環境搭建前端Jenkins
- 在Ubuntu上安裝Drone持續整合環境Ubuntu
- 基於Jenkins快速搭建持續整合環境Jenkins
- 前端 docker + gitlab CI 的持續整合(二)前端DockerGitlab
- 前端 docker + gitlab CI 的持續整合(一)前端DockerGitlab
- 前端 docker + gitlab CI 的持續整合(三)前端DockerGitlab
- ick:一個持續整合系統
- 基於 Docker 打造前端持續整合開發環境Docker前端開發環境
- 以 egg.js 為例的持續整合(CI)、持續部署(CD)JS
- 擁抱變化——持續整合(CI)實踐心得
- 對持續整合、 持續交付、持續部署和持續釋出的介紹
- Jenkins+Maven+SVN快速搭建持續整合環境(轉)JenkinsMaven
- 新一代 CI 持續整合工具 flow.ci 正式開源
- 裝在筆記本里的私有云環境:持續整合(上)筆記
- Jenkins+Svn+Docker搭建持續整合環境 自動部署JenkinsDocker
- 使用持續整合系統解放生產力
- Cruise:持續整合及釋出管理系統UI
- Jenkins持續部署-Windows環境持續部署探究1JenkinsWindows
- 持續整合、持續部署、持續交付、持續釋出
- 讓你的CI跑起來-《持續整合》讀書總結
- 持續整合持續部署持續交付_持續整合與持續部署之間的真正區別
- Docker 實戰(2)- 配置 Jenkins 容器上的持續整合環境DockerJenkins
- 持續整合、持續交付、持續部署簡介