做之前查了几个资料 :
https://segmentfault.com/a/1190000011561808
https://segmentfault.com/a/1190000010698441
本文目的
本文的目的是配置实现在 GitLab 平台上的代码自动部署。想要达到的效果是这样子的,当客户端向 GitLab 服务器的特定分支(如:prod)提交代码时,GitLab 服务器会发送通知给线上代码服务器,代码服务器收到通知之后再拉取 GitLab 服务器上该分支的最新代码。
效果图如下:
有了 GitLab ,只需要三步就可以实现以上描述的效果了。
步骤一、准备脚本
在代码服务器端准备好一份处理 GitLab 服务器通知的脚本和一份拉取代码的脚本。
GitLab 服务器所发出来的通知,其实就是向代码服务器发出一个 http 请求,请求中包含了本次提交中的相关信息,如所提交的分支、谁提交的、本次更新的代码等等信息。
所以在代码服务器中添加一个脚本,专门处理该请求即可。
可以参考一下 PHP 代码: 文件名称 : gitPull.php
<?php
// 处理 GitLab 请求的脚本
error_reporting(1);
$target = '/home/centos/www/xiaoniaoAdmin'; // 生产环境web目录
$token = 'xiaoniaoAdminPush'; //GitLab 添加的token
if (empty($_SERVER['HTTP_X_GITLAB_TOKEN']) || $_SERVER['HTTP_X_GITLAB_TOKEN'] !== $token) {
exit('error request');
}
$rowData = file_get_contents('php://input', 'r');;
$rowData = json_decode($rowData,true);
$output = '';
$type = $_GET['type'];
// 只拉取 release 分支的代码到服务器
if($rowData['ref'] == 'refs/heads/release'){
if('ims' == $type){
// 触发拉取代码的脚本
chdir($target);
$cmd = "git pull";
shell_exec($cmd);
}
logg($type." output:".json_encode($output));
}
logg($type.':'.$rowData['user_name']." commit to branch:".$rowData['ref']);
function logg($data){
$text = '['.date('Y-m-d H:i:s').'] '.$data."\n";
file_put_contents(dirname(dirname(__FILE__)).'/log/gitlab'.date('ymd').'.log',$text,FILE_APPEND);
}
这里的钩子文件,可以用 http://www.kobeman.com/gitPull.php 看可以访问到
这里的钩子文件需要注意以下几点
php
配置里需要注释掉shell_exec
这些被禁用的函数 详见 shell_exec (https://www.zhihu.com/question/57879484?from=profile_question_card)- 执行命令时切换到管理员用户最好
- 查看是否进入你的项目目录 这里我是通过
chdir
进入项目目录 因为cd
命令是没有用的 详见 Can't 'cd' with PHP shell_exec()(https://stackoverflow.com/questions/12521053/cant-cd-with-php-shell-exec) git pull
不能执行 这应该就是权限的问题 详见 shell 脚本中调用 git pull 命令无法执行 (https://stackoverflow.com/questions/3173201/sudo-in-php-exec)- 这里为什么我们需要获取这个
$_SERVER
的参数呢 因为GitLab
是通过post
请求这个地址 所以为了验证之前填入的token
步骤二、配置 webhooks
在项目中配置 webhooks(Web 钩子) 其实就是在项目中注册一个触发器,当项目中的某个事件发生时,该触发器就会被触发。在 GitLab 中的触发器就是一个 http 请求,即一个 http 链接。
如下图 : 在 gitlab 上的操作截图
图中 1 : 可以访问 钩子文件的 url
图中 2 : 跟 钩子文件 中 $token 保持一致,用作请求验证
步骤三、添加秘钥
既然是代码自动部署,那当然是完全不需要人为参与的啦,这将包括不需要人为输入密码。
GitLab 提供了让每个账号使用秘钥登录的功能,配置了账号秘钥之后就可以无密码登录账号了。代码自动部署正是需要这样子的功能了。
首先要在代码服务器端生成秘钥:
使用命令
ssh-keygen
,连续按三次回车即可生成一对无密码保护的秘钥,它们的名称分别是id_rsa
和id_rsa.pub
然后将 id_rsa.pub
的内容添加到 GitLab 账号:
在 GitLab 账号的 profile setting > SSH keys 粘贴并保存即可
需要注意的地方
通过以上三步,现在已经能够实现代码自动部署了。
如果完成了以上步骤之后,还不能实现代码自动部署,最可能出现问题的是账号的权限问题了。有两个地方可能出现权限的问题。
-
GitLab 账号的权限
自动部署所绑定的账号需要有权限访问该项目。
-
代码服务器端执行脚本的用户的权限
首先,该用户需要有权限对项目目录进行读写; 然后是,该用户的秘钥信息绑定的是正确的 GitLab 账号