Capistrano3 の履歴(No.5)

Tag: Capistrano3

目次†

目次
関連ページ
参考情報
基本的な使用方法
Capistrano3系との違い
- 設定値
Tips
- deploy_via:copyしたい
FAQ
- ロールってなに?
- 設定ファイルの、role、serverの意味ってなに?
トラブルシューティング
- デプロイ後にassetsがプリコンパイルされない

↑

参考情報†

↑

基本的な使用方法†

以下bundle経由で使用する方法を説明する。

↑

インストール†

Gemfileを編集し以下を追加。基本は"capistrano"だけだが、railsの処理を行ったり、rbenvの処理を行ったり、bundleを実行したりする場合追加のgemが必要となる。
```
group :deployment do
  gem 'capistrano'
  gem 'capistrano-rails'
  gem 'capistrano-rbenv'
  gem 'capistrano-bundler'
end
```
gemのインストール
```
bundle install --path vendor/bundle
```

↑

設定ファイルの作成†

プロジェクトフォルダに移動し、「cap install」を実行

 $ cd myproject
 $ 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
Capified

↑

設定ファイルの編集†

↑

Capfile†

Capfileでは使用するモジュールをrequireする。他のファイルでrequireしてもうまくいかなかったりするの注意。

# 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
#
# For documentation on these, see for example:
#
#   https://github.com/capistrano/rvm
#   https://github.com/capistrano/rbenv
#   https://github.com/capistrano/chruby
#   https://github.com/capistrano/bundler
#   https://github.com/capistrano/rails
#
# require 'capistrano/rvm'
require 'capistrano/rbenv'
# require 'capistrano/chruby'
require 'capistrano/bundler'
require 'capistrano/rails/assets'
#require 'capistrano/rails/migrations'

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

↑

config/deploy/production.rbの編集†

production環境に関する設定を行う。role、server、ssh_optionsの設定あたり。

↑

config/deploy.rbの編集†

PENDING

↑

Capistrano3系との違い†

↑

設定値†

:repositoryが:repo_urlに。
ssh_optionsの指定方法が。

↑

Tips†

↑

deploy_via:copyしたい†

デフォルトではできなくなっているので、Capistrano3 で deploy_via :copy する - Qiitaを参考にする。

Gemfileにrubyzipを追加。

group :deployment do
  gem 'capistrano', '~> 3.0', require: false
  gem 'rubyzip', require: false
end

lib/capistrano/tasks/copy.rakeを作成。上記リンクからちょっとカスタマイズ。

require 'zip'

Zip.setup do |c|
  c.unicode_names = true
  c.on_exists_proc = true
  c.continue_on_exists_proc = true
end

namespace :copy do
  task :check do
  end

  task :set_current_revision do
  end

  task create_release: 'release.zip' do |t|
    file = t.prerequisites.first
    on roles(:app) do
      execute :mkdir, '-p', fetch(:tmp_dir)
      upload! file, fetch(:tmp_dir)
      execute :unzip, '-o', "#{fetch(:tmp_dir)}/release.zip", '-d', release_path
    end
    File.delete file if File.exists?(file)
  end

  file 'release.zip' do |t|
    release_filename = File.join(Dir.pwd, t.name)

    Dir.chdir fetch(:copy_dir) do
      Zip::File.open(release_filename, Zip::File::CREATE) do |zipfile|
        files = FileList['**/*']
        files.exclude(*fetch(:copy_exclude)).each do |file|
          zipfile.add(file, file)
        end
      end
    end
  end
end

deploy.rbを編集して完了。

set :scm, 'copy'
set :copy_dir, '.'
set :tmp_dir, '/tmp'
set :copy_exclude, [ /\.log$/, %r!^files/.+! ]

copy_excludeのパターンは、 Rake::FileListの、excludeで指定できるパターン。class Rake::FileList。パターンとして正規表現、グロブパターン、文字列が使用可能。
FileList['**/*']はプロジェクトルートからの相対パスを返してくるので、例えば railsプロジェクトの、logs、vendor以下を除外したい場合、以下のように指定するとよさそう。
```
  set :copy_exclude, [ 
                      /^logs/,
                      /^tmp/,
                      /^vendor/
                     ]
```
ドットファイル(.で始まるファイル)がコピーされないけど、それはそれでいいのか?(特にruby-versionとか)。

↑

FAQ†

↑

ロールってなに?†

サーバーごとに役割を設定するもの。Rails - はじめてのCapistrano - Qiitaの説明がわかりやすいかも。Capistrano3もCapistrano2も考え方に大差はない。
Capistranoではタスクは、デフォルトでは全ロール、全サーバーに対して実行できる。タスクに対し例えばwebロールを割り当てると、webロールのサーバーに対してしか処理が行われなくなる。

↑

設定ファイルの、role、serverの意味ってなに?†

cap installで以下のような設定ファイルが作成される。

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


# Extended Server Syntax
# ======================
# This can be used to drop a more detailed server definition into the
# server list. The second argument is a, or duck-types, Hash and is
# used to set extended properties on the server.

server 'example.com', user: 'deploy', roles: %w{web app}, my_property: :my_value

コメントによると、roleは、ロールとサーバーの簡易同時設定。serverはサーバーの詳細設定(既存ロール使用)といったイメージか。

↑

トラブルシューティング†

↑

デプロイ後にassetsがプリコンパイルされない†

Capfileでrequire 'capistrano/rails/assets'が有効になっているかどうか確認する。