Closed24

Railsで自動生成されるDockerfileについて

コーキコーキ
Dockerfile
# syntax = docker/dockerfile:1

# This Dockerfile is designed for production, not development. Use with Kamal or build'n'run by hand:
# docker build -t my-app .
# docker run -d -p 80:80 -p 443:443 --name my-app -e RAILS_MASTER_KEY=<value from config/master.key> my-app

# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
ARG RUBY_VERSION=3.4.1
FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base

# Rails app lives here
WORKDIR /rails

# Install base packages
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y curl libjemalloc2 libvips postgresql-client && \
    rm -rf /var/lib/apt/lists /var/cache/apt/archives

# Set production environment
ENV RAILS_ENV="production" \
    BUNDLE_DEPLOYMENT="1" \
    BUNDLE_PATH="/usr/local/bundle" \
    BUNDLE_WITHOUT="development"

# Throw-away build stage to reduce size of final image
FROM base AS build

# Install packages needed to build gems and node modules
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y build-essential git libpq-dev node-gyp pkg-config python-is-python3 && \
    rm -rf /var/lib/apt/lists /var/cache/apt/archives

# Install JavaScript dependencies
ARG NODE_VERSION=22.14.0
ARG YARN_VERSION=1.22.22
ENV PATH=/usr/local/node/bin:$PATH
RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
    npm install -g yarn@$YARN_VERSION && \
    rm -rf /tmp/node-build-master

# Install application gems
COPY Gemfile Gemfile.lock ./
RUN bundle install && \
    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
    bundle exec bootsnap precompile --gemfile

# Install node modules
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile

# Copy application code
COPY . .

# Precompile bootsnap code for faster boot times
RUN bundle exec bootsnap precompile app/ lib/

# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile


RUN rm -rf node_modules


# Final stage for app image
FROM base

# Copy built artifacts: gems, application
COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
COPY --from=build /rails /rails

# Run and own only the runtime files as a non-root user for security
RUN groupadd --system --gid 1000 rails && \
    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
    chown -R rails:rails db log storage tmp
USER 1000:1000

# Entrypoint prepares the database.
ENTRYPOINT ["/rails/bin/docker-entrypoint"]

# Start the server by default, this can be overwritten at runtime
EXPOSE 3000
CMD ["./bin/rails", "server"]
コーキコーキ

下記コマンドで生成されたDockerfileです。環境やバージョンによってDockerfileの中身が違う可能性がある

docker compose run --rm app rails new . -d postgresql -j esbuild -c tailwind
コーキコーキ
Dockerfile
# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
ARG RUBY_VERSION=3.4.1
FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base

# Rails app lives here
WORKDIR /rails

# Install base packages
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y curl libjemalloc2 libvips postgresql-client && \
    rm -rf /var/lib/apt/lists /var/cache/apt/archives

# Set production environment
ENV RAILS_ENV="production" \
    BUNDLE_DEPLOYMENT="1" \
    BUNDLE_PATH="/usr/local/bundle" \
    BUNDLE_WITHOUT="development"
コーキコーキ

Dockerfileコマンドについて(chatGPT解答)

Dockerfileコマンド 説明
ARG ビルド時にのみ使える変数を定義する（コンテナ実行時には使えない）。
FROM ベースイメージを指定する（最初の命令である必要がある）。
WORKDIR 作業ディレクトリを設定する（以降のコマンドの実行ディレクトリになる）。
RUN ビルド時にシェルコマンドを実行する（例: パッケージのインストール）。
ENV 環境変数を設定する（コンテナ実行時にも有効）。
コーキコーキ

・開発環境と同じruby_versionのベースイメージが指定されていた

Dockerfile
# Make sure RUBY_VERSION matches the Ruby version in .ruby-version
ARG RUBY_VERSION=3.4.1
FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base
コーキコーキ

Install base packagesについて(chatGPT解答)

パッケージ名 説明
curl HTTP/HTTPSリクエストを送信できるコマンドラインツール。APIやファイルのダウンロードに使用される。
libjemalloc2 jemalloc（高性能メモリアロケータ）のライブラリ。メモリ管理を最適化し、RubyやPostgreSQLのパフォーマンスを向上させるために使用される。
libvips 高速な画像処理ライブラリ。ActiveStorage で画像のリサイズや変換を行う際に使用される（mini_magick よりも高速）。
postgresql-client PostgreSQL データベースに接続するためのクライアントツール（psql コマンドなどを提供）。アプリが PostgreSQL を使用する場合に必要。
コーキコーキ
Dockerfile
# Throw-away build stage to reduce size of final image
FROM base AS build

# Install packages needed to build gems and node modules
RUN apt-get update -qq && \
    apt-get install --no-install-recommends -y build-essential git libpq-dev node-gyp pkg-config python-is-python3 && \
    rm -rf /var/lib/apt/lists /var/cache/apt/archives

# Install JavaScript dependencies
ARG NODE_VERSION=22.14.0
ARG YARN_VERSION=1.22.22
ENV PATH=/usr/local/node/bin:$PATH
RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
    npm install -g yarn@$YARN_VERSION && \
    rm -rf /tmp/node-build-master

# Install application gems
COPY Gemfile Gemfile.lock ./
RUN bundle install && \
    rm -rf ~/.bundle/ "${BUNDLE_PATH}"/ruby/*/cache "${BUNDLE_PATH}"/ruby/*/bundler/gems/*/.git && \
    bundle exec bootsnap precompile --gemfile

# Install node modules
COPY package.json yarn.lock ./
RUN yarn install --frozen-lockfile

# Copy application code
COPY . .

# Precompile bootsnap code for faster boot times
RUN bundle exec bootsnap precompile app/ lib/

# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile


RUN rm -rf node_modules
コーキコーキ

Dockerfileコマンドについて(chatGPT解答)

Dockerfileコマンド 説明
COPY ホストマシンのファイルをコンテナにコピーする。
コーキコーキ

Install packages needed to build gems and node modulesについて(chatGPT解答)

パッケージ名 説明
build-essential C/C++ のコンパイラや開発ツール（gcc、make など）を含む。C拡張のある gem（例: nokogiri）のビルドに必要。
git ソースコードのバージョン管理に使用。gem のインストール時に Git リポジトリから取得するものがあるため必要。
libpq-dev PostgreSQL の開発用ライブラリ。pg gem（PostgreSQL クライアントライブラリ）をビルドする際に必要。
node-gyp Node.js のネイティブアドオンをビルドするためのツール。JavaScript のパッケージによってはコンパイルが必要な場合がある。
pkg-config C/C++ のライブラリのコンパイル時に必要な設定情報を取得するツール。ネイティブ拡張を持つ gem で使用されることがある。
python-is-python3 python コマンドを python3 にリンクするパッケージ。Node.js の node-gyp や一部のビルドツールが Python を必要とするため。
コーキコーキ

nodenvをcurlしてJavaScript dependenciesを作成していますね。
ネットで調べた中では、Node.js のインストールスクリプトを取得しapt-get install nodejsしているものや、nodeイメージからCOPYしているものが多い印象です。

Dockerfile
# Install JavaScript dependencies
ARG NODE_VERSION=22.14.0
ARG YARN_VERSION=1.22.22
ENV PATH=/usr/local/node/bin:$PATH
RUN curl -sL https://github.com/nodenv/node-build/archive/master.tar.gz | tar xz -C /tmp/ && \
    /tmp/node-build-master/bin/node-build "${NODE_VERSION}" /usr/local/node && \
    npm install -g yarn@$YARN_VERSION && \
    rm -rf /tmp/node-build-master
コーキコーキ
Dockerfile
# Precompiling assets for production without requiring secret RAILS_MASTER_KEY
RUN SECRET_KEY_BASE_DUMMY=1 ./bin/rails assets:precompile

Railsには、パイプラインにあるアセットのマニフェストなどのファイルを手動でコンパイルするためのコマンドがバンドルされています。
コンパイルされたアセットは、config.assets.prefixで指定された場所に保存されます。この保存場所は、デフォルトでは/assetsディレクトリです。
デプロイ時にこのタスクをサーバー上で呼び出すと、コンパイル済みアセットをサーバー上で直接作成できます。

https://railsguides.jp/v7.0/asset_pipeline.html

ENV["SECRET_KEY_BASE_DUMMY"] = 1を指定すれば、development環境やtest環境でやっているのと同様にダミーのsecret_key_baseを渡せるようにする。

https://techracho.bpsinc.jp/hachi8833/2023_01_25/126314#1-2

コーキコーキ

なぜ複数のFROMが存在するのか?

Dockerfile

FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base

# Throw-away build stage to reduce size of final image
FROM base AS build

# Final stage for app image
FROM base
コーキコーキ

マルチステージビルドを利用しているため、複数のFROMが存在する

マルチステージビルドとは

マルチステージ ビルドmulti-stage build とは、Dockerfile の読みやすさやメンテナンスのしやすさを維持するよう、最適化に悩まされている全ての人に役立ちます。
マルチステージ ビルドでは、 Dockerfile の中で複数の FROM 命令文を使います。各 FROM 命令は、異なるベースを使い、それを使って新しい構築ステージを始めます。あるステージから別のステージに対し、コピーするアーティファクトを選べるため、最終イメージで不要なすべてを残したままにできます。

https://docs.docker.jp/build/building/multi-stage.html

マルチステージビルドを使う理由

・構築ステップを並列に実行できるため、構築パイプラインをより速くより効率的にできる。
・プログラムを実行するために必要なものだけを含む、形跡が最小の最終イメージを作成できる。

https://docs.docker.jp/build/guide/multi-stage.html

コーキコーキ

FROM base AS buildでビルドした結果だけを、最終イメージでCOPYすることで、最終イメージを小さくしていることが分かりました

Dockerfile

FROM docker.io/library/ruby:$RUBY_VERSION-slim AS base

# Throw-away build stage to reduce size of final image
FROM base AS build

FROM base

# Copy built artifacts: gems, application
COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
COPY --from=build /rails /rails
コーキコーキ
Dockerfile
# Final stage for app image
FROM base

# Copy built artifacts: gems, application
COPY --from=build "${BUNDLE_PATH}" "${BUNDLE_PATH}"
COPY --from=build /rails /rails

# Run and own only the runtime files as a non-root user for security
RUN groupadd --system --gid 1000 rails && \
    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
    chown -R rails:rails db log storage tmp
USER 1000:1000

# Entrypoint prepares the database.
ENTRYPOINT ["/rails/bin/docker-entrypoint"]

# Start the server by default, this can be overwritten at runtime
EXPOSE 3000
CMD ["./bin/rails", "server"]
コーキコーキ

Dockerfileコマンドについて(chatGPT解答)

Dockerfileコマンド 説明
USER コンテナ内でアプリケーションを実行するユーザーを指定します。通常、セキュリティを考慮して非rootユーザーを指定します。これにより、コンテナが攻撃された場合のリスクを低減できます。
例: USER rails:rails（rails ユーザーで実行）
ENTRYPOINT コンテナ起動時に実行されるデフォルトのコマンドを指定します。ENTRYPOINT は必ず実行されるコマンドで、通常はアプリケーションの開始スクリプトを指定します。
例: ENTRYPOINT ["/rails/bin/docker-entrypoint"]
EXPOSE コンテナがリスンするポートを指定します。このコマンド自体はポートを公開するわけではなく、コンテナを実行する時に外部に公開するポートを示すための情報として使用されます。
例: EXPOSE 3000（コンテナがポート3000をリスンすることを示す）
CMD コンテナが実行される際に実行されるデフォルトのコマンドや引数を指定します。ENTRYPOINT と組み合わせて使われることが多いです。CMD はオプションで、ENTRYPOINT が指定されている場合、追加の引数として機能します。
例: CMD ["./bin/rails", "server"]（Railsサーバーを起動する）
コーキコーキ
コマンド 説明 主なオプション
groupadd グループ管理コマンド。新しいグループを作成するために使用します。 --system (システム用のグループを作成)、--gid <ID>（グループIDを指定）
useradd ユーザー管理コマンド。新しいユーザーを作成するために使用します。 --uid <ID>（ユーザーIDを指定）、--gid <ID>（グループIDを指定）、--create-home（ホームディレクトリを作成）、--shell <shell>（シェルを指定）
chown ファイル管理コマンド。ファイルやディレクトリの所有者やグループを変更するために使用します。 -R（再帰的に変更）
Dockerfile
# Run and own only the runtime files as a non-root user for security
RUN groupadd --system --gid 1000 rails && \
    useradd rails --uid 1000 --gid 1000 --create-home --shell /bin/bash && \
    chown -R rails:rails db log storage tmp
USER 1000:1000
コーキコーキ

jemallocとは

jemalloc is a general purpose malloc(3) implementation that emphasizes
fragmentation avoidance and scalable concurrency support.

https://github.com/jemalloc/jemalloc
(chatGPT調べ)
・アロケーターとは、メモリの確保と解放を管理する仕組みのこと
・C言語では malloc / free、C++ では std::allocator が使われる
・Ruby は C 言語で実装されており、内部で malloc や jemalloc などのアロケーターを利用 してメモリを確保。
・ jemalloc は malloc よりも高速・効率的

rails db:prepareとは

・データベースがまだ作成されていない場合: bin/rails db:prepareコマンドはbin/rails db:setupと同じように実行されます。
・データベースは存在するがテーブルが作成されていない場合: bin/rails db:prepareコマンドはスキーマを読み込んで保留中のマイグレーションを実行し、更新されたスキーマをダンプし、最後にseedデータを読み込みます。詳しくは、seedデータのセクションを参照してください。
・データベース、テーブル、seedデータがすべて揃っている場合: bin/rails db:prepareコマンドは何も行いません。

https://railsguides.jp/active_record_migrations.html#データベースを準備する

bin/docker-entrypoint
#!/bin/bash -e

# Enable jemalloc for reduced memory usage and latency.
if [ -z "${LD_PRELOAD+x}" ] && [ -f /usr/lib/*/libjemalloc.so.2 ]; then
  export LD_PRELOAD="$(echo /usr/lib/*/libjemalloc.so.2)"
fi

# If running the rails server then create or migrate existing database
if [ "${1}" == "./bin/rails" ] && [ "${2}" == "server" ]; then
  ./bin/rails db:prepare
fi

exec "${@}"
このスクラップは2025/03/27にクローズされました