laravel 基础教程 —— SSH 职务

Envoy 义务运行器

简介

Laravel
Envoy
为远端服务器常用任务的概念与执行提供了迷你简洁的语法。你可以透过利用
Blade 语法样式轻松的为布局,Artisan 命令等设置任务。近日,Envoy 只支持Mac 和 Linux 操作系统。

安装

先是,你须要经过 Composer 的 global 命令来设置 Envoy:

composer global require "laravel/envoy=~1.0"

您必要确保 ~/.composer/vendor/bin 目录被投入到您的 PATH
中,那样才能使你在动用终端时得以一贯利用 envoy 命令。

更新 Envoy

您可以应用 Composer 来维系 Envoy 的革新:

composer global update

编写职责

拥有的 Envoy 职分应该被定义在你项目标根目录下的 Envoy.blade.php
文件中。那里有一个简易的以身作则:

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

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

就像您所见到的,@servers
指令被定义在文件的头顶,并且包蕴一个数组,数组中涵盖服务器的列表。@task
指令用来定义职责,它包括一个职责名称,和一个数组参数,数组中蕴藏一个
on 键,它的值就是职分所要执行的服务器,它应当是 @servers
指令列表中的一个或几个。你应当在 @task 指令的其中放置 Bash
代码,这几个代码会在职责执行时传递给所要执行的远端服务器。

本地义务

您可以指定服务器为当地来施行本地的职务:

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

引导

有时,你也许希望在执行 Envoy 职分从前先举行某些 PHP 操作。你可以选取
@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

职责变量

如果你要求的话,你可以选用命令行开关来传递变量到 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

多少个服务器

您可以轻松的跨四个服务器执行职务。首先,你须要在 @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

默认的,职分会在服务器间串行执行,那表示唯有在当前服务器执行职务成功之后才会实施下一个服务器的职责。

平行执行

要是您愿意跨服务器平行执行职分。你可以在任务指令中添加 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

任务宏

职务宏允许你定义一个命令来挨家挨户的施行一组职分。举个实例,大家定义一个
deploy 宏来举行 gitcomposer 任务:

@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

运作任务

您须求运用 Envoy 的 run 命令来实施 Envoy.blade.php
文件中所定义的职务。你可以传递一个任务的称号或者宏名称到命令中。Envoy
会执行职分并联名展现服务器执行的出口:

envoy run task

通知

HipChat

您可以利用 @hipchat 指令来在义务履行到位未来,发送一个新闻通告到公司的
HipChat 房间中。这么些命令接收一个 API
token,房间的名号和音信中所突显的发送者的用户名:

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

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

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

即使你须求,你也足以发送自定义的音信到 HipChat
房间。创设音信时,职责可用的变量在音信中也是可用的:

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

Slack

除了 HipChat 之外,Envoy 也支撑向
Slack
中发送布告。@slack 指令接收一个 Slack hook
URL,一个频道名称,和你需求发送的音讯内容:

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

您可以因而在 Slack 的网站上创建一个 Incoming WebHooks 来获取 webhook
URL。hook 参数应该是一个整机的 webhook URL,比如:

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

你可以提供以下作为频道的参数之一:

  • #channel 发送通告到频道
  • @user 发送公告到用户

相关文章