具体的には以下のブランチのRails7.2を起動する方法を記載していきます。

GitHub - rails/rails at 7-2-stable

Ruby on Rails. Contribute to rails/rails development by creating an account on GitHub.

github.com

Railsプロジェクト作成

まず、以下のコマンドで新しいRailsプロジェクトを作成し、そのプロジェクトディレクトリに移動します。

rails new test_app

cd test_app/

次に、Railsのバージョンを確認します。

rails -v

Rails 7.1.3.3

この時点では、Rails 7.1系がインストールされているはずです。

Rails7.2へアップデート

Rails 7.2にアップデートするために、Gemファイルを修正します。

vi Gemfile

以下の内容でGemfileを修正します。

#gem "rails", "~> 7.1.3", ">= 7.1.3.3"     #コメントアウト

gem "rails", github: "rails/rails", branch: "7-2-stable"     #これを追加

次に、以下のコマンドでRails 7.2にアップデートします。

bundle install

動作確認

最後に、以下のコマンドでサーバを立ち上げます。

rails server

ブラウザでhttp://localhost:3000/にアクセスし、「Rails version: 7.2.0」と表示されていれば成功です。

以上で、Rails 7.2のインストールと起動が完了です。

まとめ

以下のブランチを指定して、Rails7.2を起動する方法を記載しました！

GitHub - rails/rails at 7-2-stable

Ruby on Rails. Contribute to rails/rails development by creating an account on GitHub.

github.com

以下の順で進めていきます。今回はとりあえずFargate上で動くことをゴールにしますので、MySQLは使いません。

1. ローカルでRails7.1を立ち上げる
2. ECR(Amazon Elastic Container Registry)にRailsイメージをpushする
3. ECRのイメージを使って、ECS(Amazon Elastic Container Service)-Fagateにデプロイ

まずは、ローカルでRails7.1を起動していきます。

ローカルでRialsを動かしてみる

アプリケーションの作成

以下のコマンドでアプリケーションを作成して、作成したアプリケーションのフォルダに移動します。

rails new test_app

cd test_app/

まずはDockerfileを修正します。

Dockerfileの修正

Rails newで作成されたDockerfileを修正します。

vi Dockerfile

以下の2点変更します。

<変更①>「ENV RAILS_ENV="production"」をコメントアウトして、「ENV RAILS_ENV=$ENVIROMENTS」を追記します。
#ENV RAILS_ENV="production" \
ENV RAILS_ENV=$ENVIROMENTS \
<変更②>
5行目のFORMの後に以下を追加
ARG ENVIROMENTS

上記変更を加えることで、Railsを以下の指定をして、起動できるようになります。

• production
• development
• tesst

コンテナを立ち上げて動作確認

以下のコマンドでビルドします。

docker build . -t test_app --build-arg ENVIROMENTS='development'

以下のコマンドでコンテナを起動します。

docker run -it -p 3000:3000 --env RAILS_MASTER_KEY=`cat config/master.key` test_app bin/rails server -b 0.0.0.0

http://localhost:3000/にアクセスし、以下の画面が表示されれば、動作確認OKー

ECR(Amazon Elastic Container Registry)にRailsイメージをpush

以下のコマンドで、AWSの接続設定をしておきます。

aws configure

次にECRログインします。

aws ecr get-login-password --region ap-northeast-1 | docker login --username AWS --password-stdin {AWSアカウントID}.dkr.ecr.ap-northeast-1.amazonaws.com

以下のコマンドでリポジトリを作成します。

aws ecr create-repository \
        --repository-name rails \
        --image-scanning-configuration scanOnPush=true \
        --region ap-northeast-1 

Railsアプリのタグ作成します

docker tag test_app:latest {AWSアカウントID}.dkr.ecr.ap-northeast-1.amazonaws.com/rails:latest

Railsアプリのpushです

docker push {AWSアカウントID}.dkr.ecr.ap-northeast-1.amazonaws.com/rails:latest

 

次に、Fagateにデプロイします！

ECS(Amazon Elastic Container Service)-Fagateにデプロイ

クラスターの作成

以下の設定で作成します。指定箇所以外は任意の値で大丈夫です。

• インフラストラクチャ：AWS Fargate (サーバーレス)

タスク定義の作成

以下の設定で作成します。指定箇所以外は任意の値で大丈夫です。

• インフラストラクチャの要件
  • 起動タイプ：AWS Fargate
  • オペレーティングシステム/アーキテクチャ：自分のPCと一致するもの(基本はx86_64でOK、M1/M2 MacはARM64を選択)
    • この設定に誤りがあると「exec /usr/local/bin/start-container: exec format error」エラーになります。
  • タスクサイズ
    • CPU：.5 vCPU
    • メモリ：1GB
• コンテナ – 1
  • 名前：app
  • イメージURI：{AWSアカウントID}.dkr.ecr.ap-northeast-1.amazonaws.com/rails:latest
  • コンテナポート:3000
  • アプリケーションプロトコル:HTTP
  • 環境変数
    • キー：RAILS_MASTER_KEY
    • 値：「config/master.key」の値を直接入力
      • 「cat config/master.key」を入力すると「ArgumentError: key must be 16 bytes (ArgumentError)」エラーになる
  • Docker設定
    • コマンドに以下を設定
      • /rails/bin/rails,server,-b,0.0.0.0

タスク起動

作成したクラスターのタスクタブにある「新しいタスクの実行」を押下

• コンピューティング設定：起動タイプ
• デプロイ設定
  • ファミリー:先ほど作成したタスクを設定
  • リビジョン：最新
• ネットワーキング
  • セキュリティグループ：ポート3000の許可を追加

動作確認

作成したクラスターのタスクタブの任意のタスクの詳細を開きます。

パブリックIPが表示されるので、http://パブリックIP:3000でブラウザからアクセスします。

以下の画面が表示されればOKです。

PC上で直接動かし、その後にDockerコンテナ上で動かしてみます。

コンテナでは、rails newで作成された公式のDockerfileを使用していきます。

Ruby・Railsのインストールから始めていきます！

Ruby/Railsのインストール

Rubyインストール

• rbenvをインストールする

brew install rbenv

• rbenvからインストールできるRubyのバージョンを確認する

rbenv install -l

• リスト内から最新バージョンを確認して，Rubyをインストールする（ここでは3.3.1をインストールします）

rbenv install 3.3.1
rbenv global 3.3.1

• rbenvのRubyに切り替えます

export PATH="$HOME/.rbenv/bin:$PATH"
eval "$(rbenv init -)"
source ~/.zprofile

Railsインストール

• Railsをインストールします

sudo gem install rails

rails --version

Rails 7.1.3.3

Rails7.1がインストールできました。

アプリケーションの作成

以下のコマンドでアプリケーションを作成して、作成したアプリケーションのフォルダに移動します。

rails new test_app

cd test_app/

ローカルでRialsを動かしてみる

以下のコマンドでRailsサーバーを立ち上げます。

bin/rails server

http://localhost:3000/にアクセスし、以下の画面が表示されれば、動作確認OKー

PC上にdockerコンテナを立ち上げ、その上でRailsを動かす

dockerコンテナを立ち上げ、その上でRailsを動かします。

まずはDockerfileを修正します。

Dockerfileの修正

Rails newで作成されたDockerfileを修正します。

vi Dockerfile

以下の2点変更します。

<変更①>「ENV RAILS_ENV="production"」をコメントアウトして、「ENV RAILS_ENV=$ENVIROMENTS」を追記します。
#ENV RAILS_ENV="production" \
ENV RAILS_ENV=$ENVIROMENTS \
<変更②>
5行目のFORMの後に以下を追加
ARG ENVIROMENTS

上記変更を加えることで、Railsを以下の指定をして、起動できるようになります。

• production
• development
• tesst

コンテナを立ち上げて動作確認

以下のコマンドでビルドします。

docker build . -t test_app --build-arg ENVIROMENTS='development'

以下のコマンドでコンテナを起動します。

docker run -it -p 3000:3000 --env RAILS_MASTER_KEY=`cat config/master.key` test_app bin/rails server -b 0.0.0.0

http://localhost:3000/にアクセスし、以下の画面が表示されれば、動作確認OKー

docker composeを使ってみる

docker composeで以下の3つのコンテナを立ち上げてみます。

•  DBコンテナ
  • MySQL8
• appコンテナ
  • Rails7.1
• phpmyadmin
  • 最新のphpmyadmin

Rails アプリの作成

以下のコマンドでRailsアプリを作成します。

rails new . --force --database=mysql

Dockerfileの修正

Rails newで作成されたDockerfileを修正します。

vi Dockerfile

以下の2点変更します。

<変更①>「ENV RAILS_ENV="production"」をコメントアウトして、「ENV RAILS_ENV=$ENVIROMENTS」を追記します。
#ENV RAILS_ENV="production" \
ENV RAILS_ENV=$ENVIROMENTS \
<変更②>
5行目のFORMの後に以下を追加
ARG ENVIROMENTS

上記変更を加えることで、Railsを以下の指定をして、起動できるようになります。

• production
• development
• tesst

docker-compose.ymlの作成

以下の通り作成します。

vi docker-compose.yml

＜ファイルの中身＞

version: "3"
services:
  app:
    container_name: app_rails
    build:
      args:
        ENVIROMENTS: development
        RAILS_MASTER_KEY: 'cat config/master.key'
    command: bin/rails server -b 0.0.0.0
    volumes:
      - .:/rails
    ports:
      - 80:3000
    tty: true
    stdin_open: true
    depends_on:
      - db
  db:
    image: mysql:8.0.28
    container_name: db
    environment: 
      MYSQL_ROOT_PASSWORD: password
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    volumes:  
      - ./docker/db/data:/var/lib/mysql
    ports:
      - 3306:3306
  phpmyadmin:
    container_name: test_phpmyadmin
    image: phpmyadmin
    environment:
    - PMA_USER=root
    - PMA_PASSWORD=password
    ports:
    - 8080:80
    depends_on:
      - db

DB設定ファイルの修正

vi config/database.yml

＜ファイルの中身＞

default: &default
  adapter: mysql2
  encoding: utf8mb4
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: root
  password: password
  host: db

development:
  <<: *default
  database: test4_development

動作確認

以下のコマンドでコンテナを立ち上げます。

docker compose up

以下のコマンドでDB作成します。

docker-compose run app bin/rails db:create

http://localhost:3000/にアクセスし、以下の画面が表示されれば、動作確認OKー

アプリコンテナのOSを確認してみる

以下のコマンドでOSを確認してみました。

docker compose exec app bash

cat /etc/os-release

PRETTY_NAME="Debian GNU/Linux 12 (bookworm)"
NAME="Debian GNU/Linux"
VERSION_ID="12"
VERSION="12 (bookworm)"
VERSION_CODENAME=bookworm
ID=debian
HOME_URL="https://www.debian.org/"
SUPPORT_URL="https://www.debian.org/support"
BUG_REPORT_URL="https://bugs.debian.org/"

Debian12が使われているようです。

rails newで作成された公式のDockerfileでは、Debian12が使われているようです…!

Rails7.1へアップデートする場合、Ransack はバージョン4にアップデートする必要があります。

Ransackが古い状態だと以下のエラーになります。

NoMethodError: undefined method `table_name' for

Ransack 4の更新内容

検索・ソートできるDB項目を制限する機能が追加されました。

そのため、Ransackをアップデートすると、検索・ソートできる項目を指定する必要があります。

検索・ソートできる項目を指定しないとエラーになりますが、項目を指定するのは、かなり手間です。

かなり手間なので、簡単な対応方法を記載します。

Ransack 4に簡単に対応する方法

ApplicationRecordクラスに以下のコードを記載するとエラーは消え、今まで通り使えます！

  def self.ransackable_attributes(auth_object = nil)
    # 全ての列を検索可能にする
    authorizable_ransackable_attributes
  end
  def self.ransackable_associations(auth_object = nil)
    # 全ての関連テーブルを検索可能にする
    authorizable_ransackable_associations
  end

本来であれば、検索・ソートできる項目を指定していくのが良いと思いますが、既存アプリのアップデートで時間がない場合など、簡単にRansack 4に対応させたい時は、上記の方法で、今まで通り使えるようになります。

具体的には

• リトライ
• サーバプロセスが落ちると、jobのデータは失われる
• メモリ肥大化する問題
• 並列実行数制御

について記載します。

Sidekiqを正しく理解して安全に使おう！という記事になります。

まずはSidekiqとは？について記載していきます。

Sidekiqとは

 Railsで非同期処理を行うためのgemです。複数の非同期処理を同時に実行することができ、サーバリソースを有効活用できます。

以下、処理イメージです。

1. Rails WEBサーバがリクエストを受け付ける
2. Rails WEBサーバは非同期でしたい処理をRedisにjobとして格納する
3. Sidekiqが動いているサーバがRedisからjobを取得する
4. Sidekiqはjobの内容にしたがって処理を実行する

Simple, efficient background jobs for Ruby

Sidekiq is a simple, efficient framework for background jobs in Ruby

sidekiq.org

AWS SQSと連携させて、非同期処理を行うShoryukenというgemもあります。

[注意点①]プログラムで例外発生時は、リトライされる

デフォルトのリトライの仕様は以下の通りとなります。約21日間リトライが行われます。

リトライ回数：25回

リトライの間隔：リトライ回数の4乗＋15秒間隔くらい。正確な計算式は以下の通り

(retry_count ** 4) + 15 + (rand(10) * (retry_count + 1))

Error Handling

Simple, efficient background processing for Ruby. Contribute to sidekiq/sidekiq development by creating an account on GitHub.

github.com

リトライで解消する可能性がある場合は、リトライは有効かと思いますが、何度リトライしても失敗するようなエラーの場合はサーバ負荷をかけるだけなので、リトライさせないようにしておくと良さそうです。

リトライ回数をデフォルトから変更するなど、リトライ時の処理を設計して実装しておきましょ！

[注意点②]サーバプロセスが落ちると、jobのデータは失われる

サーバプロセスが落ちると、jobのデータは失われてしまいます。

Sidekiq Pro(Sidekiqの有料版)のsuper_fetchを使用すると、サーバプロセスが落ちてもjobデータが失われなくなりますので、Sidekiq Proを検討しましょ

Reliability

Simple, efficient background processing for Ruby. Contribute to sidekiq/sidekiq development by creating an account on GitHub.

github.com

または、Sidekiqをやめて、Shoryukenの検討をしましょ。

ShoryukenではSQSを使用しますが、サーバプロセスが落ちてもSQSのデータ失われないためです。

[注意点③]メモリ肥大化する問題

大量のメモリを消費する問題があります。

メモリの問題に関しては、以下の記事を参考に設定を変更して対応しましょ

Ruby: mallocでマルチスレッドプログラムのメモリが倍増する理由（翻訳）｜TechRacho by BPS株式会社

概要 原著者の許諾を得て翻訳・公開いたします。 英語記事: Malloc Can Double Multi-threaded Ruby Program Memory Usage 原文公開日: 2017/12/04 著者: Nate Berkopec -- 『Complete Guide to Rails Perform...

techracho.bpsinc.jp

[注意点④]並列実行数制御

大量に同時実行するとインフラ負荷がかかりすぎる場合、並列実行数制御をしましょ！

インフラ負荷とは以下のようなイメージでいます。

• 大量に同時実行すると
  • Sidekiqが動いているサーバに負荷がかかる
  • DBに負荷がかかる

並列実行数制御にはsidekiq-limit_fetch というgemを使います。

sidekiq-limit_fetch | RubyGems.org | コミュニティのgemホスティングサービス

rubygems.org

注意点として、Sidekiq Proを使用している場合、sidekiq-limit_fetchは正常に動作しないので要注意です。

GitHub - deanpcmad/sidekiq-limit_fetch: A Sidekiq plugin to support advanced queue control (limiting, pausing, blocking, querying)

A Sidekiq plugin to support advanced queue control (limiting, pausing, blocking, querying) - deanpcmad/sidekiq-limit_fetch

github.com

Sidekiq Proを使用している場合は

• Sidekiq Enterpriseの導入を検討する
• 自分で並列実行数を制御するプログラムを作成する
  • 以下のようなイメージです
    • 「Sidekiq::Workers.new」で実行中のjobを取得し、並列実行数をチェックする
      • 並列実行数をチェックした結果、処理実行して良い場合、そのまま処理実行
      • 並列実行数をチェックした結果、並列実行の上限を超えている場合、「perform_later」でjobをredisに戻し、処理を終了する

まとめ

Sidekiqを使用する際の注意点について記載しました。

まとめると

• リトライ
  • リトライ回数を意識して設計しましょ
• サーバプロセスが落ちると、jobのデータは失われる
  • Sidekiq Proを検討しましょ
• メモリ肥大化する問題
  • メモリに関する設定を見直しましょ

ということです★