php + Laravel 实现部署自动化

2017年10月13日 266点热度 0人点赞 0条评论

所谓自动化部署, 我的理解就是在用户保证代码质量的前提下, 将代码能够快速的自动部署到目标服务器上的一种手段.

实现原理

本地推送代码 -> 代码库 -> webhook 通知服务端 -> 自动拉取代码库代码

图片生成并且部署公钥

具体步骤参照 配置SSH公钥

1) 生成公钥

  1. # 使用给定的 email 生成 public/private rsa 密钥

  2. # 如果使用非默认地址需要配置 .ssh/config

  3. $ ssh-keygen -t rsa -b 4096 -C "[email protected]"

2) 在 coding 中添加公钥

输出部署公玥

  1. $ cat coding.pub

在git 管理端部分部署公钥

图片

3) 配置 config 文件

编辑 ~/.ssh/config 文件

  1. Host git.coding.net

  2. User xxxx@email.com

  3. PreferredAuthentications publickey

  4. IdentityFile ~/.ssh/coding_rsa  // 生成的非默认地址的公钥存放点

4) 测试是否可以链接到 [email protected] 服务器

  1. # 注意 git.coding.net 接入到 CDN 上所以会解析多个不同的 host ip

  2. $ ssh -T git@git.coding.net

  3. The authenticity of host 'git.coding.net (123.59.85.184)' can't be established.

  4. RSA key fingerprint is 98:ab:2b:30:60:00:82:86:bb:85:db:87:22:c4:4f:b1.

  5. Are you sure you want to continue connecting (yes/no)?

  6. # 这里我们根据提示输入 yes

  7. Warning: Permanently added 'git.coding.net,123.59.85.184' (RSA) to the list of known hosts.

  8. Coding 提示: Hello duoli, You've connected to Coding.net via SSH. This is a deploy key.

  9. duoli,你好,你已经通过 SSH 协议认证 Coding.net 服务,这是一个部署公钥

设置 webhook

让代码库接收到通知的时候通知服务端接收代码更新.

图片

这种 webhook 的方式来接收可以部署的请求, 这里的请求使用的是 post 方法

php 接收部署

因为 php 脚本代码执行的时候会可能有服务的中断(例如执行时间), 不一定符合实际, 所以计划使用脚本来调用.

收到请求 -> 存入队列 -> 脚本监听处理队列

由于使用 laravel 框架, 收到通知之后, 存入队列, 因为队列使用的是命令行监听, 所以命令行执行的时候不会出现中断情况.

在此之前需要配置运行代码的用户有权限能够访问到 git 的服务器. 也就是如果你的代码以 www-data 运行, 需要使用 www-data 的角色来访问 git@git.coding.net 服务器. 否则也不能实现部署, 原因是 密钥不符合而无权限获取内容.

1) 队列代码 设置 app/Jobs

  1. <?php

  2. namespace App\Jobs;

  3. use Illuminate\Contracts\Bus\SelfHandling;

  4. use Illuminate\Contracts\Queue\ShouldQueue;

  5. use Symfony\Component\Process\Process;

  6. class WebDeploy extends Job implements SelfHandling, ShouldQueue

  7. {

  8.    private $shellPath;

  9.    /**

  10.     * Create a new job instance.

  11.     */

  12.    public function __construct()

  13.    {

  14.        $this->shellPath = dirname(dirname(__DIR__));

  15.    }

  16.    /**

  17.     * Execute the job.

  18.     * @return void

  19.     */

  20.    public function handle()

  21.    {

  22.        if (!env('LM_DEPLOY_BRANCH')) {

  23.            echo 'ERR > ' . 'No branch Set'."\n";

  24.        }

  25.        $shell   = "/bin/bash " . base_path('resources/shell/deploy.sh') . ' ' . base_path() . ' ' . env('LM_DEPLOY_BRANCH', 'master');

  26.        $process = new Process($shell);

  27.        $process->start();

  28.        $process->wait(function ($type, $buffer) {

  29.            if (Process::ERR === $type) {

  30.                echo 'ERR > ' . $buffer;

  31.            }

  32.            else {

  33.                echo 'OUT > ' . $buffer;

  34.            }

  35.        });

  36.    }

  37. }

2) 触发队列

  1. dispatch(new WebDeploy());

3) 部署 shell 脚本

  1. #!/bin/bash

  2. aim_path=$1

  3. branch=$2

  4. cd ${aim_path}

  5. echo $PWD

  6. /usr/bin/git pull origin ${branch} >/dev/null 2>&1

  7. if [ $? -eq 0 ];then

  8. echo "OK"

  9. else

  10.   /usr/bin/git fetch -f

  11.   /usr/bin/git reset --hard

  12.   /usr/bin/git pull origin ${branch}

  13. fi

4) 使用supervisor 来监听队列执行, 监听队列任务

图片

文件位置 /etc/supervisord.d/project.ini

  1. [program:project_name]

  2. process_name=%(program_name)s_%(process_num)02d

  3. command=php /path/to/project/artisan queue:work  --sleep=3 --tries=3 --daemon

  4. autostart=true

  5. autorestart=true

  6. user=apache

  7. numprocs=1

  8. redirect_stderr=true

  9. stdout_logfile=/webdata/logs/project.log

  10. environment=QUEUE_DRIVER=database

注意要点

之前和同事研究自动化部署花费很长时间, 对于PHP能否胜任这个功能还是存在一点疑惑的, 之前在局域网进行部署的时候能够实现代码的部署, 但是在其余时间测试的时候则均是失败. 本次换了这种方式找到了一种方式来运行脚本. 理论上不会存在执行不成功的时候, 直到看到了如下的报错:

  1. OUT > /webdata/www/sour-lemon.com

  2. ERR > Could not create directory '/usr/share/httpd/.ssh'.

  3. ERR > Host key verification failed.

  4. ERR > fatal: Could not read from remote repository. Please make sure you have the correct access rights and the repository exists.

因为当前 shell 运行的用户是 apache , 所以在调用的时候会以 apache 的身份去调用这个请求, 故而出现了 Could not create directory '/usr/share/httpd/.ssh', 所以就考虑用 apache 权限去设置 ssh 的自动化部署.

由于 apache 用户是处于不允许登陆状态, 需要首先允许其登录, 然后再设置相应的 ssh key.

更改文件 /etc/passwd 允许用户登录

  1. # 之前是 /sbin/nologin

  2. apache:x:48:48:Apache:/usr/share/httpd:/bin/bash

然后再切换到 apache 用户来进行 ssh key 设定, 这样经过测试, 通过.

图片

参考文章

  • Github 访问时出现Permission denied (public key)

  • 配置SSH公钥

  • https://gist.github.com/jexchan/2351996

  • https://www.freebsd.org/cgi/man.cgi?query=ssh_config&sektion=5&n=1

  • https://help.github.com/articles/error-permission-denied-publickey/#platform-linux

  • http://callmepeanut.blog.51cto.com/7756998/1304912

  • http://www.huamanshu.com/walle.html

  • http://walle-web.io/

  • https://github.com/meolu/walle-web

  • https://www.phptesting.org/install-phpci


相关文章推荐

八年 phper 的高级工程师面试之路

PHP 那些“坑”

2017 年 PHP 程序员未来路在何方


相关讲堂推荐

图片

17310php + Laravel 实现部署自动化

root

这个人很懒,什么都没留下

文章评论