docker導入後のMysql2::Error::ConnectionError (Unknown MySQL server host 'db' (0)):

Question

やりたいこと

既存のrailsアプリケーションにdockerを導入し、以下のことをできるようにしたいと考えています。

• docker-composeを使ってdocker開発環境を構築したい
• 同じアプリのホスト環境(dockerコンテナを起動していないlocal環境)にてrails sやdb関連のコマンドを使いたい
• EC2にデプロイしたい(Capistranoを使って)

※docker導入前はcapistranoを使った自動デプロイはできている状態でした。

現状できないこと

docker環境にてアプリを立ち上げることはできるようになりましたが、
ホスト環境でのrails server立ち上げ、データベース操作を行うと下記エラーが出ます。

Mysql2::Error::ConnectionError (Unknown MySQL server host 'db' (0)):

またcapistranoを使って自動デプロイを試みたところ、deploy:migratingのところで下記エラーが出ます。

Mysql2::Error::ConnectionError: Unknown MySQL server host 'db' (2)

ソースコード

FROM ruby:2.6.5
RUN apt-get update && apt-get install -y nodejs --no-install-recommends && rm -rf /var/lib/apt/lists/*
RUN apt-get update && apt-get install -y mariadb-client --no-install-recommends && rm -rf /var/lib/apt/lists/*
RUN apt-get update -qq && apt-get install -y build-essential libpq-dev nodejs
RUN apt-get install -y vim

RUN mkdir /myproject

WORKDIR /myproject

ADD Gemfile /myproject/Gemfile
ADD Gemfile.lock /myproject/Gemfile.lock

RUN bundle install

ADD . /myproject

version: '3'
services:
  db:
    image: mysql:5.6.50
    command: mysqld --character-set-server=utf8
    environment:
      MYSQL_DATABASE: app_development
      MYSQL_ROOT_PASSWORD: password
      MYSQL_USER: root
    ports:
      - "3306:3306"
  web:
    build:
      context: .
      dockerfile: Dockerfile
    command: bundle exec rails s -p 3000 -b '0.0.0.0'
    tty: true
    stdin_open: true
    depends_on:
      - db
    ports:
      - "3000:3000"
    volumes:
      - .:/myproject
    environment:
      - "SELENIUM_DRIVER_URL=http://selenium_chrome:4444/wd/hub"
  selenium_chrome:
    image: selenium/standalone-chrome-debug
    logging:
      driver: none

default: &default
  adapter: mysql2
  encoding: utf8
  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: root
  password: <%= ENV['DATABASE_PASSWORD'] %>
  socket: /var/lib/mysql/mysql.sock

行ったこと

エラーの内容からして、database.ymlのhost:dbが怪しいと思いdocker-compose.ymlとdatabase.ymlを下記の通り書き換えました。
docker環境からアクセスした場合と、それ以外の場合でmysqlの権限情報やホストを変えることができるようにするという考え方です。
考え方は下記Qiitaの記事を参考にしました。
https://qiita.com/waniwaninowani/items/21d677a6c455e5b76d45

version: '3'
services:
  db:
    image: mysql:5.6.50
    command: mysqld --character-set-server=utf8
    environment:
      MYSQL_DATABASE: app_development
      MYSQL_ROOT_PASSWORD: password
      MYSQL_USER: root
      MYSQL_HOST: db
    ports:
      - "3306:3306"
  web:
    build:
      context: .
      dockerfile: Dockerfile
    command: bundle exec rails s -p 3000 -b '0.0.0.0'
    tty: true
    stdin_open: true
    depends_on:
      - db
    ports:
      - "3000:3000"
    volumes:
      - .:/myproject
    environment:
      - "SELENIUM_DRIVER_URL=http://selenium_chrome:4444/wd/hub"
  selenium_chrome:
    image: selenium/standalone-chrome-debug
    logging:
      driver: none

default: &default
  adapter: mysql2
  encoding: utf8
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: <%= ENV['MYSQL_USERNAME'] || 'root' %>
  password: <%= ENV['MYSQL_PASSWORD'] || '' %>
  host: <%= ENV['MYSQL_HOST'] || 'localhost' %>
  socket: /tmp/mysql.sock

development:
  <<: *default
  database: app_development

test:
  <<: *default
  database: app_test

production:
  <<: *default
  database: app_production
  username: root
  password: <%= ENV['DATABASE_PASSWORD'] %>
  socket: /var/lib/mysql/mysql.sock
  host: localhost

結果

上記の変更を行ったところ、ホスト環境のrails serverのアクセスはできるようになりましたが、
今度はdocker環境で立ち上げを行う際に下記エラーが出てしまいました。

Mysql2::Error::ConnectionError: Can't connect to local MySQL server through socket '/tmp/mysql.sock' (2)

エラー文からsocket通信の記載を外したらできるのでは、と思いリトライすると、

Mysql2::Error::ConnectionError: Can't connect to local MySQL server through socket '/var/lib/mysql/mysql.sock' (2)

となってしまいます。
またこの状態でcapistranoを試すのは怖くてできていないですし、そもそもdocker環境が正常に作動しないので仮にcapistranoを実行できても意味がない、という状況です。

ちなみにこの状態でdbのコンテナからシェルに入り、mysql -u rootを実行すると

Host '172.18.0.2' is not allowed to connect to this MySQL server

とエラーが吐かれ、mysqlに入れない状態でした。

質問

以下ポイントに関して教えを乞いたいと考えています

1. そもそものゴールの設定が間違っていないか

当方はゴールを①docker環境での開発が可能　②ホスト環境でも開発が可能　③capistranoによる自動デプロイが可能
に設定していますが、考え方が間違っているということはありませんか？
※正直②ホスト環境での開発 は必要なければ飛ばしてしまえば良いと思っています。　　
2. 上記1を踏まえ、以下をご教授願いたいです。
- ゴール設定が間違っていない場合
→上記ソースコードに対しご指摘をいただきたいです。
- ゴール設定が間違っている場合
→dockerを開発環境に導入した場合の開発の考え方（ホスト環境への接続の必要はないetc..）、または考え方を学べる記事や書籍等の情報ソースを教えてください。

ここまで参考にした書籍/記事等

書籍

• Docker/Kubernetes 実践コンテナ開発入門（途中まで）

webサイト/記事

• 入門Docker

https://y-ohgi.com/introduction-docker/

• Dockerをrailsアプリに組み込む方法

https://qiita.com/kkyouhei/items/653760627bf9d4bc9e71
https://qiita.com/y-suna/items/e52b3af1d80c52b66b31

• docker環境とホスト環境を両立する方法

https://qiita.com/waniwaninowani/items/21d677a6c455e5b76d45

環境

• Ruby:2.6.5
• Rails:6.0.0
• Mysql:5.6.50
• Docker:20.10.2
• docker-compose:1.27.4

Comments

[suama]

こんにちは。「ホスト環境」とありますが、これは別のサーバのことでしょうか？なにか情報を添えていただければと思います。
database.yml で host: xxxx としている箇所は、本来はデータベースを起動しているサーバーのIPアドレスやホスト名が入ります。

[lyon]

こんにちは。ここで言うホスト環境とは、dockerコンテナを起動しない状態で、rails sを入力し、PC上のいわゆるlocalhost:3000にアクセスしようとした時のことです。

[suama]

ありがとうございます！回答してみますね！

Answer 1

こんばんは。docker-composeを使っての起動、PC上のターミナルからの直接起動ができるという条件ですね。ソースコードは問題ないので、docker-compose.yml と database.yml の調整で大丈夫だと思います。

database.yml

defaultは共通設定になります。
データベースへの接続でデータベースのサーバを指定するのは、host の箇所ですが、ここは host: <%= ENV['MYSQL_HOST'] || 'localhost' %> としておきます。

こうしておいて、

• docker-compose内でのRailsのコンテナから見た場合は、環境変数がMYSQL_HOST=db となるように指定
• PC上で直にターミナルからRailsを起動する場合は、特に指定しなければlocalhost（ソケット接続）での接続

となるようにすれば良いです。

ちなみに、PC上で直にRailsを起動する場合は、データベース側はどうされていますか？
同じくPC上で直接MySQLを起動していますでしょうか。
それとも、docker-composeで上げているMySQLを利用する形でしょうか。
その場合は、socket: /tmp/mysql.sock でなくて port: 3306を記載するといいかなと思います。

default: &default
  adapter: mysql2
  encoding: utf8
  pool: <%= ENV.fetch("RAILS_MAX_THREADS") { 5 } %>
  username: <%= ENV['MYSQL_USERNAME'] || 'root' %>
  password: <%= ENV['MYSQL_PASSWORD'] || '' %>
  host: <%= ENV['MYSQL_HOST'] || 'localhost' %>
  socket: /tmp/mysql.sock

development:
  <<: *default
  database: app_development

test:
  <<: *default
  database: app_test

production:
  <<: *default
  database: app_production
  username: root
  password: <%= ENV['DATABASE_PASSWORD'] %>
  socket: /var/lib/mysql/mysql.sock
  host: localhost

docker-compose.yml

サービス: web がRailsのアプリケーションを動かすコンテナなので、この設定の箇所の environment のところに、MYSQL_HOST=db を追加します。
こうすることで、上記のdatabase.yml のところで host: <%= ENV['MYSQL_HOST'] || 'localhost' %> した箇所に、db というホスト名が入ります。
docker-compose内で起動したコンテナ同士、サービス名（web,db) で名前解決ができるので、接続できるようになります。

追記

また、database.yml のところで <%= ENV['MYSQL_PASSWORD'] || '' %> と記載があるので、ここも環境変数で渡すかパスワードなしでの接続となります。
docker-compose内で起動したMySQLは MYSQL_ROOT_PASSWORD や MYSQL_USERを明示しているので、これに対応するユーザ名 /　パスワードをdatabase.ymlに渡す必要があります。

version: '3'
services:
  db:
    image: mysql:5.6.50
    command: mysqld --character-set-server=utf8
    environment:
      MYSQL_DATABASE: app_development
      MYSQL_ROOT_PASSWORD: password
      MYSQL_USER: root
    ports:
      - "3306:3306"
  web:
    build:
      context: .
      dockerfile: Dockerfile
    command: bundle exec rails s -p 3000 -b '0.0.0.0'
    tty: true
    stdin_open: true
    depends_on:
      - db
    ports:
      - "3000:3000"
    volumes:
      - .:/myproject
    environment:
      - "SELENIUM_DRIVER_URL=http://selenium_chrome:4444/wd/hub"
      - MYSQL_HOST=db
      - MYSQL_PASSWORD=password
  selenium_chrome:
    image: selenium/standalone-chrome-debug
    logging:
      driver: none

EC2にデプロイしたい(Capistranoを使って)

こちらに関しては、EC2上でのrails起動時の環境変数に MYSQL_HOST=接続させたいMySQLのアドレス を指定すれば大丈夫ですね。

dockerを開発環境に導入した場合の開発の考え方

ローカル開発環境や、サーバ（VirtualBox）に全てをインストールして同時に起動させる形式とは違い、1コンテナ1サービス単位で、必要なものを起動します。

それぞれ別々の環境として認識されるので、基本的には、localhost ではお互い接続できません。

docker-composeを利用する場合は、docker-compose内のネットワークで管理割り当てられた名前で接続し合う形になります。

Comments

[lyon]

丁寧なご回答ありがとうございました。
ご指導いただいたコードをそのまま使ってみたところ、PC上で直にRailsを起動するパターンは動いたのですが、docker-composeの方は
'docker-compose run web rails db:create' をすると
'Mysql2::Error::ConnectionError: Access denied for user 'root'@'172.18.0.5' (using password: NO)'
というエラーが出てしまいました。
ネット上記事にはvolumeを削除するなどの方法が書いてありましたがそれも変わらずでしたし、webコンテナ内でmysqlにアクセスしようとしてもdb:createの時と同様のエラーが出てしまいます。

どこに着目して修正をはかれば良いでしょうか？

[suama]

ご確認ありがとうございます。docker-composeの中で、MySQL側で MYSQL_ROOT_PASSWORD: password という設定がありますね。
docker-compose内でのRails (web) と MySQL (db) のやりとりは、この情報を使うので、同じく docker-compose.ymlにこの設定を渡す必要がありますね。
追記いたしますね。

[lyon]

修正ありがとうございます。ご指摘の方針でやってみたところ、docker環境においても直のrails環境においてもサーバーを立ち上げることができました。ありがとうございます！
また重ねての質問で大変恐縮ですが、EC2へのデプロイのところで「EC2上でのrails起動時の環境変数に MYSQL_HOST=接続させたいMySQLのアドレス を指定すれば大丈夫」とのコメントをいただきましたが、これはEC2上の環境変数にMYSQL_HOST=dbと設定する必要があると言うことでしょうか？
現在は特にEC2上の環境変数は手を加えずcapistranoを実行しましたが、見た目上は問題なくデプロイできているようです。またdatabase.ymlでもproductionのhostはlocalhostに設定しているので、localhostにアクセスすることになっているのでは？と思いますが、変更を行わないと問題が生じてしまうと言うことでしょうか？

[suama]

EC2上ではdocker-composeを使うのですか？
直にRailsを起動し、別途MySQLを起動するとかRDSを使う構成？
それ次第でしょうか。

> 変更を行わないと問題が生じてしまうと言うことでしょうか？
defaultの設定では、localhostか環境変数で渡したデータベースのアドレスをひきつぎます。
もちろん適切な接続先がいなければ、エラーになります。

> ※docker導入前はcapistranoを使った自動デプロイはできている状態でした。

と書かれていましたので、EC2上ではdockerを使っての起動でないのなら、その時の設定と同じになるだけです。情報を添えていただけると。
あとはやってみて、潰していくのが良いと思いますよ。

回答はここまでで。

[lyon]

ありがとうございます。
今回はEC2上でMariaDBを立ち上げてRDSを使う構成にしているので、まずは設定はこのままで行こうと思います。
おかげさまでなんとか先へ進めそうです。本当にありがとうございました。ベストアンサーとさせていただきます。