DockerでRailsの環境構築を一つ一つ丁寧に読み解きながらやってみた（docker-compose.yml編）

この記事の内容

Docker & Railsで新規プロジェクトを立ち上げることになったので、Docker周りのファイルを丁寧に読み解きながら設定した時の話。

これまでにDockerfileの設定はやっているので、今回はその続きから。

▼前回の記事
RailsでDockerfile設定しながら、コマンド一つひとつ丁寧に読んでみた

▼Railsのバージョン
６.1.4

参考にした内容

今回も公式のRailsの設定ガイド(Quickstart: Compose and Rails)を参考にしつつ、バージョン等を最新版（2021年8月時点）にアップデートして作成しました。

• Quickstart: Compose and Rails

あとはこちらの記事。当時初学者さんだったのにすごい。

• DockerでRuby on Railsの環境構築を行うためのステップ【Rails 6対応】

docker-compose.ymlの内容

まずは、先にあげた公式ガイドの記述をバージョンだけ変えて記載しています。

公式でのコマンドの説明はこのぐらいしか記載が見つけられなかったので、各コマンドの説明は先のあげたこちらの記事から拝借しました。

docker-compose.yml

version: "3.9"
services:
  db:
    image: postgres
    volumes:
      - ./tmp/db:/var/lib/postgresql/data
    environment:
      POSTGRES_PASSWORD: password
  web:
    build: .
    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
    volumes:
      - .:/myapp
    ports:
      - "3000:3000"
    depends_on:
      - db

[version] docker-composeのバージョンです。2019年10月現在、最新は'3'です。
**[services] **この下のハッシュにサービスを作りましょう。命名は自由ですが、通常はwebとdbと名付けます。
[image] 使用するimage（dbでPostgreSQLを指定しています）
[volumes] ディレクトリのマウント設定（dbデータなどを残せます）
[build] Dockerfileなどがあるパス（基本的にカレントディレクトリ）
[command] コマンド（server.pidファイルを削除してからrailsサーバー起動)
[ports] ポート番号。[ホスト：コンテナ]で設定。
[depends_on]　依存関係を示していて、起動順を指定できます。ここではdb→webへと起動します。

引用元：DockerでRuby on Railsの環境構築を行うためのステップ【Rails 6対応】

Rails newする

そして、公式ガイドに書いてあった通り、以下のコマンドでRails newします。

$ docker-compose run --no-deps web rails new . --force --database=postgresql

--no-deps の部分は、リンクされたサービス（ここではweb）を開始しないようにComposeに指示している部分だそうです。こうすることでコンテナ内に新しいアプリを作れるのだそう。

上記を実行すると、こんなメッセージが出て立ち上げが終了します。

... # インストールされた諸々の gemの情報
Installing sass-rails 6.0.0
Bundle complete! 17 Gemfile dependencies, 73 gems now installed.
Use `bundle info [gemname]` to see where a bundled gem is installed.
       run  bundle binstubs bundler
       rails  webpacker:install
Yarn not installed. Please download and install Yarn from https://yarnpkg.com/lang/en/docs/install/
Exiting!

公式ガイドの説明はRails 5の前提なので、webpacker周りの設定をする必要がありそうですね。

もう一度イメージをbuildしてbundle installする

なお、公式ガイドには「これにて新しいGemfileが作成されているので、イメージをもう一度立ち上げてbundle installしましょう」的な記述があったので、コンソールで下記コマンドを実行します。

$ docker-compose build

/testなど不要なディレクトリやファイルが含まれていないのを確認して、ここで一度コミットしておきます。

DBとの接続設定をする

先に出ていた「Rails6関連の記載」も気になりますが、先にDBとの接続設定をやってしまいます。
RailsはデフォルトでlocalhostのDBを参照するようになっているので、dbのイメージを作成するように書き換えます。

confog.database.yml

default: &default
  adapter: postgresql
  encoding: unicode
  host: db
  username: postgres
  password: password
  pool: 5

development:
  <<: *default
  database: myapp_development


test:
  <<: *default
  database: myapp_test

こちらは公式の記述から何もいじっていません。
このまま、一回 docker-compose downしてdocker-compose upすると、（無事、DBへの接続を完了した上で）今度はこんなエラーが。

`rescue in load': Webpacker configuration file not found /myapp/config/webpacker.yml. Please run rails webpacker:install Error: No such file or directory @ rb_sysopen - /myapp/config/webpacker.yml

今度こそwebpacker:installをする必要がありそうです。

Webpackerを導入する

調べたところ、Doker上でWebpackerをインストール＆立ち上げるには

• コンテナ内へのyarnのインストール（Dockerfileに記載）
• コンテナ内で、rails webpacker:install

の２点が必要なようです。まずは前者から。

yarnのimageへのインストール

Dockerfileにyarnをインストールするコマンドを追記します。追記箇所以外の記述の意味は前回記事をご参照ください。

• RailsでDockerfile設定しながら、コマンド一つひとつ丁寧に読んでみた

FROM ruby:3.0.2
RUN apt-get update -qq && apt-get install -y nodejs postgresql-client

# ここを追記
RUN set -x && curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - && \
  echo 'deb http://dl.yarnpkg.com/debian/ stable main' > /etc/apt/sources.list.d/yarn.list

RUN set -x && apt-get update -qq && \
  apt-get install -yq build-essential yarn

WORKDIR /myapp

COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock
RUN bundle install

# Add a script to be executed every time the container starts.
COPY entrypoint.sh /usr/bin/
RUN chmod +x /usr/bin/entrypoint.sh
ENTRYPOINT ["entrypoint.sh"]
EXPOSE 3000

# Configure the main process to run when running the image
CMD ["rails", "server", "-b", "0.0.0.0"]

記載は下記の記事を参考にしましたが、重複しているコマンドもあるので、もっと簡潔に書けそうです。。。
とりあえず今は時間がないので、これで我慢します。

• Ruby:2.6 のdockerコンテナでrails6.0を入れようとしたらyarnがコケた

Webpackerをインストール

コンテナ内にWebpackerは下記のコマンドでインストールしました。
まず docker-compose buildでコンテナを立ち上げたのちに、

docker compose run web bundle exec rails webpacker:install

上記のコマンドで、コンテナ内にWebpackerをインストールできます。

rails db:create → アプリの立ち上げ

同じ要領で

docker compose run web rails db:create

したのちに、localhost:3000にアクセスすると...

はい、無事Railsの初期画面が立ち上がりました！！

感想など

これからCIの設定やJSのライブラリの設定、ChromeDriverの設定などやっていくことを考えると、まだまだ先が長いですが、とりあえず一段落で嬉しいです

最近読んだ本にプロジェクトの初期設定は専門職がいるくらい大変な仕事、と書いてあったのですが、ホント、先が長いですね。。。

引き続きJS系ツールやテストツールの設定など書いて行けたらと思います。

【シリーズの他の読み物】
前の話

• RailsでDockerfile設定しながら、コマンド一つひとつ丁寧に読んでみた