更新日: 2016年12月22日
PHP & CakePHP

CakePHPアプリケーションをCapistranoでデプロイ

CakePHP アプリケーションを、Ruby 製のデプロイツールである Capistrano を使って自動でデプロイする方法です。Capistrano および Capistrano::Composer を使います。

https://github.com/capistrano/capistrano
https://github.com/capistrano/composer/

いずれも Ruby Gem のライブラリとなりますので、事前に Ruby, Bundler などの環境が構築されている前提です。

— 環境 —
CakePHP 3.2.5
Ruby 2.2.3
capistrano 3.4.0
capistrano-composer 0.0.6

【お知らせ】英単語を画像イメージで楽に暗記できる辞書サイトを作りました。英語学習中の方は、ぜひご利用ください！

画像付き英語辞書 Imagict | 英単語をイメージで暗記
【開発記録】
英単語を画像イメージで暗記できる英語辞書サービスを作って公開しました

では、以降 Capistrano で CakePHP アプリケーションをデプロイする手順。

capistrano と capistrano-composer の gem インストール

まずは、capistrano と capistrano-composer の gem をインストールします。Gemfile に追記してインストール。

Gemfile

source "https://rubygems.org"
ruby "2.2.3"
 
gem "capistrano"
gem 'capistrano-composer'

source "https://rubygems.org"

ruby "2.2.3"

gem "capistrano"

gem 'capistrano-composer'

–path vendor/bundle のオプションを付けて、vendor/bundle ディレクトリ以下にインストールします。


$ cd /path/to/cakeapp
$ bundle install --path vendor/bundle

$ cd /path/to/cakeapp

$ bundle install --path vendor/bundle

Capistrano 関連ファイルを生成・編集

続いて、cap install コマンドで Capistrano が使うファイルを生成する。


$ bundle exec cap install
mkdir -p config/deploy
create config/deploy.rb
create config/deploy/staging.rb
create config/deploy/production.rb
mkdir -p lib/capistrano/tasks
create Capfile
Capified

$ bundle exec cap install

mkdir -p config/deploy

create config/deploy.rb

create config/deploy/staging.rb

create config/deploy/production.rb

mkdir -p lib/capistrano/tasks

create Capfile

Capified

上記ファイル郡が生成されました。

Capfile を編集します。

Capfile

# Load DSL and Setup Up Stages
require 'capistrano/setup'

# Includes default deployment tasks
require 'capistrano/deploy'

# Includes tasks from other gems included in your Gemfile
require 'capistrano/composer'

# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.
Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

# Load DSL and Setup Up Stages

require 'capistrano/setup'

# Includes default deployment tasks

require 'capistrano/deploy'

# Includes tasks from other gems included in your Gemfile

require 'capistrano/composer'

# Loads custom tasks from `lib/capistrano/tasks' if you have any defined.

Dir.glob('lib/capistrano/tasks/*.rake').each { |r| import r }

Capistrano のデプロイ・スクリプトを作成

後は、Capistrano 用のデプロイスクリプトを作成します。作成済みの config/deploy.rb および config/deploy/production.rb を編集する。

config/deploy.rb

set :application, 'cakeapp'
set :repo_url, 'repo_url'

set :deploy_to, '/path/to/cakeapp'
set :scm, :git

set :linked_files, %w{config/secrets.yml config/app.php config/environments/production.php}
set :linked_dirs, %w{logs tmp vendor}

set :default_env, { path: "/usr/local/bin:$PATH" }
set :keep_releases, 5

set :composer_install_flags, '--no-dev --prefer-dist --no-interaction --optimize-autoloader'
SSHKit.config.command_map[:composer] = "/usr/local/bin/composer"

namespace :deploy do
  # upload files
  desc 'Upload files'
  task :upload do
    on roles(:app) do |host|
      if test "[ ! -d #{shared_path}/config ]"
        execute "mkdir -p #{shared_path}/config"
      end
      if test "[ ! -d #{shared_path}/config/environments ]"
        execute "mkdir -p #{shared_path}/config/environments"
      end

      upload!('config/secrets.yml', "#{shared_path}/config/secrets.yml")
      upload!('config/app.php', "#{shared_path}/config/app.php")
      upload!('config/environments/production.php', "#{shared_path}/config/environments/production.php")
    end
  end

  desc 'Restart application'
  task :restart do
    on roles(:app), in: :sequence, wait: 5 do
      # Your restart mechanism here, for example:
      # execute :touch, release_path.join('tmp/restart.txt')
    end
  end

  after :restart, :clear_cache do
    on roles(:web), in: :groups, limit: 3, wait: 10 do
      # Here we can do anything such as:
      # within release_path do
      #   execute :rake, 'cache:clear'
      # end
    end
  end

  namespace :migrations do
    desc "execute migration"
    task :migrate do
      on roles(:app) do |host|
        execute "cd #{current_path}; bin/cake migrations migrate"
      end
    end

    desc "rollback migration"
    task :rollback do
      on roles(:app) do |host|
        execute "cd #{current_path}; bin/cake migrations rollback"
      end
    end
  end

  after 'deploy:publishing', "deploy:migrations:migrate"
  after 'deploy:finishing', 'deploy:cleanup'
end

set :application, 'cakeapp'

set :repo_url, 'repo_url'

set :deploy_to, '/path/to/cakeapp'

set :scm, :git

set :linked_files, %w{config/secrets.yml config/app.php config/environments/production.php}

set :linked_dirs, %w{logs tmp vendor}

set :default_env, { path: "/usr/local/bin:$PATH" }

set :keep_releases, 5

set :composer_install_flags, '--no-dev --prefer-dist --no-interaction --optimize-autoloader'

SSHKit.config.command_map[:composer] = "/usr/local/bin/composer"

namespace :deploy do

# upload files

desc 'Upload files'

task :upload do

on roles(:app) do |host|

if test "[ ! -d #{shared_path}/config ]"

execute "mkdir -p #{shared_path}/config"

end

if test "[ ! -d #{shared_path}/config/environments ]"

execute "mkdir -p #{shared_path}/config/environments"

end

upload!('config/secrets.yml', "#{shared_path}/config/secrets.yml")

upload!('config/app.php', "#{shared_path}/config/app.php")

upload!('config/environments/production.php', "#{shared_path}/config/environments/production.php")

end

desc 'Restart application'

task :restart do

on roles(:app), in: :sequence, wait: 5 do

# Your restart mechanism here, for example:

# execute :touch, release_path.join('tmp/restart.txt')

end

after :restart, :clear_cache do

on roles(:web), in: :groups, limit: 3, wait: 10 do

# Here we can do anything such as:

# within release_path do

# execute :rake, 'cache:clear'

# end

end

namespace :migrations do

desc "execute migration"

task :migrate do

on roles(:app) do |host|

execute "cd #{current_path}; bin/cake migrations migrate"

end

desc "rollback migration"

task :rollback do

on roles(:app) do |host|

execute "cd #{current_path}; bin/cake migrations rollback"

end

after 'deploy:publishing', "deploy:migrations:migrate"

after 'deploy:finishing', 'deploy:cleanup'

end

ファイルアップロード用のタスク（deploy:upload）、マイグレーション実行用のタスク（deploy:migrations:migrate）とロールバック用のタスク（deploy:migrations:rollback）などを作成しました。

after 'deploy:publishing', "deploy:migrations:migrate"

1	after 'deploy:publishing', "deploy:migrations:migrate"

の行により、マイグレーションのタスク（deploy:migrations:migrate）は、deploy:publishing の後に自動で実行される設定です。

環境ごとの role を config/deploy/production.rb に設定します。

config/deploy/production.rb

set :stage, :production

role :app, %w{username@example.com}
role :web, %w{username@example.com}
role :db,  %w{username@example.com}

set :stage, :production

role :app, %w{username@example.com}

role :web, %w{username@example.com}

role :db, %w{username@example.com}

以上で、デプロイスクリプトは完成です。

デプロイ関連のコマンド

デプロイが上手く動作するかの事前チェック。


$ bundle exec cap production deploy:check

$ bundle exec cap production deploy:check

ファイルのアップロード。


$ bundle exec cap production deploy:upload

$ bundle exec cap production deploy:upload

デプロイ実行。


$ bundle exec cap production deploy

$ bundle exec cap production deploy

上記のデプロイ関連コマンドを必要に応じて使います。

その他遭遇した問題と対処法

デプロイ先サーバーに Composer が入っていなかったら、前もってインストールしておきます。


$ cd /var/tmp
$ curl -sS https://getcomposer.org/installer | php
$ mv composer.phar /usr/local/bin/composer

$ cd /var/tmp

$ curl -sS https://getcomposer.org/installer | php

$ mv composer.phar /usr/local/bin/composer

デプロイ時に次のエラーが出た場合は…


Composer should be invoked via the CLI version of PHP, not the cgi-fcgi SAPI

Composer should be invoked via the CLI version of PHP, not the cgi-fcgi SAPI

Composer インストールを以下のようにします。


$ cd /var/tmp
$ curl -sS https://getcomposer.org/installer | php
$ mv composer.phar /usr/local/
$ cd /usr/local/bin/
$ vi composer
#!/usr/bin/env bash
/usr/bin/env php-cli -d allow_url_fopen=On -d detect_unicode=Off /usr/local/composer.phar $*
$ chmode 755 composer