Zenn
🌟

Rails6・MySQLのDocker開発環境の作り方【Dockerfile】

2022/02/07に公開
Docker
Rails
Ruby
tech

記事の内容

RailsのDocker開発環境構築のためのDockerfileを作成する

対象読者

  • DockerでRails6のローカル開発環境を作りたい人

環境

  • mac OS
  • Rails 6
  • ruby 3.1
  • MySQL 5.7

Dockerfile

まずはDockerfileを作成します。

$ touch Dockerfile

公式ドキュメント

https://docs.docker.com/samples/rails/

公式ドキュメント通りのDockerifleは以下

# syntax=docker/dockerfile:1
FROM ruby:2.5
RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
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"]

公式の場合、ruby2系・Rails5系・postgresqlで作成しているため、以下の変更を行います。

  • rubyを3系に
  • Rails6で使用するwebpackerのためにyarnのinstall等も行います
  • postgresqlの記述を削除
  • bundle installに並列実行のオプションを追加

Dockerfile

変更後のDockerfileはこちらです。

FROM ruby:3.1.0
RUN curl -sS https://dl.yarnpkg.com/debian/pubkey.gpg | apt-key add - \
    && echo "deb https://dl.yarnpkg.com/debian/ stable main" | tee /etc/apt/sources.list.d/yarn.list \
    && apt-get update -qq \
    && apt-get install -y nodejs yarn
WORKDIR /myapp
COPY Gemfile* /myapp/
RUN bundle install -j4

# 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"]

※alpineは今回は使用しない(別記事にて、alpineへの変更を書きます！)

Gemfile

次に、railsのgemを管理するGemfileを作成します。

$ touch Gemfile
$ touch Gemfile.lock

Gemfile

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

Gemfileには、rails6の記述をし、Gemfile.lockは空にしておきます。
※GemfileはRailsで使用するGemを管理するファイルです。

entrypoint.sh

次にRailsを起動する際に、実行する entrypoint.sh を作成します。

$ touch entrypoint.sh

#!/bin/bash
set -e

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

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

docker-compose.yml

次に、複数のDockerを管理するためのdocker-compose.ymlを作成します。

$ touch docker-compose.yml

docker-compse.yml

version: "3.9"
services:
  db:
    image: mysql:5.7
    container_name: rails_mysql
    volumes:
      - mysql-data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: password
      TZ: 'Asia/Tokyo'
    ports:
      - '3306:3306'
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci --default-authentication-plugin=mysql_native_password
  web:
    build: .
    container_name: rails_web
    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
    stdin_open: true
    tty: true
volumes:
  mysql-data:
    driver: local

※MySQLは5.7系を使用しています。

Rails install

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

すべてのファイルが作成できたら、以下のコマンドを実行します。

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

実行が完了すると、Railsプロジェクトに関連する大量のファイルがinstallされてることがわかります。

Docker build

Railsのinstallが完了したら、Docker buildを行います.

$ docker-compose build

DB作成

無事にdocker-compose buildが完了したら、MySQLとRailsを接続します。

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

development:
  <<: *default
  database: myapp_development

test:
  <<: *default
  database: myapp_test

production:
  <<: *default
  database: myapp_production
  username: myapp
  password: <%= ENV['MYAPP_DATABASE_PASSWORD'] %>

となっている database.yml ファイルを、以下に変更します。

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

development:
  <<: *default
  database: myapp_development

test:
  <<: *default
  database: myapp_test

production:
  <<: *default
  database: myapp_production
  username: myapp
  password: <%= ENV['MYAPP_DATABASE_PASSWORD'] %>

変更後、db:createの処理を実行します。

$ docker-compose run web rake db:create
Creating rails-docker_web_run ... done
Created database 'myapp_development'
Created database 'myapp_test'

開発用データベースとテスト用データベースが作成されます。

docker-compose up

最後に、

$ docker-compose up

を実行。

ブラウザから、localhost:3000にアクセスし、Railsのホーム画面が表示されたら完了です！

note

勉強法やキャリア構築法など、エンジニアに役立つ記事をnoteで配信しています。

https://note.com/ring_belle/membership

Discussion