服務(wù) ―― Envoy 任務(wù)運行器（SSH任務(wù)）

服務(wù) —— Envoy 任務(wù)運行器（SSH任務(wù)）

1、簡介

Laravel Envoy?為定義運行在遠程主機上的通用任務(wù)只支持Mac和Linux操作系統(tǒng)。

1.1 安裝

首先，使用Composer的global?命令安裝Envoy：

composer global require "laravel/envoy=~1.0"

確保~/.composer/vendor/bin目錄在系統(tǒng)路徑PATH中否則在終端中由于找不到envoy而無法執(zhí)行該命令。

1.1.1 更新Envoy

還可以使用Composer保持安裝的Envoy是最新版本：

composer global update

2、編寫任務(wù)

所有的Envoy任務(wù)都定義在項目根目錄下的Envoy.blade.php文件中，下面是一個讓你開始的示例：

@servers(['web' => 'user@192.168.1.1'])

@task('foo', ['on' => 'web'])
    ls -la
@endtask

正如你所看到的，@servers數(shù)組定義在文件頂部，從而允許你在任務(wù)聲明中使用on選項引用這些服務(wù)器，在?@task聲明中，應(yīng)該放置將要在服務(wù)器上運行的Bash代碼。

啟動

有時候，你需要在評估Envoy任務(wù)之前執(zhí)行一些PHP代碼，可以在Envoy文件中使用@setup指令來聲明變量和要執(zhí)行的PHP代碼：

@setup
    $now = new DateTime();
    $environment = isset($env) ? $env : "testing";
@endsetup

還可以使用@include來引入外部PHP文件：

@include('vendor/autoload.php');

確認任務(wù)

如果你想要在服務(wù)器上運行給定任務(wù)之前彈出彈出提示進行確認，可以在任務(wù)聲明中使用confirm指令：

@task('deploy', ['on' => 'web', 'confirm' => true])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

2.1 任務(wù)變量

如果需要的話，你可以使用命令行開關(guān)傳遞變量到Envoy文件，從而允許你自定義任務(wù)：

envoy run deploy --branch=master

你可以在任務(wù)中通過Blade的“echo”語法使用該選項：

@servers(['web' => '192.168.1.1'])

@task('deploy', ['on' => 'web'])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

2.2 多個服務(wù)器

你可以輕松地在多主機上運行同一個任務(wù)，首先，添加額外服務(wù)器到@servers聲明，每個服務(wù)器應(yīng)該被指配一個唯一的名字。定義好服務(wù)器后，在任務(wù)聲明中簡單列出所有服務(wù)器即可：

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2']])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

默認情況下，該任務(wù)將會依次在每個服務(wù)器上執(zhí)行，這意味著，該任務(wù)在第一臺服務(wù)器上運行完成后才會開始在第二臺服務(wù)器運行。

2.2.1 平行運行

如果你想要在多個服務(wù)器上平行運行，添加parallel選項到任務(wù)聲明：

@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])

@task('deploy', ['on' => ['web-1', 'web-2'], 'parallel' => true])
    cd site
    git pull origin {{ $branch }}
    php artisan migrate
@endtask

2.3 任務(wù)宏

宏允許你使用單個命令中定義多個依次運行的任務(wù)。例如，deploy宏會運行g(shù)it和composer任務(wù)：

@servers(['web' => '192.168.1.1'])

@macro('deploy')
    git
    composer
@endmacro

@task('git')
    git pull origin master
@endtask

@task('composer')
    composer install
@endtask

宏被定義好了之后，你就可以通過如下單個命令運行它：

envoy run deploy

3、運行任務(wù)

要從Envoy.blade.php文件中運行一個任務(wù)，需要執(zhí)行Envoy的run命令，然后傳遞你要執(zhí)行的任務(wù)的命令名或宏。Envoy將會運行命令并從服務(wù)打印輸出：

envoy run task

4、通知

4.1?HipChat

運行完一個任務(wù)后，可以使用Envoy的@hipchat指令發(fā)送通知到團隊的HipChat房間，該指令接收一個API令牌、房間名稱、和用戶名：

@servers(['web' => '192.168.1.1'])

@task('foo', ['on' => 'web'])
    ls -la
@endtask

@after
    @hipchat('token', 'room', 'Envoy')
@endafter

需要的話，你還可以傳遞自定義發(fā)送給HipChat房間的消息，所有在Envoy任務(wù)中有效的變量在構(gòu)建消息時也有效：

@after
    @hipchat('token', 'room', 'Envoy', "{$task} ran in the {$env} environment.")
@endafter

4.2?Slack

除了HipChat之外，Envoy還支持發(fā)送通知到Slack。@slack指令接收一個Slack鉤子URL、頻道名稱、和你要發(fā)送給該頻道的消息：

@after
    @slack('hook', 'channel', 'message')
@endafter

你可以通過創(chuàng)建集成到Slack網(wǎng)站的Incoming WebHooks來獲取鉤子URL，該hook參數(shù)是由?Incoming Webhooks Slack?集成提供的完整webhook URL，例如：

https://hooks.slack.com/services/ZZZZZZZZZ/YYYYYYYYY/XXXXXXXXXXXXXXX

你可以提供下面兩種其中之一作為頻道參數(shù)：

• 發(fā)送消息到頻道:?#channel
• 發(fā)送消息到用戶:?@user