11月10日
利用 GitHook 构建持续交付和部署

1、为什么要打造可持续交付和部署

软件发布是一个令人头痛的过程,非常耗时且风险很高。对于小团队来说一般分为两种:“签入时交付”和“定时交付”。

“签入时交付”策略的优势在于马上产生的满足感。根据代码库的规模,从签入新功能代码到能够在交付准备服务器上测试,一两分钟就够了。

这种方式的主要问题在于:交付准备服务器会被蹂躏得不稳定。很多时候,我见到有人试图测试某个功能,突然新的版本推到交付准备服务器上了,破坏了正在运行的测试。更糟糕的是:交付准备服务器常常作为演示服务器使用,在某些重要的演示时,很可能出现严重的后果。

定期交付策略更易于预测。所有人都知道交付何时启动,并可以规划自己的代码签入是在交付之前还是之后进行。典型做法是一天构建/交付一次或两次。

由于架构的特殊性,服务器将会越来越多。试想一下你要在几十台服务器上更新代码是一件多么繁琐的事情。对于我们公司来说面临着严重的如何更快交付和部署代码的问题。

我们需要将经历过测试的代码能够迅速部署到服务器上,本来考虑过jekins,但jekins对我们来说又太过繁琐。

2、交付与部署过程

目前我们使用的是阿里云服务,阿里云服务有个很方便的地方就是镜像,一次制作整个集群都可以使用。

工程师将代码上传到开发环境的库中,通过GitHook自动让测试用的服务器更新代码,测试完成后只要将相关的代码稍稍修改为生产环境的配置并上传到生产环境的Git库,通过GitHook所有与这个库有关的服务器都会自动更新代码。

测试的具体过程就不在此论述了。

3、GitHook

我们来看下官方解释:

钩子(hooks)是一些在"$GIT-DIR/hooks"目录的脚本, 在被特定的事件(certain points)触发后被调用。当"git init"命令被调用后, 一些非常有用的示例钩子文件(hooks)被拷到新仓库的hooks目录中; 但是在默认情况下这些钩子(hooks)是不生效的。 把这些钩子文件(hooks)的".sample"文件名后缀去掉就可以使它们生效了。

简单地来说有点类似回调,就是特定事情完成后回调执行事件。

4、如何搭建

我们公司使用的是coding、服务器上是已经装好jetty的ubuntu,不过github、gitlab跟这个的配置方法类似。

*Git-SSH*

首先现在coding上建立一个代码库,然后在生产环境上的代码部署的地方git clone刚刚新建的代码库。

没有git的要安装git,ubuntu下是apt-get install git

为了让git能够自动更新代码库而不需要输入账号密码,这时候就需要用到git-ssh了。

如果是第一次使用要先设置git的名字和邮箱(自己随便取个名字和邮箱就行):

git config --global user.name "test"

git config --global user.email "test@zomake.com"

然后通过上一个命令输入的邮箱来生成密钥

ssh-keygen -t rsa -C "test@zomake.com"

如果不需要设置密钥的密码的话,直接三个回车。然后你就在命令行上看到生成了两个文件:id_rsa和id_rsa.pub。

(如果不是第一次的话执行命令会提示overwrite,输入y就行。)

然后我们把密钥交给ssh-agent来管理,可以通过eval "$(ssh-agent -s)"看看是不是正常运行,是的话会输出它的pid。

ssh-add ~/.ssh/id_rsa

用上面这个命令将刚刚生成的私钥交给ssh-agent。路径填你在终端上看到的。

登录coding,点击账户-SSH公钥-添加。将之前生成的id_rsa.pub里的内容复制进去。

最后进到之前clone下来的代码库中修改.git文件夹下config中的url,改为远端仓库的SSH访问地址,如git@git.coding.net:t-baby/test.git

这样一来在服务器上git就无需输入账号密码了。

*准备update.sh*

cd /
vi git_update.sh

然后将下面的东西复制进去并保存:

#!/bin/bash

cd /opt/jetty/webapps

git remote update -p

git checkout -f origin/master

git submodule update --init

service jetty restart 

第二行和最后一行根据需要自行更换,因为我们的代码是Java的,放在jetty中运行。将第二行的cd改成你自己的代码所在目录。而最后一行代码是用来重启jetty服务器的,你可以去掉或加上自己服务器的重启代码。

保存后给这个脚本文件777的权限。

*准备githook.php*

由于一些原因,为了方便我们使用了php作为GitHook回调的地址。

先装好PHP环境并修改端口为8080,apache默认文件夹为/var/www(80已经被jetty占了,具体安装方法见我另一篇文章)

在/var/www/中新建一个叫githook.php,然后放入以下代码:

shell_exec('cd /var/www && php gitpull.php');

然后再在当前文件夹下建个gitpull.php


$pid = pcntl_fork();
if ($pid == -1){
} else if ($pid > 0){
$fs = fopen('./git_hook.log', 'a');

fwrite($fs, 'Request on ['.date("Y-m-d H:i:s").']'.PHP_EOL);

$json = file_get_contents('php://input');
$data = json_decode($json, true);
fwrite($fs, 'Data: '.print_r($data, true).PHP_EOL);

fwrite($fs, '======================================================================='.PHP_EOL);
$fs and fclose($fs);

pcntl_wait($status); 

} else if ($pid == 0){

exec('sudo sh /git_update.sh &');
}

`

执行git_update.sh更新git仓库。

为什么要这样做呢。因为coding的webhook的等待时间是写死的,要5秒内有反应,这就会导致包含一些需要时间的命令会让webhook的地址验证不成功,从而在push后不回调到地址上。

所以我们用了多进程来让其中一个执行日志的记录,另一个负责执行sh文件。

*填入回调地址*

紧接着我们在coding中打开部署用的代码库,左侧点击设置-WebHook。比如我们刚刚的是

http://111.111.111.111:8080/githook.php

(ps:直接填写IP可以减少域名解析所耗费的时间)

*给apache权限*

聪明的朋友们测试的时候肯定发现了问题,exec里面的代码并不执行怎么办?其实很简单是因为apache的权限不够,只要给予权限就行。

我们可以先通过lsof -i:80看看apache的执行用户是谁。

图片

比如我这里是www-data用户,然后执行visudo。

图片

然后找到图片上的位置修改成图片上那样,后面那行www-data是要自己添加的。接着保存。保存的话就是ctrl+x然后回车。

这样就可以让apache不需要密码就可以用管理员权限执行了。

赶紧测试下看看是不是成功了!

如何部署代码以及结论

现在只要你一更新仓库的代码,就会自动回调到githook.php从而让服务器自动更新代码。即使多几台服务器也是一样的,最简单的方法就是利用公有云服务的镜像功能做成镜像装在集群中的其它机器,然后在coding的WebHook那里加上这些服务器的IP就行。

这应该是全网最完善的相关教程了吧。自己靠着百度到很多不完整的资料琢磨了一天然后写下此教程。找教程。。。最后别太相信百度到的,血的教训~。

原文链接

16条评论

webhookForCoding , 针对 coding 定制 : https://www.oschina.net/p/webhookforcoding

weiChen3 年前回复

jenkins的话可以试试 https://github.com/yuzd/coding.net

俞正东3 年前回复

@陆唯超 最简单的办法

git remote update -p && git checkout -f origin/master
robot53 年前回复

$status在哪儿定义的?

莫奇3 年前回复

有点多此一举。 直接写一个shell脚本,放在crontab里面,比如5分钟执行一次即可。如果不愿意自动,就手动执行一下就行。不要使用基于PHP的HTTP请求,而且还给apache那么大的权限。多不安全啊

pooy3 年前回复

最后一句亮了

liangzai_cool3 年前回复

如果服务器是nginx呢 执行exec 有问题吧

Kelvin3 年前回复

现在有一个问题,在调用git remote update -p 的时候,可能还没有执行完就已经执行get checkout -f origin/xxx 这一句了,导致最后checkout的的不是最新的远端分支,有什么办法能避免这样的问题么~

小陆乱撞3 年前回复

差不多实现我要的功能了,但我想再进一步,不是每次提交代码都部署到生产环境的,能否根据git commit -m "message" 提交的信息来判断来触发webhook?

xiao345@gmail.com3 年前回复

##目测有难度

奋斗的十二4 年前回复