DockerComposeを使用した開発のためのRubyonRailsアプリケーションのコンテナー化

序章

アプリケーションを積極的に開発している場合は、 Docker を使用すると、ワークフローとアプリケーションを本番環境にデプロイするプロセスを簡素化できます。開発中のコンテナを使用すると、次の利点があります。

環境は一貫しています。つまり、システムの競合を心配することなく、プロジェクトに必要な言語と依存関係を選択できます。
環境が分離されているため、問題のトラブルシューティングや新しいチームメンバーの参加が容易になります。
環境は移植可能であり、コードをパッケージ化して他の人と共有することができます。

このチュートリアルでは、Dockerを使用して Ruby onRailsアプリケーションの開発環境をセットアップする方法を説明します。 Docker Compose を使用して、アプリケーション自体、 PostgreSQL データベース、 Redis 、およびSidekiqサービス用に複数のコンテナーを作成します。セットアップは次のことを行います。

ホスト上のアプリケーションコードをコンテナ内のコードと同期して、開発中の変更を容易にします。
コンテナの再起動間でアプリケーションデータを保持します。
期待どおりにジョブを処理するようにSidekiqワーカーを構成します。

このチュートリアルの最後に、Dockerコンテナで実行されている動作するサメ情報アプリケーションがあります。

前提条件

このチュートリアルに従うには、次のものが必要です。

Ubuntu 18.04を実行しているローカル開発マシンまたはサーバー、およびsudo特権とアクティブなファイアウォールを持つ非rootユーザー。これらの設定方法のガイダンスについては、この初期サーバー設定ガイドを参照してください。
Ubuntu18.04にDockerをインストールして使用する方法の手順1と2に従ってローカルマシンまたはサーバーにDockerをインストールします。
Ubuntu 18.04にDockerComposeをインストールする方法のステップ1に従って、ローカルマシンまたはサーバーにDockerComposeをインストールします。

ステップ1—プロジェクトのクローンを作成して依存関係を追加する

最初のステップは、 DigitalOceanCommunityGitHubアカウントからrails-sidekiqリポジトリのクローンを作成することです。このリポジトリには、既存のRails5プロジェクトにSidekiqを追加する方法を説明するRubyonRailsアプリケーションにSidekiqとRedisを追加する方法で説明されているセットアップのコードが含まれています。

リポジトリをrails-dockerというディレクトリに複製します。

git clone https://github.com/do-community/rails-sidekiq.git rails-docker

rails-dockerディレクトリに移動します。

cd rails-docker

このチュートリアルでは、PostgreSQLをデータベースとして使用します。 SQLite 3の代わりにPostgreSQLを使用するには、Gemfileにリストされているプロジェクトの依存関係に pggemを追加する必要があります。そのファイルを開いて、nanoまたはお気に入りのエディターを使用して編集します。

nano Gemfile

メインプロジェクトの依存関係（開発の依存関係の上）の任意の場所にgemを追加します。

〜/ rails-docker / Gemfile

. . . 
# Reduces boot times through caching; required in config/boot.rb
gem 'bootsnap', '>= 1.1.0', require: false
gem 'sidekiq', '~>6.0.0'
gem 'pg', '~>1.1.3'

group :development, :test do
. . .

sqlite gem はもう使用しないため、コメントアウトすることもできます。

〜/ rails-docker / Gemfile

. . . 
# Use sqlite3 as the database for Active Record
# gem 'sqlite3'
. . .

最後に、developmentの下にあるspring-watcher-listengemをコメントアウトします。

〜/ rails-docker / Gemfile

. . . 
gem 'spring'
# gem 'spring-watcher-listen', '~> 2.0.0'
. . .

このgemを無効にしないと、Railsコンソールにアクセスするときに永続的なエラーメッセージが表示されます。これらのエラーメッセージは、このgemがファイルシステムの変更をポーリングするのではなく、Railsがlistenを使用して開発の変更を監視しているという事実に由来しています。このgemは、node_modulesディレクトリを含むプロジェクトのルートを監視するため、監視されているディレクトリに関するエラーメッセージをスローし、コンソールを乱雑にします。ただし、CPUリソースの節約が心配な場合は、このgemを無効にしてもうまくいかない可能性があります。この場合、RailsアプリケーションをRails6にアップグレードすることをお勧めします。

編集が終了したら、ファイルを保存して閉じます。

プロジェクトリポジトリを配置し、pg gemをGemfileに追加し、spring-watcher-listen gemをコメントアウトすると、PostgreSQLで動作するようにアプリケーションを構成する準備が整います。

ステップ2—PostgreSQLおよびRedisで動作するようにアプリケーションを構成する

開発中のPostgreSQLとRedisを使用するには、次のことを行います。

PostgreSQLをデフォルトのアダプターとして使用するようにアプリケーションを構成します。
.envファイルを、データベースのユーザー名とパスワード、およびRedisホストを使用してプロジェクトに追加します。
init.sqlスクリプトを作成して、データベースのsammyユーザーを作成します。
Sidekiq用のinitializerを追加して、コンテナ化されたredisサービスで動作できるようにします。
.envファイルおよびその他の関連ファイルをプロジェクトのgitignoreおよびdockerignoreファイルに追加します。
データベースシードを作成して、アプリケーションの起動時に使用できるレコードがアプリケーションに含まれるようにします。

まず、config/database.ymlにあるデータベース構成ファイルを開きます。

nano config/database.yml

現在、このファイルには次のdefault設定が含まれています。これらの設定は、他の設定がない場合に適用されます。

〜/ rails-docker / config / database.yml

default: &default
  adapter: sqlite3
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000

postgresqlアダプターを使用するという事実を反映するために、これらを変更する必要があります。これは、Docker Composeを使用してPostgreSQLサービスを作成し、アプリケーションデータを永続化するためです。

SQLiteをアダプターとして設定するコードを削除し、次の設定に置き換えます。これにより、アダプターと接続に必要なその他の変数が適切に設定されます。

〜/ rails-docker / config / database.yml

default: &default
  adapter: postgresql
  encoding: unicode
  database: <%= ENV['DATABASE_NAME'] %>
  username: <%= ENV['DATABASE_USER'] %>
  password: <%= ENV['DATABASE_PASSWORD'] %>
  port: <%= ENV['DATABASE_PORT'] || '5432' %>
  host: <%= ENV['DATABASE_HOST'] %>
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  timeout: 5000
. . .

次に、development環境の設定を変更します。これは、このセットアップで使用している環境だからです。

セクションが次のようになるように、既存のSQLiteデータベース構成を削除します。

〜/ rails-docker / config / database.yml

. . . 
development:
  <<: *default
. . .

最後に、productionおよびtest環境のdatabase設定も削除します。

〜/ rails-docker / config / database.yml

. . . 
test:
  <<: *default
  
production:
  <<: *default
. . .

デフォルトのデータベース設定に対するこれらの変更により、バージョン管理にコミットされない.envファイルで定義された環境変数を使用してデータベース情報を動的に設定できるようになります。

編集が終了したら、ファイルを保存して閉じます。

Railsプロジェクトを最初から作成する場合は、 How To Use PostgreSQL with Your Ruby onのステップ3で説明されているように、rails newコマンドを使用してアダプターを設定できます。 Ubuntu18.04上のRailsアプリケーション。これにより、アダプターがconfig/database.ymlに設定され、pggemがプロジェクトに自動的に追加されます。

環境変数を参照したので、好みの設定でそれらのファイルを作成できます。この方法で構成設定を抽出することは、アプリケーション開発への 12ファクターアプローチの一部であり、分散環境でのアプリケーションの復元力のベストプラクティスを定義します。現在、本番環境とテスト環境を将来セットアップする場合、データベース設定を構成するには、追加の.envファイルを作成し、DockerComposeファイルで適切なファイルを参照する必要があります。

.envファイルを開きます。

nano .env

次の値をファイルに追加します。

〜/ rails-docker / .env

DATABASE_NAME=rails_development
DATABASE_USER=sammy
DATABASE_PASSWORD=shark
DATABASE_HOST=database
REDIS_HOST=redis

データベース名、ユーザー、パスワードの設定に加えて、DATABASE_HOSTの値も設定しました。値databaseは、DockerComposeを使用して作成するdatabasePostgreSQLサービスを指します。また、REDIS_HOSTを設定して、redisサービスを指定します。

編集が終了したら、ファイルを保存して閉じます。

sammyデータベースユーザーを作成するには、init.sqlスクリプトを記述して、起動時にデータベースコンテナーにマウントできます。

スクリプトファイルを開きます。

nano init.sql

次のコードを追加して、管理者権限を持つsammyユーザーを作成します。

〜/ rails-docker / init.sql

CREATE USER sammy;
ALTER USER sammy WITH SUPERUSER;

このスクリプトは、データベース上に適切なユーザーを作成し、このユーザーに管理者権限を付与します。

スクリプトに適切な権限を設定します。

chmod +x init.sql

次に、コンテナ化されたredisサービスと連携するようにSidekiqを構成します。イニシャライザーをconfig/initializersディレクトリーに追加できます。ここで、Railsは、フレームワークとプラグインがロードされると構成設定を検索し、Redisホストの値を設定します。

sidekiq.rbファイルを開いて、次の設定を指定します。

nano config/initializers/sidekiq.rb

次のコードをファイルに追加して、REDIS_HOSTおよびREDIS_PORTの値を指定します。

〜/ rails-docker / config / initializers / sidekiq.rb

Sidekiq.configure_server do |config|
  config.redis = {
    host: ENV['REDIS_HOST'],
    port: ENV['REDIS_PORT'] || '6379'
  }
end

Sidekiq.configure_client do |config|
  config.redis = {
    host: ENV['REDIS_HOST'],
    port: ENV['REDIS_PORT'] || '6379'
  }
end

データベース構成設定と同様に、これらの設定により、ホストとポートのパラメーターを動的に設定できるため、アプリケーションコード自体を変更することなく、実行時に適切な値に置き換えることができます。 REDIS_HOSTに加えて、他に設定されていない場合に備えて、REDIS_PORTのデフォルト値が設定されています。

編集が終了したら、ファイルを保存して閉じます。

次に、アプリケーションの機密データがバージョン管理にコピーされないようにするために、プロジェクトの.gitignoreファイルに.envを追加して、プロジェクトで無視するファイルをGitに指示します。編集用にファイルを開きます。

nano .gitignore

ファイルの最後に、.envのエントリを追加します。

〜/ rails-docker / .gitignore

yarn-debug.log*
.yarn-integrity
.env

編集が終了したら、ファイルを保存して閉じます。

次に、.dockerignoreファイルを作成して、コンテナーにコピーしないものを設定します。編集用にファイルを開きます。

.dockerignore

次のコードをファイルに追加します。これにより、Dockerは、コンテナーにコピーする必要のないものの一部を無視するようになります。

〜/ rails-docker / .dockerignore

.DS_Store
.bin
.git
.gitignore
.bundleignore
.bundle
.byebug_history
.rspec
tmp
log
test
config/deploy
public/packs
public/packs-test
node_modules
yarn-error.log
coverage/

このファイルの最後にも.envを追加します。

〜/ rails-docker / .dockerignore

. . .
yarn-error.log
coverage/
.env

編集が終了したら、ファイルを保存して閉じます。

最後のステップとして、アプリケーションを起動したときにいくつかのレコードが含まれるように、いくつかのシードデータを作成します。

dbディレクトリにあるシードデータのファイルを開きます。

nano db/seeds.rb

次のコードをファイルに追加して、4つのデモサメと1つのサンプル投稿を作成します。

〜/ rails-docker / db / seeds.rb

# Adding demo sharks
sharks = Shark.create([{ name: 'Great White', facts: 'Scary' }, { name: 'Megalodon', facts: 'Ancient' }, { name: 'Hammerhead', facts: 'Hammer-like' }, { name: 'Speartooth', facts: 'Endangered' }])
Post.create(body: 'These sharks are misunderstood', shark: sharks.first)

このシードデータは、最初のサメに関連付けられた4つのサメと1つの投稿を作成します。

編集が終了したら、ファイルを保存して閉じます。

アプリケーションがPostgreSQLで動作するように構成され、環境変数が作成されたら、アプリケーションDockerfileを作成する準備が整います。

ステップ3—Dockerfileおよびエントリポイントスクリプトの記述

Dockerfileは、作成時にアプリケーションコンテナに含まれるものを指定します。 Dockerfileを使用すると、コンテナー環境を定義し、依存関係またはランタイムバージョンとの不一致を回避できます。

最適化されたコンテナの構築に関するこれらのガイドラインに従い、アルパインベースを使用し、画像レイヤーを一般的に最小化することで、画像を可能な限り効率的にします。

現在のディレクトリでDockerfileを開きます。

nano Dockerfile

Dockerイメージは、相互に構築される一連のレイヤードイメージを使用して作成されます。最初のステップは、アプリケーションのベースイメージを追加することです。これにより、アプリケーションビルドの開始点が形成されます。

次のコードをファイルに追加して、 Ruby alpineimageをベースとして追加します。

〜/ rails-docker / Dockerfile

FROM ruby:2.5.1-alpine

alpineイメージは、Alpine Linuxプロジェクトから派生したものであり、イメージサイズを小さく抑えるのに役立ちます。 alpineイメージがプロジェクトに適しているかどうかの詳細については、 DockerHubRubyイメージページのImageVariantsセクションの詳細な説明を参照してください[ X210X]。

開発でalpineを使用する際に考慮すべきいくつかの要因：

画像サイズを小さくすると、特にボリュームを最小限に抑える場合は、ページとリソースの読み込み時間が短縮されます。これにより、開発におけるユーザーエクスペリエンスを迅速に保ち、コンテナ化されていない環境でローカルで作業している場合のエクスペリエンスに近づけることができます。
開発イメージと本番イメージの間に同等性があると、展開の成功が容易になります。チームはスピードのメリットのために本番環境でアルパインイメージを使用することを選択することが多いため、アルパインベースで開発すると、本番環境に移行する際の問題を相殺するのに役立ちます。

次に、環境変数を設定して、Bundlerバージョンを指定します。

〜/ rails-docker / Dockerfile

. . .
ENV BUNDLER_VERSION=2.0.2

これは、環境で使用可能なデフォルトのbundlerバージョンと、Bundler2.0.2を必要とするアプリケーションコードとの間のバージョンの競合を回避するために実行する手順の1つです。

次に、アプリケーションでの作業に必要なパッケージをDockerfileに追加します。

〜/ rails-docker / Dockerfile

. . . 
RUN apk add --update --no-cache \
      binutils-gold \
      build-base \
      curl \
      file \
      g++ \
      gcc \
      git \
      less \
      libstdc++ \
      libffi-dev \
      libc-dev \ 
      linux-headers \
      libxml2-dev \
      libxslt-dev \
      libgcrypt-dev \
      make \
      netcat-openbsd \
      nodejs \
      openssl \
      pkgconfig \
      postgresql-dev \
      python \
      tzdata \
      yarn

これらのパッケージには、nodejsおよびyarnなどが含まれます。アプリケーションはwebpackでアセットを提供するため、アプリケーションが期待どおりに機能するには、Node.jsとYarnを含める必要があります。

alpineイメージは非常に最小限であることに注意してください。ここにリストされているパッケージは、独自のアプリケーションをコンテナー化するときに開発で必要になる可能性のあるものを網羅しているわけではありません。

次に、適切なbundlerバージョンをインストールします。

〜/ rails-docker / Dockerfile

. . . 
RUN gem install bundler -v 2.0.2

この手順により、コンテナー化された環境と、このプロジェクトのGemfile.lockファイルの仕様との間の同等性が保証されます。

次に、コンテナにアプリケーションの作業ディレクトリを設定します。

〜/ rails-docker / Dockerfile

. . .
WORKDIR /app

GemfileとGemfile.lockをコピーします。

〜/ rails-docker / Dockerfile

. . .
COPY Gemfile Gemfile.lock ./

これらのファイルを独立した手順としてコピーし、その後にbundle installを実行すると、アプリケーションコードに変更を加えるたびにプロジェクトgemを再構築する必要がなくなります。これは、Composeファイルに含めるgemボリュームと連携して機能します。このボリュームは、サービスが再作成されてもプロジェクトgemが同じである場合に、アプリケーションコンテナーにgemをマウントします。

次に、nokogirigemビルドの構成オプションを設定します。

〜/ rails-docker / Dockerfile

. . . 
RUN bundle config build.nokogiri --use-system-libraries
. . .

このステップでは、上記のRUN apk add…ステップでアプリケーションコンテナに追加したlibxml2およびlibxsltライブラリバージョンを使用してnokigiriをビルドします。

次に、プロジェクトgemをインストールします。

〜/ rails-docker / Dockerfile

. . . 
RUN bundle check || bundle install

この手順では、gemをインストールする前に、gemがまだインストールされていないことを確認します。

次に、JavaScriptパッケージと依存関係を使用してgemで使用したのと同じ手順を繰り返します。最初にパッケージメタデータをコピーし、次に依存関係をインストールし、最後にアプリケーションコードをコンテナイメージにコピーします。

DockerfileのJavascriptセクションを開始するには、package.jsonとyarn.lockをホスト上の現在のプロジェクトディレクトリからコンテナにコピーします。

〜/ rails-docker / Dockerfile

. . . 
COPY package.json yarn.lock ./

次に、yarn installを使用して必要なパッケージをインストールします。

〜/ rails-docker / Dockerfile

. . . 
RUN yarn install --check-files

この命令には、yarnコマンドを伴う--check-filesフラグが含まれています。これは、以前にインストールされたファイルが削除されていないことを確認する機能です。 gemの場合と同様に、Composeファイルを作成するときに、ボリュームを使用してnode_modulesディレクトリ内のパッケージの永続性を管理します。

最後に、残りのアプリケーションコードをコピーして、エントリポイントスクリプトを使用してアプリケーションを起動します。

〜/ rails-docker / Dockerfile

. . . 
COPY . ./ 

ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

エントリポイントスクリプトを使用すると、コンテナを実行可能ファイルとして実行できます。

最終的なDockerfileは次のようになります。

〜/ rails-docker / Dockerfile

FROM ruby:2.5.1-alpine

ENV BUNDLER_VERSION=2.0.2

RUN apk add --update --no-cache \
      binutils-gold \
      build-base \
      curl \
      file \
      g++ \
      gcc \
      git \
      less \
      libstdc++ \
      libffi-dev \
      libc-dev \ 
      linux-headers \
      libxml2-dev \
      libxslt-dev \
      libgcrypt-dev \
      make \
      netcat-openbsd \
      nodejs \
      openssl \
      pkgconfig \
      postgresql-dev \
      python \
      tzdata \
      yarn 

RUN gem install bundler -v 2.0.2

WORKDIR /app

COPY Gemfile Gemfile.lock ./

RUN bundle config build.nokogiri --use-system-libraries

RUN bundle check || bundle install 

COPY package.json yarn.lock ./

RUN yarn install --check-files

COPY . ./ 

ENTRYPOINT ["./entrypoints/docker-entrypoint.sh"]

編集が終了したら、ファイルを保存して閉じます。

次に、エントリポイントスクリプト用にentrypointsというディレクトリを作成します。

mkdir entrypoints

このディレクトリには、メインのエントリポイントスクリプトとSidekiqサービスのスクリプトが含まれます。

アプリケーションエントリポイントスクリプトのファイルを開きます。

nano entrypoints/docker-entrypoint.sh

次のコードをファイルに追加します。

rails-docker / entrypoints / docker-entrypoint.sh

#!/bin/sh

set -e

if [ -f tmp/pids/server.pid ]; then
  rm tmp/pids/server.pid
fi

bundle exec rails s -b 0.0.0.0

最初の重要な行はset -eです。これは、スクリプトを実行する/bin/shシェルに、スクリプトの後半で問題が発生した場合に高速で失敗するように指示します。次に、スクリプトはtmp/pids/server.pidが存在しないことを確認して、アプリケーションの起動時にサーバーの競合が発生しないようにします。最後に、スクリプトはbundle exec rails sコマンドを使用してRailsサーバーを起動します。このコマンドで-bオプションを使用して、サーバーをデフォルトのlocalhostではなく、すべてのIPアドレスにバインドします。この呼び出しにより、Railsサーバーは着信要求をデフォルトのlocalhostではなくコンテナIPにルーティングします。

編集が終了したら、ファイルを保存して閉じます。

スクリプトを実行可能にします。

chmod +x entrypoints/docker-entrypoint.sh

次に、Sidekiqジョブを処理するsidekiqサービスを開始するスクリプトを作成します。このアプリケーションがSidekiqを使用する方法の詳細については、SidekiqとRedisをRubyonRailsアプリケーションに追加する方法を参照してください。

Sidekiqエントリポイントスクリプトのファイルを開きます。

nano entrypoints/sidekiq-entrypoint.sh

Sidekiqを起動するには、ファイルに次のコードを追加します。

〜/ rails-docker / entrypoints / sidekiq-entrypoint.sh

#!/bin/sh

set -e

if [ -f tmp/pids/server.pid ]; then
  rm tmp/pids/server.pid
fi
 
bundle exec sidekiq

このスクリプトは、アプリケーションバンドルのコンテキストでSidekiqを起動します。

編集が終了したら、ファイルを保存して閉じます。実行可能にする：

chmod +x entrypoints/sidekiq-entrypoint.sh

エントリポイントスクリプトとDockerfileを配置すると、Composeファイルでサービスを定義する準備が整います。

ステップ4—DockerComposeを使用したサービスの定義

Docker Composeを使用すると、セットアップに必要な複数のコンテナーを実行できるようになります。メインのdocker-compose.ymlファイルでComposeservicesを定義します。 Composeのサービスは実行中のコンテナーであり、サービス定義（docker-compose.ymlファイルに含める）には、各コンテナーイメージの実行方法に関する情報が含まれています。作成ツールを使用すると、複数のサービスを定義して、マルチコンテナーアプリケーションを構築できます。

アプリケーションのセットアップには、次のサービスが含まれます。

アプリケーション自体
PostgreSQLデータベース
Redis
Sidekiq

また、セットアップの一部としてバインドマウントを含めるため、開発中に行ったコードの変更は、このコードにアクセスする必要のあるコンテナーとすぐに同期されます。

テストはこのチュートリアルとシリーズの範囲外であるため、ではなく testサービスを定義していることに注意してください。ただし、前例に従うことでそうすることができます。ここではsidekiqサービスに使用しています。

docker-compose.ymlファイルを開きます。

nano docker-compose.yml

まず、アプリケーションサービス定義を追加します。