Envoy 部署工具

Laravel 中文文档 / 官方扩展包

Envoy 远程任务处理

简介

Laravel Envoy 为定义在远程服务器上运行的常见任务提供了简介而轻量的语法。使用 Blade 风格的语法,可以轻松启动部署任务,运行 Artisan 命令等。目前,Envoy 只支持 Mac 和 Linux 操作系统。

安装

首先,使用 Composer 命令 global require 安装 Envoy:

composer global require laravel/envoy

由于 Composer 全局库有时会导致扩展包版本冲突,因此可以考虑使用 cgr,它是 composer global require 命令的安全替代方案。可以在 GitHub 上查看 cgr 库的安装说明。

确保在环境变量 PATH 中添加了 ~/.composer/vendor/bin 目录,以便在终端中运行 envoy 命令时可以找到 envoy 可执行文件。

更新 Envoy

也可以使用 Composer 将 Envoy 更新到最新版本。运行 composer global update 命令会更新所有 Composer 全局安装的扩展包:

composer global update

编写任务

所有 Envoy 任务都可以在项目根目录下的 Envoy.blade.php 文件中定义。这里有个快速入门的示例:

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

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

如您所见,文件顶部定义了一个 @servers 数组,允许您在声明任务时在 on 选项中引用这些服务器。在 @task 声明里,应该放置任务执行时在服务器上运行的 Bash 代码。

可以通过将服务器 IP 地址指定为 127.0.0.1 强制在本地运行脚本:

@servers(['localhost' => '127.0.0.1'])

启动

有时,可能需要在执行 Envoy 任务前执行一些 PHP 代码。可以使用 @setup 指令在任何其它任务执行前声明变量和进行其它常见的 PHP 操作:

@setup
    $now = new DateTime();

    $environment = isset($env) ? $env : "testing";
@endsetup

如果需要在任务执行前引入其它 PHP 文件,可以在 Envoy.blade.php 文件顶部使用 @include 指令:

@include('vendor/autoload.php')

@task('foo')
    # ...
@endtask

变量

如有需要,可以使用命令行传递选项值给 Envoy 任务:

envoy run deploy --branch=master

可以通过 Blade 的「输出」语法获取选项。当然,也可以在任务中使用 if 语句和循环。例如,我们在执行 git pull 命令前检查 $branch 变量是否存在:

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

@task('deploy', ['on' => 'web'])
    cd site

    @if ($branch)
        git pull origin {{ $branch }}
    @endif

    php artisan migrate
@endtask

故事

故事将一组任务分组到单个方便的名称下,允许您将单个简单任务组合为复杂的任务。例如,deploy 故事可以通过在声明里列出任务名来运行 gitcomposer 任务:

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

@story('deploy')
    git
    composer
@endstory

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

@task('composer')
    composer install
@endtask

编写故事后,可以像普通任务一样运行它:

envoy run deploy

多台服务器

Envoy 允许您轻松跨多台服务器运行任务。首先,在 @servers 声明中添加其它服务器。每台服务器应该分配一个唯一的名称。定义其它服务器之后,在任务的 on 数组中列出每台服务器:

@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

并行执行

默认情况下,任务会在每台服务器上依次执行。换句话说,在第一台服务器上运行完成后,才会继续在第二台服务器上执行任务。如果想要在多台服务器上并行运行任务,可以在声明任务时添加 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

运行任务

要运行定义在 Envoy.blade.php 文件中的任务或故事,可以执行 Envoy 的 run 命令,并传递想要执行的任务名称或故事名称。Envoy 会在命令运行时从服务器上运行任务并显示输出:

envoy run task

确认执行任务

如果想要在服务器上运行任务前提示是否确认运行,可以在声明任务时添加 confirm 指令。此选项对有破坏性的操作尤其有用:

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

通知

Slack

Envoy 还支持在每个任务执行后发送通知到 Slack@slack 指令接收一个 Slack Hook URL 和一个频道名称。可以在 Slack 控制面板通过创建「传入 WebHooks」集成获取 Webhook URL。应该将完整的 Webhook URL 传递到 @slack 指令中:

@finished
    @slack('webhook-url', '#bots')
@endfinished

可以提供以下其中一项作为频道参数:

  • 发送通知到频道:#channel
  • 发送通知给用户:@user
  上一篇 下一篇  

作者:ilaoniu

牛哥,俗称哞哞。单纯的九零后理工小青年。喜欢折腾,爱玩,爱安卓,爱音乐,爱游戏,爱电影,爱旅游...