🐳

🐳 Dockerを用いたRailsとMySQL開発環境構築ガイド

2024/07/31に公開

Docker

はじめに

こんにちは、Takeです。都内の自社開発企業でエンジニアとして働いています。

今回やること

docker, docker composeを用いて以下の環境を作成します。

ruby 3.3.3
rails 7.1.3.4
mysql 8.4.0

要件

railsとmysqlはコンテナを分けること
以下のgemをdevelopmentおよび test環境でのみ使用できるよう導入すること

pry-rails
factory_bot
rubocop

minitestを使用するためrspecは不要
makeコマンドの作成して以下を実行できるようにするため
- Docker環境でRubocopを実行
- テストの実行

動作確認

docker compose upで以下のコンテナが起動する

rails
mysql

binding.pryが動作する
factory_botが動作する
rubocopが動作する
- コンテナの中でrubocopが動作するようにmakeコマンドを作成しておく

`git init`から `First Commit`まで

こちらを参考に

`Dockerfile`の作成

以下のリンクを参考に必要なファイルを作成します。

以下のファイルを作成します。（DockerでRailsを動かすため）

Dockerfile
docker-compose.yml
Gemfile
Gemfile.lock
entrypoint.sh

terminal

touch Dockerfile docker-compose.yml Gemfile Gemfile.lock entrypoint.sh

`Dockerfile`の内容

Dockerfile

FROM ruby:3.3.3
ARG RUBYGEMS_VERSION=3.3.3

# 作業ディレクトリを指定
WORKDIR /app

# ホストのGemfileとGemfile.lockをコンテナにコピー
COPY Gemfile Gemfile.lock /app/

# bundle installを実行
RUN bundle install

# ホストのファイルをコンテナ内の作業ディレクトリにコピー
COPY . /app

# entrypoint.shをコンテナ内の作業ディレクトリにコピー
COPY entrypoint.sh /app

# entrypoint.shを実行可能にする
RUN chmod u+x entrypoint.sh

# コンテナ起動時にentrypoint.shを実行
ENTRYPOINT ["/app/entrypoint.sh"]

# コンテナ起動時にrails serverを実行
CMD ["rails", "server", "-b", "0.0.0.0"]

Ruby 3.3.3をベースにしたコンテナを作成し、Railsアプリケーションを実行するためのものです。

依存関係をインストールし、アプリケーションコードとエントリーポイントスクリプトをコンテナにコピーします。起動時にエントリーポイントスクリプトを実行し、Railsサーバーを起動する設定が含まれています。

`docker-compose.yml`の内容

docker-compose.yml

version: "3.9"
services:
  db:
    image: mysql:8.4.0
    environment:
      MYSQL_ROOT_PASSWORD: password
      MYSQL_DATABASE: database
      MYSQL_USER: user
      MYSQL_PASSWORD: password
    volumes:
      - mysql_volume:/var/lib/mysql
    ports:
      - "3307:3306"
    command: --default-authentication-plugin=mysql_native_password

  web:
    build: .
    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
    volumes:
      - .:/app
    ports:
      - "3000:3000"
    stdin_open: true
    tty: true
    depends_on:
      - db
volumes:
  mysql_volume:

`database.yml`の内容

database.yml

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

development:
  <<: *default
  database: app_development

test:
  <<: *default
  database: app_test

production:
  <<: *default
  database: app_production
  username: app
  password: <%= ENV["APP_DATABASE_PASSWORD"] %>

この設定ファイルでは、dbサービスとしてMySQLコンテナの起動設定を行い、webサービスとしてRailsアプリケーションの起動設定を行っています。dbという名前で設定されたMySQLコンテナに、Railsアプリケーションからアクセスできるようにしています。

`Gemfile`の内容

Gemfile

source 'https://rubygems.org'
gem 'rails', '~> 7.1.3.4'

Railsアプリケーションの依存関係を管理します。具体的には、RubyGemsのソースからRails 7.1.3.4を含む7系のバージョンを使用することを指定しています。

`entrypoint.sh`の内容

entrypoint.sh

#!/bin/ash

set -e

# Remove a potentially pre-existing server.pid for Rails.
rm -f /app/tmp/pids/server.pid

# Then exec the container's main process (what's set as CMD in the Dockerfile).
exec "$@"

Railsサーバーが既に存在する場合に古いPIDファイルを削除し、その後にDockerfileで指定されたメインプロセスを実行します。スクリプトはエラーが発生すると終了するように設定されています。

Railsプロジェクトの作成コマンド

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

--force: 既存のファイルを上書きします
--no-deps: サービスの依存関係を起動せずにコマンドを実行します
--database=mysql: MySQLデータベースを使用します

Railsアプリケーション内でデータベースを作成

docker compose run --rm web rails db:create

MySQLが作成されます

$ docker compose run --rm web rails db:create
[+] Creating 1/0
 ✔ Container auto-registration-db-1  Running                                                                                    0.0s 
Created database 'app_development'
Created database 'app_test'

サーバーを起動

docker compose run --rm web rails s

成功🙌

`gem`を`development`, `test`環境でのみ使用できる状態にする

group :development, :test do
  gem 'pry-rails'
  gem 'pry-byebug'
  gem 'factory_bot_rails'
  gem 'rubocop', require: false
  gem 'rubocop-rails', require: false
  gem 'rubocop-performance', require: false
end

主に以下のgemを追加

pry-rails
factory_bot
rubocop
- minitestを使用するためrspecは不要

require: falseを付ける理由は、これらのgemが自動で読み込まれないようにするためです。これにより、アプリケーションの起動時に使用されるメモリ量を減らし、起動速度を向上させることができます。

You may pass an array with multiple files or true if the file you want required has the same name as gem or false to prevent any file from being autorequired.

そして、以下のコマンドを実行してGemfileに記載のgemをダウンロードします。

docker compose run web bundle install

Makefileの作成

要件
4. makeコマンドの作成

Docker環境でRubocopを実行できるようにするため

さらに、テストも実行できるようにしていただけると尚良し

Makefile誕生前の背景

1980年代からCPUのハードウェアやソフトウェアが急速に発展することにより、大規模なプログラムも増加しました。大規模プログラムには、多くのソースファイルやヘッダファイルが含まれており、複雑な依存関係が存在します。

あるファイルを修正・変更した際、その変更に依存する全てのファイルを再コンパイルする必要があるため、手動での管理が困難かつコンパイルに時間がかかる課題がありました。

Makefile誕生

Stuart FeldmanによってMakeが作成されました。Makeは、プログラムのビルドプロセス(プログラムのソースコードをCPUが実行できる形に変更する作業)を自動化するためのツールで、その具体的な設定内容を記載したものがMakefileです。

具体的な設定内容としては、ファイル同士の依存関係やコマンドがあります。Makeは、このMakefileを読み込み、必要なファイルだけを再コンパイルすることで効率的なビルドプロセスを実現しました。

※ビルドプロセスとコンパイルの違いはこちら

Makefileのメリット

効率的なコンパイル：変更されたファイルだけを再コンパイルするため、コンパイルに要する時間を削減。
依存関係の管理：Makefileに依存関係を記述することで管理。
ビルドプロセスの自動化：手動の操作を減らすことで、ヒューマンエラーも減少。

Makefileの中身について

Makefile

# Dockerの設定ファイル
DOCKER_COMPOSE = docker compose
DOCKER_RUN = $(DOCKER_COMPOSE) run --rm

# デフォルトで実行されるサービス名
SERVICE = web

# Railsコマンド
RAILS = $(DOCKER_RUN) $(SERVICE) bundle exec rails

# Rubocopコマンド
RUBOCOP = $(DOCKER_RUN) $(SERVICE) bundle exec rubocop

# Docker
.PHONY: build up stop restart down-volumes logs clean

build:
	$(DOCKER_COMPOSE) build --no-cache

up:
	$(DOCKER_COMPOSE) up -d

restart:
	$(DOCKER_COMPOSE) restart

down:
	$(DOCKER_COMPOSE) down

down-volumes:
	$(DOCKER_COMPOSE) down -v

logs:
	$(DOCKER_COMPOSE) logs -f

# Rails
.PHONY: setup db-create db-drop db-migrate reset seed console annotate routes shell test

create:
	$(RAILS) db:create

drop:
	$(RAILS) db:drop

migrate:
	$(RAILS) db:migrate

reset:
	$(RAILS) db:reset

seed:
	$(RAILS) db:seed

console:
	$(RAILS) console

annotate:
	$(RAILS) annotate

routes:
	$(RAILS) routes

shell:
	$(DOCKER_RUN) $(SERVICE) bash

test:
	$(RAILS) test

# Rubocop
.PHONY: rubocop rubocop-auto-correct rubocop-auto-unsafe
rubocop:
	$(RUBOCOP)

rubocop-auto-correct:
	$(RUBOCOP) -a

rubocop-auto-correct-unsafe:
	$(RUBOCOP) -A

# Bundle
.PHONY: bundle-install update
bundle-install:
	$(DOCKER_RUN) $(SERVICE) bundle install

bundle-update:
	$(DOCKER_RUN) $(SERVICE) bundle update

# Assets
.PHONY: assets-precompile
assets-precompile:
	$(DOCKER_RUN) $(SERVICE) bundle exec rails assets:precompile

# key
.PHONY: key
key:
	$(DOCKER_RUN) --rm -e EDITOR=vim $(SERVICE) bundle exec rails credentials:edit

作業中に発生したエラー集

`docker-compose: command not found`

bash: docker-compose: command not found

docker-compose をダウンロードしてインストールする必要がありそう。

sudo apt-get install docker-compose

ダメ

source ~/.zshrc

上記を実行後に再度以下を実行するもダメ

sudo apt-get install docker-compose

切り替えて以下を実行

docker compose up -d

エラー発生

Error response from daemon: driver failed programming
external connectivity on endpoint registration-db-1 (urytp95eiypw48tupryjo86uwqa5o8uypt9r9d2b4730141681bfas4aw4rhj53):
Bind for 0.0.0.0:3306 failed: port is already allocated

以下のエラーメッセージに着目

Error response from daemon:driver failed programming
external connectivity 〜. failed: port is already allocated.

Error response from daemon:
failed to create task for container: failed to create shim task:
OCI runtime create failed: runc create failed:
unable to start container process: exec: "entrypoint.sh":
executable file not found in $PATH: unknown

要するに、entrypoint.shを適当に位置してくださいと言われた（Path名が違う）

Dockerfile

# コンテナ起動時にentrypoint.shを実行
- ENTRYPOINT ["/entrypoint.sh"]

+ ENTRYPOINT ["/app/entrypoint.sh"]

`docker compose up`実行時のエラーメッセージ

※一部抜粋

[ERROR] [MY-013909] [Server] A message intended for a client
cannot be sent there as no client-session is attached.
Therefore, we're sending the information to the error-log instead:
MY-001146 - Table 'mysql.component' doesn't exist

クライアントに関するメッセージが、クライアントのセッションが接続していないため送信できません。
そのため、この情報をエラーログに送信します。mysql componentテーブルが存在しないと。

一度ボリュームを削除してみる

docker compose down -v
docker compose up

正常に起動🙌

[ERROR] [MY-0100343] [Server] unknown variable 'default-authentication-plugin=mysql_native_password'.

default-authentication-plugin=mysql_native_passwordという不明な変数があります。

Important Change: The deprecated mysql_native_password authentication plugin is now disabled by default. It can be enabled by starting MySQL with the new --mysql-native-password=ON server option, or by adding mysql_native_password=ON to the [mysqld] section of your MySQL configuration file.

MySQL8.4.0では、mysql_native_passwordの認証プラグインがデフォルトで無効になったためエラーが発生。

MySQL5.7.0まではmysql_native_passwordはデフォルトの認証プラグインであり、ユーザーパスワードのハッシュ化にSHA-1が使用されていた。

In MySQL 8.4, caching_sha2_password is the default authentication plugin rather than mysql_native_password (deprecated).

その一方で、MySQL8.0からは更にセキュアなSHA-256を使用した caching_sha2_password 認証プラグインが追加され、デフォルトの認証プラグインも caching_sha2_passwordに変更された経緯がある。

よって、以下のようにdocker-compose.ymlファイルを修正

修正前

docker-compose.yml

version: "3.9"
（省略）
    volumes:
      - mysql_volume:/var/lib/mysql
    ports:
      - "3307:3306"
　　　　　　　　command: --default-authentication-plugin=mysql_native_password

修正後

docker-compose.yml

version: "3.9"
（省略）
    volumes:
      - mysql_volume:/var/lib/mysql
    ports:
      - "3307:3306"
    # 削除（デフォルトでcaching_sha2_passwordが設定されているため）

現段階では採用しなかったもの

ridgepole

Railsにてスキーマ管理を行う便利なツール 🛠️
https://github.com/ridgepole/ridgepole

その背景

1. 今回はチーム人数が比較的少ないため　🌟

ridgepoleはスキーマ変更を一括管理するため、マイグレーションファイルのコンフリクトが起こりにくいメリットがありますが、そもそも今回はチーム人数が比較的少ないため、この恩恵を大きく活かせないのではないかと考えております。

2. 追加での設定を要するため

rails g modelを実行する場合にマイグレーションファイルを無効にする設定などが必要なため。

3. 開発途中でも導入できるため

Rails標準ではないということもありますが、ridgepoleは容易にプロジェクト途中から導入できるため、開発者が増えるなどの理由からマイグレーションファイルの管理が難しくなってきた時に導入を再検討いたします。

最後に

ここまで読んでいただきありがとうございました！
今回の記事が良かったと思ったらぜひ「いいね」を押していただけると嬉しいです 🎉

noteでも記事を執筆していますので、ぜひチェックしてみてください。

他にもこのようなことについて記載しているのでお読みいただければ幸いです。

最後までお読みいただき、誠にありがとうございました！

はじめに

今回やること

要件

動作確認

git initから First Commitまで

Dockerfileの作成

Dockerfileの内容

docker-compose.ymlの内容

database.ymlの内容

Gemfileの内容

entrypoint.shの内容

Railsプロジェクトの作成コマンド

Railsアプリケーション内でデータベースを作成

サーバーを起動

gemをdevelopment, test環境でのみ使用できる状態にする

Makefileの作成

Makefile誕生前の背景

Makefile誕生

Makefileのメリット

Makefileの中身について

作業中に発生したエラー集

docker-compose: command not found

docker compose up実行時のエラーメッセージ

修正前

修正後

現段階では採用しなかったもの

ridgepole

1. 今回はチーム人数が比較的少ないため 🌟

2. 追加での設定を要するため

3. 開発途中でも導入できるため

最後に

Discussion

`git init`から `First Commit`まで

`Dockerfile`の作成

`Dockerfile`の内容

`docker-compose.yml`の内容

`database.yml`の内容

`Gemfile`の内容

`entrypoint.sh`の内容

`gem`を`development`, `test`環境でのみ使用できる状態にする

`docker-compose: command not found`

`docker compose up`実行時のエラーメッセージ

1. 今回はチーム人数が比較的少ないため　🌟