読者です 読者をやめる 読者になる 読者になる

Railsアプリを簡単にメンテナンス表示するにはturnout(+capistrano+whenever)が便利かもです

Railsアプリをメンテナンス表示にしたい時、みなさんどうされているのでしょうか。大規模サービスであればリバースプロキシでメンテ状態にするのが今風かもしれませんが、もっとお手軽にメンテナンスにしたいときはアプリケーション側でやってもいいかもしれません。

メンテナンス表示にする

turnoutというgemを使うと簡単そうです。

Gemfile

gem 'turnout'

tmp/maintenance.ymlというファイルがあればメンテナンス表示されます。 コメントとか許可するIPとかを書けるようです。

tmp/maintenance.yml

reason: 終了予定時間は 8/1 5:00 を予定しております。
allowed_ips:
  - 1.2.3.4

これだけでまずは全ページメンテナンスに出来ました。reasonに書いた文字列が表示されています。

f:id:kimromi:20160715142643p:plain

メンテナンス中の表示をカスタマイズしたい場合は、public/maintenance.htmlを置いておけばそのHTMLが表示されます。{{ reason }}と書いておくとyamlファイルで設定したreasonが展開されます。

public/maintenance.html

<!DOCTYPE html>
<html>
    <head>
        <meta charset="UTF-8">
        <style type="text/css">
        <!--
        h1 { color: red; }
        -->
        </style>
    </head>
    <body>
    <h1>現在メンテナンス中です。</h1>
    <p>{{ reason }}</p>
    </body>
</html>

f:id:kimromi:20160715142651p:plain

簡単。

capistranoのタスクでメンテナンスの開始/終了を切り替える

まずは先程のyamlファイルをconfig/にでも置いておきましょう。

config/maintenance.yml

reason: 終了予定時間は 8/1 5:00 を予定しております。
allowed_ips:
  - 1.2.3.4

capistranoのタスクを書きます。

lib/capistrano/tasks/maintenance.rake

namespace :maintenance do
  desc 'メンテナンス開始'
  task :start do
    on roles(:web), in: :sequence do
      within current_path do
        # tmp/maintenance.ymlがなければ config/ から tmp/ にコピーする
        unless test(:test, "-f tmp/maintenance.yml")
          execute :cp, 'config/maintenance.yml tmp/maintenance.yml'
        end
      end
    end
  end

  desc 'メンテナンス終了'
  task :finish do
    on roles(:web), in: :sequence do
      within current_path do
        # tmp/maintenance.ymlがあれば削除する
        if test(:test, "-f tmp/maintenance.yml")
          execute :rm, 'tmp/maintenance.yml'
        end
      end
    end
  end
end

上のように定義しておくと

bundle exec cap production maintenance:start   # メンテナンス開始
bundle exec cap production maintenance:finish  # メンテナンス終了

のコマンド一発で開始/終了を切り替えられます!やった!

メンテナンスタイマーを仕込みたい

whenever gemでcronを仕込みましょう。やり方は同じです。指定した時刻にtmp/maintenance.ymlを置いたり消したりするだけです。

Gemfile

gem 'whenever', require: false

config/schedule.rb

set :output, "#{Whenever.path}/log/cron.log"
set :environment, :production
set :path, '/path/to/app/current'

# メンテナンス開始 (8/1 0:00)
every '00 00 1 8 *' do
  # config/maintenance.yml (copy ->) tmp/maintenance.yml
  command "cp #{Whenever.path}/config/maintenance.yml #{Whenever.path}/tmp/maintenance.yml"
end

# メンテナンス終了 (8/1 3:00)
every '00 03 1 8 *' do
  # remove tmp/maintenance.yml
  command "rm #{Whenever.path}/tmp/maintenance.yml"
end

あとはcapistranoでデプロイするときにwheneverを実行させましょう。

Capfile

require 'whenever/capistrano'

config/deploy.rb

set :whenever_identifier, ->{ "#{fetch(:application)}_#{fetch(:stage)}" }
set :whenever_roles,      ->{ :cron }

config/deploy/production.rb

role :cron, %w(sshuser@app.server.com)

これでcapistranoでデプロイしたときにデプロイユーザにcrontabがつくので指定した時刻に実行されます!よい!

終わりに

unicornとかミドルウェアによっては再起動が必要と思うので、都度再起動をするような命令を入れておけば良さそうです。

アプリケーションまでアクセスすらきてほしくない時はこの方法ではダメなのでもっと手前のレイヤーでメンテナンス状態にしてください。

まぁでもcronって定期的に何かを実行させたりするやつなんでこういう1回きりのタイマーに使っていいのかというのもあるので、なんかいい案があれば教えてください!