Appearance
Laravel Envoy
简介
Laravel Envoy 是一个用于在远程服务器上执行常见任务的工具。使用 Blade 风格的语法,你可以轻松设置部署、Artisan 命令等任务。目前,Envoy 仅支持 Mac 和 Linux 操作系统。但是,可以使用 WSL2 在 Windows 上实现支持。
安装
首先,使用 Composer 包管理器将 Envoy 安装到你的项目中:
shell
composer require laravel/envoy --dev
安装完 Envoy 后,Envoy 二进制文件将在你应用程序的 vendor/bin
目录中可用:
shell
php vendor/bin/envoy
编写任务
定义任务
任务是 Envoy 的基本构建块。任务定义了在调用任务时应在远程服务器上执行的 shell 命令。例如,你可能会定义一个任务,在应用程序的所有队列工作服务器上执行 php artisan queue:restart
命令。
所有 Envoy 任务都应在应用程序根目录的 Envoy.blade.php
文件中定义。这是一个示例,可以帮助你入门:
blade
@servers(['web' => ['user@192.168.1.1'], 'workers' => ['user@192.168.1.2']])
@task('restart-queues', ['on' => 'workers'])
cd /home/user/example.com
php artisan queue:restart
@endtask
如你所见,在文件顶部定义了一个 @servers
数组,允许你在任务声明的 on
选项中引用这些服务器。@servers
声明应始终放在一行上。在你的 @task
声明中,你应放置在调用任务时应在服务器上执行的 shell 命令。
本地任务
你可以通过将服务器的 IP 地址指定为 127.0.0.1
来强制脚本在本地计算机上运行:
blade
@servers(['localhost' => '127.0.0.1'])
导入 Envoy 任务
使用 @import
指令,你可以导入其他 Envoy 文件,以便将它们的故事和任务添加到你的文件中。导入文件后,你可以像在自己的 Envoy 文件中定义的任务一样执行它们包含的任务:
blade
@import('vendor/package/Envoy.blade.php')
多台服务器
Envoy 允许你轻松在多台服务器上运行任务。首先,将额外的服务器添加到你的 @servers
声明中。每个服务器应分配一个唯一的名称。一旦你定义了额外的服务器,你就可以在任务的 on
数组中列出每个服务器:
blade
@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])
@task('deploy', ['on' => ['web-1', 'web-2']])
cd /home/user/example.com
git pull origin {{ $branch }}
php artisan migrate --force
@endtask
并行执行
默认情况下,任务将在每台服务器上串行执行。换句话说,任务将在第一台服务器上完成运行后,再继续在第二台服务器上执行。如果你希望在多台服务器上并行运行任务,请在任务声明中添加 parallel
选项:
blade
@servers(['web-1' => '192.168.1.1', 'web-2' => '192.168.1.2'])
@task('deploy', ['on' => ['web-1', 'web-2'], 'parallel' => true])
cd /home/user/example.com
git pull origin {{ $branch }}
php artisan migrate --force
@endtask
设置
有时,你可能需要在运行 Envoy 任务之前执行任意的 PHP 代码。你可以使用 @setup
指令定义一块 PHP 代码,该代码应在任务之前执行:
php
@setup
$now = new DateTime;
@endsetup
如果你需要在执行任务之前要求其他 PHP 文件,你可以在 Envoy.blade.php
文件的顶部使用 @include
指令:
blade
@include('vendor/autoload.php')
@task('restart-queues')
# ...
@endtask
变量
如果需要,你可以通过在命令行上指定它们来向 Envoy 任务传递参数。例如:
shell
php vendor/bin/envoy run deploy --branch=master
你可以在任务中使用 Blade 的 "echo" 语法访问选项。你还可以在任务中定义 Blade if
语句和循环。例如,让我们在执行 git pull
命令之前验证是否存在 $branch
变量:
blade
@servers(['web' => ['user@192.168.1.1']])
@task('deploy', ['on' => 'web'])
cd /home/user/example.com
@if ($branch)
git pull origin {{ $branch }}
@endif
php artisan migrate --force
@endtask
故事
故事将一组任务归类为一个方便的名称。例如,deploy
故事可以运行 update-code
和 install-dependencies
任务,只需在其定义中列出任务名称即可:
blade
@servers(['web' => ['user@192.168.1.1']])
@story('deploy')
update-code
install-dependencies
@endstory
@task('update-code')
cd /home/user/example.com
git pull origin master
@endtask
@task('install-dependencies')
cd /home/user/example.com
composer install
@endtask
一旦故事编写完成,你就可以以与运行任务相同的方式调用它:
shell
php vendor/bin/envoy run deploy
钩子
当任务和故事运行时,会执行一些钩子。Envoy 支持的钩子类型有 @before
, @after
, @error
, @success
, 和 @finished
。所有这些钩子中的代码都被解释为 PHP 并在本地执行,而不是在与任务交互的远程服务器上执行。
你可以定义任意数量的每种钩子。它们将按照它们在 Envoy 脚本中出现的顺序执行。
@before
在每次任务执行之前,将执行 Envoy 脚本中注册的所有 @before
钩子。@before
钩子接收将要执行的任务的名称:
blade
@before
if ($task === 'deploy') {
// ...
}
@endbefore
@after
在每次任务执行后,将执行 Envoy 脚本中注册的所有 @after
钩子。@after
钩子接收已执行的任务的名称:
blade
@after
if ($task === 'deploy') {
// ...
}
@endafter
@error
每次任务失败后(以大于 0
的状态码退出),将执行 Envoy 脚本中注册的所有 @error
钩子。@error
钩子接收已执行的任务的名称:
blade
@error
if ($task === 'deploy') {
// ...
}
@enderror
@success
如果所有任务都已成功执行而没有错误,将执行 Envoy 脚本中注册的所有 @success
钩子:
blade
@success
// ...
@endsuccess
@finished
在所有任务执行完毕后(无论退出状态如何),将执行所有 @finished
钩子。@finished
钩子接收已完成任务的状态码,该状态码可以是 null
或大于或等于 0
的 integer
:
blade
@finished
if ($exitCode > 0) {
// 其中一个任务出现错误...
}
@endfinished
运行任务
要运行在应用程序的 Envoy.blade.php
文件中定义的任务或故事,请执行 Envoy 的 run
命令,并传递你想要执行的任务或故事的名称。Envoy 将执行任务并在任务运行时显示来自远程服务器的输出:
shell
php vendor/bin/envoy run deploy
确认任务执行
如果你希望在服务器上运行给定任务之前收到确认提示,你应该在任务声明中添加 confirm
指令。此选项对于破坏性操作特别有用:
blade
@task('deploy', ['on' => 'web', 'confirm' => true])
cd /home/user/example.com
git pull origin {{ $branch }}
php artisan migrate
@endtask
通知
Slack
Envoy 支持在每次任务执行后向 Slack 发送通知。@slack
指令接受 Slack 钩子 URL 和频道/用户名。你可以在 Slack 控制面板中创建 "Incoming WebHooks" 集成来获取你的 Webhook URL。
你应将整个 Webhook URL 作为第一个参数传递给 @slack
指令。第二个参数应为频道名称(#channel
)或用户名(@user
):
blade
@finished
@slack('webhook-url', '#bots')
@endfinished
默认情况下,Envoy 通知将发送一条消息到通知频道,描述已执行的任务。但是,你可以通过向 @slack
指令传递第三个参数来覆盖此消息,并使用自定义消息:
blade
@finished
@slack('webhook-url', '#bots', 'Hello, Slack.')
@endfinished
Discord
Envoy 还支持在每次任务执行后向 Discord 发送通知。@discord
指令接受 Discord 钩子 URL 和消息。你可以在服务器设置中创建 "Webhook" 并选择 Webhook 应发布到哪个频道来获取你的 Webhook URL。你应将整个 Webhook URL 传递给 @discord
指令:
blade
@finished
@discord('discord-webhook-url')
@endfinished
Telegram
Envoy 还支持在每次任务执行后向 Telegram 发送通知。@telegram
指令接受 Telegram Bot ID 和 Chat ID。你可以使用 BotFather 创建新的 Bot 来获取你的 Bot ID。你可以使用 @username_to_id_bot 获取有效的 Chat ID。你应将整个 Bot ID 和 Chat ID 传递给 @telegram
指令:
blade
@finished
@telegram('bot-id','chat-id')
@endfinished
Microsoft Teams
Envoy 还支持在每次任务执行后向 Microsoft Teams 发送通知。@microsoftTeams
指令接受 Teams Webhook(必需),消息,主题颜色(success, info, warning, error),以及选项数组。你可以在创建新的 incoming webhook 来获取你的 Teams Webhook。Teams API 有许多其他属性可以自定义你的消息框,如标题,摘要和部分。你可以在 Microsoft Teams 文档 中找到更多信息。你应将整个 Webhook URL 传递给 @microsoftTeams
指令:
blade
@finished
@microsoftTeams('webhook-url')
@endfinished