服务 ―― Envoy 任务运行器（SSH任务）
最后更新于：2022-04-01 04:11:36
# 服务 —— Envoy 任务运行器（SSH任务）
## 1、简介
[Laravel Envoy](https://github.com/laravel/envoy) 为定义运行在远程主机上的通用任务只支持Mac和Linux操作系统。
### 1.1 安装
首先，使用Composer的`global` 命令安装Envoy：
~~~
composer global require "laravel/envoy=~1.0"
~~~
确保`~/.composer/vendor/bin`目录在系统路径PATH中否则在终端中由于找不到`envoy`而无法执行该命令。
### 1.1.1 更新Envoy
还可以使用Composer保持安装的Envoy是最新版本：
~~~
composer global update
~~~
## 2、编写任务
所有的Envoy任务都定义在项目根目录下的`Envoy.blade.php`文件中，下面是一个让你开始的示例：
~~~
@servers(['web' => 'user@192.168.1.1'])
@task('foo', ['on' => 'web'])
ls -la
@endtask
~~~
正如你所看到的，`@servers`数组定义在文件顶部，从而允许你在任务声明中使用`on`选项引用这些服务器，在 `@task`声明中，应该放置将要在服务器上运行的Bash代码。
**启动**
有时候，你需要在评估Envoy任务之前执行一些PHP代码，可以在Envoy文件中使用`@setup`指令来声明变量和要执行的PHP代码：
~~~
@setup
$now = new DateTime();
$environment = isset($env) ? $env : "testing";
@endsetup
~~~
还可以使用`@include`来引入外部PHP文件：
~~~
@include('vendor/autoload.php');
~~~
**确认任务**
如果你想要在服务器上运行给定任务之前弹出弹出提示进行确认，可以在任务声明中使用`confirm`指令：
~~~
@task('deploy', ['on' => 'web', 'confirm' => true])
cd site
git pull origin {{ $branch }}
php artisan migrate
@endtask
~~~
### 2.1 任务变量
如果需要的话，你可以使用命令行开关传递变量到Envoy文件，从而允许你自定义任务：
~~~
envoy run deploy --branch=master
~~~
你可以在任务中通过Blade的“echo”语法使用该选项：
~~~
@servers(['web' => '192.168.1.1'])
@task('deploy', ['on' => 'web'])
cd site
git pull origin {{ $branch }}
php artisan migrate
@endtask
~~~
### 2.2 多个服务器
你可以轻松地在多主机上运行同一个任务，首先，添加额外服务器到`@servers`声明，每个服务器应该被指配一个唯一的名字。定义好服务器后，在任务声明中简单列出所有服务器即可：
~~~
@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
~~~
默认情况下，该任务将会依次在每个服务器上执行，这意味着，该任务在第一台服务器上运行完成后才会开始在第二台服务器运行。
### 2.2.1 平行运行
如果你想要在多个服务器上平行运行，添加`parallel`选项到任务声明：
~~~
@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 任务宏
宏允许你使用单个命令中定义多个依次运行的任务。例如，`deploy`宏会运行git和composer任务：
~~~
@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、运行任务
要从`Envoy.blade.php`文件中运行一个任务，需要执行Envoy的`run`命令，然后传递你要执行的任务的命令名或宏。Envoy将会运行命令并从服务打印输出：
~~~
envoy run task
~~~
## 4、通知
### 4.1 HipChat
运行完一个任务后，可以使用Envoy的`@hipchat`指令发送通知到团队的[HipChat](https://www.hipchat.com/)房间，该指令接收一个API令牌、房间名称、和用户名：
~~~
@servers(['web' => '192.168.1.1'])
@task('foo', ['on' => 'web'])
ls -la
@endtask
@after
@hipchat('token', 'room', 'Envoy')
@endafter
~~~
需要的话，你还可以传递自定义发送给HipChat房间的消息，所有在Envoy任务中有效的变量在构建消息时也有效：
~~~
@after
@hipchat('token', 'room', 'Envoy', "{$task} ran in the {$env} environment.")
@endafter
~~~
### 4.2 Slack
除了HipChat之外，Envoy还支持发送通知到[Slack](https://slack.com/)。`@slack`指令接收一个Slack钩子URL、频道名称、和你要发送给该频道的消息：
~~~
@after
@slack('hook', 'channel', 'message')
@endafter
~~~
你可以通过创建集成到Slack网站的Incoming WebHooks来获取钩子URL，该hook参数是由 Incoming Webhooks Slack 集成提供的完整webhook URL，例如：
~~~
https://hooks.slack.com/services/ZZZZZZZZZ/YYYYYYYYY/XXXXXXXXXXXXXXX
~~~
你可以提供下面两种其中之一作为频道参数：
* 发送消息到频道: `#channel`
* 发送消息到用户: `@user`