gerrit 部署手册

gerrit 部署手册

概述

gerrit是谷歌开发用于安卓系统的代码审查的系统，目前已经开源。gerrti使用简单并友好。这里记录了gerrti的部署方法以及其中可能存在的陷阱和问题。

 

创建专属系统用户

Gerrit code review推荐使用一个独立的用户执行操作，当然这不是必须的。但是这个用户必须具有对配置中设定的git路径持有读写权限！

 

下载安装包

wget http://gerrit-releases.storage.googleapis.com/gerrit-2.8.war

目前最新版本2.12

 

安装依赖项

apt-get install default-jre daemon
apt-get install apache2-utils

 

创建数据库

Gerrit需要使用数据库保存系统数据。这里我们使用mysql,在数据库中创建数据库,gerrit默认数据库名为reviewdb，可以使用其他的名称。

 

安装

java -jar gerrit-2.8.war init -d /etc/gerrit/

gerrit-2.8.war文件为你下载的安装包；

/etc/gerrit/ 是安装目标路径，该路径必须具有读写权限！

 

步骤如下：

  1 # java -jar gerrit-2.8.war init -d /etc/gerrit/
  2 
  3  
  4 
  5 *** Gerrit Code Review 2.8
  6 
  7 ***
  8 
  9  
 10 
 11 Create '/etc/gerrit'           [Y/n]? Y #如果路径不存在，将自动创建
 12 
 13  
 14 
 15 *** Git Repositories
 16 
 17 ***
 18 
 19  
 20 
 21 Location of Git repositories   [git]:
 22 
 23  
 24 
 25 *** SQL Database
 26 
 27 ***
 28 
 29  
 30 
 31 Database server type           [h2]: mysql
 32 
 33  
 34 
 35 Gerrit Code Review is not shipped with MySQL Connector/J 5.1.21
 36 
 37 **  This library is required for your configuration. **
 38 
 39 Download and install it now [Y/n]? y
 40 
 41 Downloading http://repo2.maven.org/maven2/mysql/mysql-connector-java/5.1.21/mysql-connector-java-5.1.21.jar ... OK
 42 
 43 Checksum mysql-connector-java-5.1.21.jar OK
 44 
 45 Server hostname                [localhost]:
 46 
 47 Server port                    [(mysql default)]:
 48 
 49 Database name                  [reviewdb]: gerritdb
 50 
 51 Database username              [root]: gerrituser
 52 
 53 gerrituser's password          :
 54 
 55               confirm password :
 56 
 57  
 58 
 59 *** User Authentication
 60 
 61 ***
 62 
 63  
 64 
 65 Authentication method          [OPENID/?]: http
 66 
 67 Get username from custom HTTP header [y/N]? n
 68 
 69 SSO logout URL                 :
 70 
 71  
 72 
 73 *** Email Delivery
 74 
 75 ***
 76 
 77  
 78 
 79 SMTP server hostname           [localhost]: smtp.googlemail.com
 80 
 81 SMTP server port               [(default)]: 587
 82 
 83 SMTP encryption                [NONE/?]: tls
 84 
 85 SMTP username                  [root]: gerrit@thstack.com
 86 
 87 review@thstack.com's password  :
 88 
 89               confirm password :
 90 
 91  
 92 
 93 *** Container Process
 94 
 95 ***
 96 
 97  
 98 
 99 Run as                         [root]:
100 
101 Java runtime                   [/usr/lib/jvm/java-6-openjdk-amd64/jre]:
102 
103 Copy gerrit-2.8.war to /etc/gerrit/bin/gerrit.war [Y/n]? y
104 
105 Copying gerrit-2.8.war to /etc/gerrit/bin/gerrit.war
106 
107  
108 
109 *** SSH Daemon
110 
111 ***
112 
113  
114 
115 Listen on address              [*]:
116 
117 Listen on port                 [29418]:
118 
119  
120 
121 Gerrit Code Review is not shipped with Bouncy Castle Crypto v144
122 
123   If available, Gerrit can take advantage of features
124 
125   in the library, but will also function without it.
126 
127 Download and install it now [Y/n]? y
128 
129 Downloading http://www.bouncycastle.org/download/bcprov-jdk16-144.jar ... OK
130 
131 Checksum bcprov-jdk16-144.jar OK
132 
133 Generating SSH host key ... rsa... dsa... done
134 
135  
136 
137 *** HTTP Daemon
138 
139 ***
140 
141  
142 
143 Behind reverse proxy           [y/N]? y
144 
145 Proxy uses SSL (https://)      [y/N]? n
146 
147 Subdirectory on proxy server   [/]:
148 
149 Listen on address              [*]:
150 
151 Listen on port                 [8081]: 8082
152 
153 Canonical URL                  [http://www.thstack.com/]: http://review.thstack.com/
154 
155  
156 
157 *** Plugins
158 
159 ***
160 
161  
162 
163 Install plugin reviewnotes version v2.8 [y/N]? y
164 
165 Install plugin download-commands version v2.8 [y/N]? y
166 
167 Install plugin replication version v2.8 [y/N]? y
168 
169 Install plugin commit-message-length-validator version v2.8 [y/N]? y
170 
171  
172 
173 Initialized /etc/gerrit
174 
175 Executing /etc/gerrit/bin/gerrit.sh start
176 
177 Starting Gerrit Code Review: OK
178 
179 Waiting for server on review.thstack.com:80 ... OK
180 
181 Opening http://review.thstack.com/#/admin/projects/ ...FAILED
182 
183 Open Gerrit with a JavaScript capable browser:
184 
185   http://review.thstack.com/#/admin/projects/

 

配置

多数步骤可以直接回车使用默认参数，仅有几处需要小心：

Location of Git repositories：该路径时仓库路径，如果想包含已有的git仓库路径，那么应该使用这个路径，并且，gerrit运行用户必须具有该路径的读写权限！否则gerrit将无法登陆。

Database server type：使用的数据库类型，默认是gerrit自带的h2。

Authentication method：gerrit使用的用户认证方式，默认是OPENID,这是一种使用第三方的账户信息的认证方式，比如使用yahoo!,google,amazon等。另外一种就是http方式，这个在后面的用户会讲到。

Email Delivery：邮件服务配置，可以使用默认。

Run as：Gerrit运行用户，这里就是用到了之前新建的专属用户。

SSH Daemon：Gerrit自带一个独立的ssh服务，所以这里配置的是这个ssh服务器的监听信息，包括地址，以及端口。地址可以默认，端口也可以默认29418，自己也可以配置，但是不要低于1024.另外外部必须能够访问该端口！

HTTP Daemon：Behind reverse proxy：apache2反向代理,应该设定为y。使用反向代理时，必须确保apache2相应的组件可用！后面会讲到。

HTTP Daemon：Listen on port：http运行端口，这里使用的端口应该与反向代理的端口设定为不同的值，否则浏览器无法访问。

Apache2配置

  1 <VirtualHost *:20002>

  2

  3     ProxyRequests Off

  4     ProxyVia Off

  5     ProxyPreserveHost On

  6

  7

  8     <Proxy *>

  9         Order deny,allow

 10         Allow from all

 11     </Proxy>

 12

 13     <Location /login/>

 14         AuthType Basic

 15         AuthName "Gerrit Code Review"

 16         Require valid-user

 17         AuthUserFile /home/gerrit/gerrit-site/bin/password

 18     </Location>

 19

 20     ProxyPass / http://127.0.0.1:8081/

 21 </VirtualHost>

Password file

Apache2配置中存在一个AuthUserFile路径，这个是用于执行http认证方式的，因为在安装时【Authentication method】参数设定为http方式。这个文件如果不存在则应该创建之。

这个文件用于保存gerrit用户数据，包括用户名和密码，密码使用了MD5加密方式保存。不要手动修改该文件！

第一个用户将会成为gerrit系统管理员账户，创建用户时使用如下命令：

htpasswd -b your/passwd/file username password

 

 

所有的gerrit用户应该在这里添加！否则其他用户无法登陆gerrit.用户第一次登陆gerrit时，gerrit自动保存用户信息到数据库中！请勿直接修改数据库！

 

请运行htpasswd --help查看详情。

 

启动

安装完后需要自己手动启动gerrit服务，启动前请确保相应的路径的权限以及数据库。

运行安装目录下的bin/gerrit.sh脚本。

./gerrit.sh stop:停止服务
./gerrit.sh start:启动服务
./gerrit.sh restart:重启服务
./gerrit.sh run：调试运行，可以实时查看运行日志，可以使用这个方法调试问题。

 

详细信息运行./gerrit.sh help查看。

 

启动后如果存在如下提示文本，说明启动成功：

Starting Gerrit Code Review: OK

如果不是的话，那么说明部署失败！

 

FQA

FQA1

 

查看apache2运行日志：

AH01144: No protocol handler was valid for the URL /. If you are using a DSO version of mod_proxy, make sure the proxy submodules are included in the configuration using LoadModule.

 

说明是apache2反向代理组件未启用！执行以下命令：

a2enmod proxy
a2enmod proxy_http
sudo service apache2 restart

 

FQA2

 

Gerrit未启动！

 

FQA3

[2016-02-29 03:31:32,159] ERROR com.google.gerrit.httpd.restapi.RestApiServlet : Error in GET /accounts/self/preferences
java.lang.IllegalStateException: Missing project All-Projects

设置的git路径的权限有问题，运行gerrit的用户必须有该目录的读写权限！

 

FQA4

ssh: connect to host 96.224.86.210 port 29418: Connection refused

该端口未开放或者gerrit服务未启动！

 

FQA5

Sign Out Failure

也许你会发现用gerrit+HTTP认证，通过web登陆后，点击右上角的Sign Out无法登出。要么是依然保持登陆的状态，要么就是直接出错。

不要以为怎么了，其实这是正常现象，以下这段话是从网上看到的：

You are using HTTP Basic authentication. There is no way to tell abrowser to quit sending basic authentication credentials, to logout with basicauthentication is to close the Webbrowser.