php + Laravel 實現部署自動化

所謂自動化部署，個人理解就是在用戶保證代碼質量的前提下, 將代碼可以快速的自動部署到目標服務器上的一種手段.php

實現原理

本地推送代碼 -> 代碼庫 -> webhook 通知服務端 -> 自動拉取代碼庫代碼laravel

生成而且部署公鑰

具體步驟參照配置SSH公鑰git

1) 生成公鑰github

# 使用給定的 email 生成 public/private rsa 密鑰
# 若是使用非默認地址須要配置 .ssh/config
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"

2) 在 coding 中添加公鑰web

輸出部署公玥shell

$ cat coding.pub

在git 管理端部分部署公鑰apache

3) 配置 config 文件bash

編輯 ~/.ssh/config 文件服務器

Host git.coding.net
User xxxx@email.com
PreferredAuthentications publickey
IdentityFile ~/.ssh/coding_rsa  // 生成的非默認地址的公鑰存放點

4) 測試是否能夠連接到 git@git.coding.net 服務器app

# 注意 git.coding.net 接入到 CDN 上因此會解析多個不一樣的 host ip 
$ ssh -T git@git.coding.net
The authenticity of host 'git.coding.net (123.59.85.184)' can't be established.
RSA key fingerprint is 98:ab:2b:30:60:00:82:86:bb:85:db:87:22:c4:4f:b1.
Are you sure you want to continue connecting (yes/no)? 
# 這裏咱們根據提示輸入 yes
Warning: Permanently added 'git.coding.net,123.59.85.184' (RSA) to the list of known hosts.
Coding 提示: Hello duoli, You've connected to Coding.net via SSH. This is a deploy key.
duoli，你好，你已經經過 SSH 協議認證 Coding.net 服務，這是一個部署公鑰

設置 webhook

讓代碼庫接收到通知的時候通知服務端接收代碼更新.

這種 webhook 的方式來接收能夠部署的請求, 這裏的請求使用的是 post 方法

php 接收部署

由於 php 腳本代碼執行的時候會可能有服務的中斷(例如執行時間), 不必定符合實際, 因此計劃使用腳原本調用.

收到請求 -> 存入隊列 -> 腳本監聽處理隊列

因爲使用 laravel 框架, 收到通知以後, 存入隊列, 由於隊列使用的是命令行監聽, 因此命令行執行的時候不會出現中斷狀況。

在此以前須要配置運行代碼的用戶有權限可以訪問到 git 的服務器. 也就是若是你的代碼以 www-data 運行, 須要使用 www-data 的角色來訪問 git@git.coding.net 服務器. 不然也不能實現部署, 緣由是密鑰不符合而無權限獲取內容.

1) 隊列代碼設置 app/Jobs

<?php 
namespace AppJobs;
use IlluminateContractsBusSelfHandling;
use IlluminateContractsQueueShouldQueue;
use SymfonyComponentProcessProcess;
class WebDeploy extends Job implements SelfHandling, ShouldQueue
{
 private $shellPath;
 /**
 * Create a new job instance.
 */
 public function __construct()
{
 $this->shellPath = dirname(dirname(__DIR__));
 }
 /**
 * Execute the job.
 * @return void
 */
 public function handle()
{
 if (!env('LM_DEPLOY_BRANCH')) {
 echo 'ERR > ' . 'No branch Set'."n";
 }
 $shell   = "/bin/bash " . base_path('resources/shell/deploy.sh') . ' ' . base_path() . ' ' . env('LM_DEPLOY_BRANCH', 'master');
 $process = new Process($shell);
 $process->start();
 $process->wait(function ($type, $buffer) {
 if (Process::ERR === $type) {
 echo 'ERR > ' . $buffer;
 }
 else {
 echo 'OUT > ' . $buffer;
 }
 });
 }
}

2) 觸發隊列

dispatch(new WebDeploy());

3) 部署 shell 腳本

#!/bin/bash
aim_path=$1
branch=$2
cd ${aim_path}
echo $PWD
/usr/bin/git pull origin ${branch} >/dev/null 2>&1
if [ $? -eq 0 ];then
echo "OK"
else
 /usr/bin/git fetch -f
 /usr/bin/git reset --hard
 /usr/bin/git pull origin ${branch}
fi

4) 使用supervisor 來監聽隊列執行, 監聽隊列任務

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

[program:project_name]
process_name=%(program_name)s_%(process_num)02d
command=php /path/to/project/artisan queue:work  --sleep=3 --tries=3 --daemon
autostart=true
autorestart=true
user=apache
numprocs=1
redirect_stderr=true
stdout_logfile=/webdata/logs/project.log
environment=QUEUE_DRIVER=database

注意要點

以前和同事研究自動化部署花費很長時間, 對於PHP可否勝任這個功能仍是存在一點疑惑的, 以前在局域網進行部署的時候可以實現代碼的部署, 可是在其他時間測試的時候則均是失敗. 本次換了這種方式找到了一種方式來運行腳本. 理論上不會存在執行不成功的時候, 直到看到了以下的報錯:

OUT > /webdata/www/sour-lemon.com
ERR > Could not create directory '/usr/share/httpd/.ssh'.
ERR > Host key verification failed.
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 容許用戶登陸

# 以前是 /sbin/nologin
apache:x:48:48:Apache:/usr/share/httpd:/bin/bash

而後再切換到 apache 用戶來進行 ssh key 設定, 這樣通過測試, 經過.

參考文章

Github 訪問時出現Permission denied (public key)
配置SSH公鑰
https://gist.github.com/jexch...
https://www.freebsd.org/cgi/m...
https://help.github.com/artic...
http://callmepeanut.blog.51ct...
http://www.huamanshu.com/wall...
http://walle-web.io/
https://github.com/meolu/wall...
https://www.phptesting.org/in...