[原] php + Laravel 實現部署自動化

多釐發表於2019-01-30
PHPLaravel

所謂自動化部署， 我的理解就是在使用者保證程式碼質量的前提下, 將程式碼能夠快速的自動部署到目標伺服器上的一種手段.

實現原理

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

[原] php + Laravel 實現部署自動化

生成並且部署公鑰

具體步驟參照 配置SSH公鑰

1) 生成公鑰

# 使用給定的 email 生成 public/private rsa 金鑰
# 如果使用非預設地址需要配置 .ssh/config
$ ssh-keygen -t rsa -b 4096 -C "your_email@example.com"
複製程式碼

2) 在 coding 中新增公鑰

輸出部署公玥

$ cat coding.pub
複製程式碼

在git 管理端部分部署公鑰

[原] php + Laravel 實現部署自動化

3) 配置 config 檔案

編輯 ~/.ssh/config 檔案

Host git.coding.net
User xxxx@email.com
PreferredAuthentications publickey
IdentityFile ~/.ssh/coding_rsa  // 生成的非預設地址的公鑰存放點
複製程式碼

4) 測試是否可以連結到 git@git.coding.net 伺服器

# 注意 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

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

[原] php + Laravel 實現部署自動化

這種 webhook 的方式來接收可以部署的請求, 這裡的請求使用的是 post 方法

php 接收部署

因為 php 指令碼程式碼執行的時候會可能有服務的中斷(例如執行時間), 不一定符合實際, 所以計劃使用指令碼來呼叫.

收到請求 -> 存入佇列 -> 指令碼監聽處理佇列

由於使用 laravel 框架, 收到通知之後, 存入佇列, 因為佇列使用的是命令列監聽, 所以命令列執行的時候不會出現中斷情況.

在此之前需要配置執行程式碼的使用者有許可權能夠訪問到 git 的伺服器. 也就是如果你的程式碼以 www-data 執行, 需要使用 www-data 的角色來訪問 git@git.coding.net 伺服器. 否則也不能實現部署, 原因是 金鑰不符合而無許可權獲取內容.

1) 佇列程式碼 設定 app/Jobs

<?php 
namespace App\Jobs;

use Illuminate\Contracts\Bus\SelfHandling;
use Illuminate\Contracts\Queue\ShouldQueue;
use Symfony\Component\Process\Process;

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 來監聽佇列執行, 監聽佇列任務

[原] php + Laravel 實現部署自動化

檔案位置 /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 設定, 這樣經過測試, 通過.

[原] php + Laravel 實現部署自動化

參考文章

相關文章