介绍

Deployer 是一个基于 SSH 协议的无侵入 web 项目部署工具，因为它不需要你在目标 服务器 上装什么服务之类的东西即可使用，它只需要在你的开发机，或者你的笔记本，就是发起部署动作的一方安装即可。

它的原理就是通过 SSH 到你的机器去创建目录，移动文件，执行指定的动作来完成项目的部署。

Deployer 不但可以部署php项目，也可以部署其他语言醒目

deployer 的优势

  1. 真正解放双手，一条命令完成部署。
  2. 进行部署的过程中，项目仍然能够正常访问。部署成功完成后才切到新的版本。
  3. 能十分方便地进行回滚。
  4. 丰富任务钩子和预置任务可灵活的组合完成各种任务，比如执行前端依赖的安装、构建等。

使用 deployer 的前提条件

  1. 本地机器（也就是你执行 dep 命令时所在的机器）能够 SSH 连接到目标机器
  2. 指定用户有登录目标机器并调整一些设置的权限
  3. 目标主机有拉取项目仓库的权限

使用说明

1、安装

  1. curl -LO https://deployer.org/deployer.phar
  2. mv deployer.phar /usr/local/bin/dep
  3. chmod +x /usr/local/bin/dep

2、生成部署脚本代码

切换到要部署的项目目录下，执行以下命令

  1. dep init

此时会在改目录下生成 deploy.php文件

3、使用说明

未便于管理最好再创建文件deploy.config.php文件，提出公共配置，便于维护部署脚本。

实例：

以deploy部署go语言项目为例：

deploy.config.php

  1. <?php
  3. return [
  4.     'application' => 'miner-proxy', # 进程名称
  5.     'git' => 'git@bitbucket.org:miner/miner-proxy.git',
  6.     'branch' => 'master',
  7.     'deploy_path' => '/alidata/deploy/miner-proxy',
  8.     'servers' => [
  9.         'proxy0' => '192.134.45.45',
  10.         'proxy1' => '192.45.67.8',
  11.         'proxy2' => '193.168.45.67',
  12.     ],
  13.     'rsync' => [
  14.         'rsync -avz /alidata/deploy/miner-proxy/current/build/bin/* public@{ip}:/alidata/service/miner-proxy/',
  15.         'rsync -avz /alidata/deploy/miner-proxy/current/build/supervisord.conf public@{ip}:/alidata/service/miner-proxy/'
  16.     ]
  17. ];

deploy.php

  1. <?php
  2. namespace Deployer;
  4. require 'recipe/common.php';
  5. $config = require 'deploy.config.php';
  7. // 项目名
  8. set('application', $config['application']);
  10. // 项目仓库地址
  11. set('repository', $config['git']);
  13. // [Optional] Allocate tty for git clone. Default value is false.
  14. set('git_tty', true); 
  16. // Shared files/dirs between deploys 
  17. set('shared_files', []);
  18. set('shared_dirs', []);
  20. // Writable dirs by web server 
  21. set('writable_dirs', []);
  23. set('keep_releases', 5);
  25. $stage = $_SERVER['argv'][2];
  26. if(!array_key_exists($stage, $config['servers'])){
  27.     exit('stage ' . $stage . ' 不存在');
  28. }
  30. # 目标主机配置
  31. # 192.168.45.67 机器作为程序构建机器
  32. # 不要用root用户，新创建一个普通用户用作部署，在部署之前设置好改账号的各个目录权限
  33. host('192.168.45.67')
  34.     ->user('test')
  35.     ->set('branch', $config['branch']);
  36.     ->stage($stage)
  37.     ->set('deploy_path', $config['deploy_path']);
  39. // Tasks
  40. desc('Deploy super-miner-proxy project');
  41. task('deploy', [
  42.     'deploy:info',
  43.     'deploy:prepare',
  44.     'deploy:lock',
  45.     'deploy:release',
  46.     'deploy:update_code',
  47.     'deploy:shared',
  48.     'deploy:writable',
  49.     'deploy:clear_paths',
  50.     'deploy:symlink',
  51.     'deploy:unlock',
  52.     'cleanup',
  53.     'success'
  54. ]);
  56. # 自定义任务
  57. # 构建任务
  58. task('make', function () use ($config, $stage) {
  59.     run('cd ' . $config['deploy_path'] . '/current && (export PATH=$PATH:/usr/local/go/bin;make)');
  60. });
  62. # 打包同步任务，最好先压缩再同步
  63. task('rsync', function () use ($config, $stage){
  64.     foreach ($config['rsync'] as $val){
  65.         $val = str_replace('{ip}', $config['servers'][$stage], $val);
  66.         run($val);
  67.     }
  68. });
  70. # 可执行程序同步完成后重启进程
  71. # 对于需要sudo操作的命令，可以在指定机器上设置该命令免密
  72. task('restart', function () use ($config, $stage) {
  73.     run('ssh  test@' . $config['servers'][$stage] . ' "sudo /usr/bin/supervisorctl restart ' . $config['application'] . '"');
  74. });
  77. # 如果部署失败，自动解除部署锁定状态，以免影响下次执行
  78. after('deploy:failed', 'deploy:unlock');
  79. # 部署
  80. after('deploy', 'make');
  81. # 回退
  82. after('rollback', 'make');
  83. # 同步
  84. after('make', 'rsync');
  85. # 重启
  86. after('rsync', 'restart');

注意

对于 deploy:update_code 使用Git下载新版本的代码。如果您使用的是Git 2.0版，并且git_cache config已打开，则此任务将使用先前发行版中的文件，因此仅下载更改的文件。否则重新clone 代码。

执行部署命令
  1. 部署：
  2. dep deploy {stage}  -vvv
  4. 回退：
  5. dep rollback {stage} -vvv

当你第一次成功部署的时候， Deployer 会自动帮你在服务器上生成一下文件：
  1. releases 包含你部署项目的版本（默认保留 5 个版本）
  3. shared 包含你部署项目的共享文件或目录（如：Laravel 的 Storage 目录、.env 文件等 ）
  5. current 软连接到你当前发布的版本

官方文档地址

其他设置点可以通过以下网址查看

https://deployer.org/docs/getting-started

https://github.com/deployphp/deployer