railsをdockerを用いて開発する時のbundle installについて

Question

現在、railsアプリケーションをdockerを用いて開発しようと思っています。

既にアプリケーションは途中まで開発していて、途中からのdocker導入となります。

一通りセットアップは済ませ、既存のアプリケーションをdocker上で動かすことは可能になりました。

しかし、色々なサイトを見ていてbundleに関するいくつかの疑問が浮上しました。

現在のDockerfileはこのようになっています。

FROM ruby:2.5.0
RUN apt-get update -qq && apt-get install -y nodejs postgresql-client
RUN mkdir /myapp
WORKDIR /myapp
COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock
RUN bundle install
COPY . /myapp

COPY entrypoint.sh /usr/bin/
RUN chmod +x /usr/bin/entrypoint.sh
ENTRYPOINT ["entrypoint.sh"]
EXPOSE 3000

CMD ["rails", "server", "-b", "0.0.0.0"]

また、docker-copmose.yml

version: "3"
services:
  backend:
    build:
      context: ./backend
    command: bash -c "rm -f tmp/pids/server.pid && bundle exec rails s -p 3000 -b '0.0.0.0'"
    volumes:
      - ./backend:/myapp
    ports:
      - "3000:3000"
    links:
      - db
  db:
    image: postgres:12
    ports:
      - "5432:5433"
    volumes:
      - postgresql-data:/var/lib/postgresql/data
volumes:
  postgresql-data:
    driver: local

まず、新たにgemを追加しようとします。

ホスト側のGemfileに
gem hogehoge
を追加し、
docker-compose build
を実行したとします。

この場合、Dockerfile内の

COPY Gemfile /myapp/Gemfile
COPY Gemfile.lock /myapp/Gemfile.lock

が変更を検知して、その次のRUN bundle installを実行すると思います。
この時、Dockerイメージ内にはCOPYされてきたGemfile内のパッケージはインストールされていない状態だと思うので、１から全てのgemをinstallすることになると思います。

その結果、Gemfile.lockがbundle installが実行された後の依存関係を新たに記載した状態になると思います。

しかし、この後の
COPY . /myappによって、ホスト側のbundle installしていない状態のGemfile.lockがCOPYされ、bundle install後のGemfil.lcokの内容が上書きされると思うのですが、どうなんでしょうか？

また、docker-compsoe.ymlのvolumes: ./backedn:/myappの記載によって上記と同じようにbundle installが済んでいない状態のホスト側のGemfile.lockがコンテナ内にマウントされて古いGemfile.lockが上書きされ、Gemfile.lock以外にもbundleディレクトリがまだホスト側では更新されていないので古いbundleディレクトリがコンテナ内にコピーされると思うのですが、このような考え方があっているのでしょうか？

Answer 1

はい、全体的にそのような認識で合っています。

COPY . /myappによって、ホスト側のbundle installしていない状態のGemfile.lockがCOPYされ、bundle install後のGemfil.lcokの内容が上書きされると思うのですが、どうなんでしょうか？

はい、上書きされてしまいます。
そのような動作を回避したい場合は、gem hogehoge を追加後、ホスト側では bundle install まで実行して Gemfile.lock を新しい内容に更新しておかなければいけません。

Gemfile.lock以外にもbundleディレクトリがまだホスト側では更新されていないので古いbundleディレクトリがコンテナ内にコピーされると思うのですが、

はい、コピーされることになります。
ただし、.dockerignore ファイルで、bundleディレクトリ を無視する設定がされているような場合は、Dockerイメージや立ち上げたコンテナに 古いbundleディレクトリ がコピーされることはありません。

例えば、以下のような内容の .dockerignore ファイルを作成しておくことで、
コピーやマウントする必要のないファイルを docker build や docker run の実行時に無視することができます。

.bundle
log
tmp
vendor/bundle

Comments

[kurukururin]

御回答ありがとうございます！
認識が合っているようでよかったです。

その上で伺いたいのですが、ローカル環境で`bundle install`を行わずにGemfileとGemfile.lockをしっかり同期させ（古いGemfile.lockがコンテナにマウントされないようにする）るにはどのようにしたらいいのでしょうか。。

bundleディレクトリに関してはdata volumeに入れることによってホストからコンテナへのマウントは避けられるということは分かりました。

ホスト側でGemfileを更新後、`docker-compose run`や`docker-compose build`を打ってしまうとDockerfileによりGemfile.lockが上書きされてしまうのでどのようにすべきか悩んでいます。

Gemfileを更新後起動しているコンテナの中に入ってdocker-compose exec web bundle installとして、コンテナ内でbundle installをしてからコンテナを再起動すると行った方法を思いついたのですがどうでしょうか。。

[uzyexe]

はい、まさにそのとおりで、docker-compose.yml にある volumes: の定義によって Gemfile.lock がコンテナにマウントされている状態であれば、docker-compose exec web bundle install などでコンテナ内で bundle install を実行することで、ローカル側の Gemfile.lock の内容も同期されるようになると思います。

[kurukururin]

自分の認識が合っていてよかったです。
ありがとうございました！
dockerでの開発の流れがだいたい理解できてきました

Answer 2

pry-beybugのgemをインストール後、コード内にbinding.pryを記述することでデバッグすることができました。