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

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

Ruby

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回きりのタイマーに使っていいのかというのもあるので、なんかいい案があれば教えてください!

Capistranoでデプロイした時にGithubのどのPullRequestをリリースしたかをSlackに通知する

Ruby

f:id:kimromi:20160709032809j:plain

上のような感じで、Capistranoでデプロイした時にどのPullRequestがリリースされたかをSlackに通知するGemを作りました。

github.com

Capistrano v3 のみ対応です。masterブランチにマージされた最新のPullRequestを取得して通知しますので、デプロイするときは一旦masterブランチに切り替えてgit pullしてからデプロイすると間違いないです。

@linyows さんが作ったcapistrano-github-releasescapistrano-slack_notificationに完全に依存しています。ありがとうございます!

セットアップ

Gemfile

gem 'capistrano-releases-notification'

Capfile

require 'capistrano/github/releases'        # 依存
require 'capistrano/slack_notification'     # 依存
require 'capistrano/releases/notification'

config/deploy.rb

# slack webhook
set :slack_endpoint, 'https://hooks.slack.com'
set :slack_path, '/services/xxxxxxxxx/yyyyyyyyy/zzzzzzzzzzzzzzzzzzzzzzz'

# slack通知設定
set :release_notify_channel, ['#general']   # 通知チャンネル名(複数指定可)
set :release_notify_mention, ['@kimromi']   # メンション(複数指定可)

# Github Enterpriseの場合
Octokit.configure do |c|
  c.api_endpoint = 'http://your.enterprise.domain/api/v3'
  c.web_endpoint = 'http://your.enterprise.domain/'
end

config/deploy/production.rb

# デプロイ終了後に通知する設定
after 'deploy:finishing', 'release:notify'

必要なstageで追加してください。

使いみち

メッセージやタイトルも編集できますので、我がムームードメインではカスタマーサービスチームにメンションを飛ばして何がリリースされたかを通知して共有するようにしています。下の例ではPullRequestの内容まで取得しています。

f:id:kimromi:20160709032819j:plain

set :release_notify_mention, ['@cs']
set :release_notify_title, 'ムームードメイン'
set :release_notify_message, -> {
  "リリースしました。 #{fetch(:release_notify_mention).join(' ')}"
}
set :release_notify_attachment, -> {
  pull_request = Octokit.pull(fetch(:github_repo), fetch(:pull_request_id))
  [
    pull_request.title,
    pull_request.html_url,
    '------------',
    pull_request.body[0, 200]
  ].join("\n")
}

お試しあれ〜