[Laravel] docker-compose.yml の記載に合わせてなかったから接続できなかった

Tech

※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。

[Laravel] docker-compose.yml の記載に合わせてなかったから接続できなかった

アホらしいので、メモしておく。

.env の DB_HOST は docker-compose.yml の service name に合わせましょうって話。

症状

Docker で動かしている Laravel から DB につながらないとき、よく見るのがこのエラー。

SQLSTATE[HY000] [2002] Connection refused

DBのコンテナは起動している、ユーザー名もパスワードも合っている、なのにつながらない——というときは、まず DB_HOST を疑います。

原因: DB_HOST が 127.0.0.1 のまま

DB_CONNECTION=mysql
DB_HOST=127.0.0.1 # ← ここ
DB_PORT=3306

ローカルで直接動かすときの設定のまま、というのがありがちなパターンです。

コンテナの中で 127.0.0.1 と書くと、それはLaravel(PHP)が動いているコンテナ自身を指します。MySQL は別のコンテナにいるので、自分自身に接続しにいっても当然誰もいません。

対処: compose のサービス名にする

docker-compose.yml がこうなっているなら、

services:
  app:
    build: .
  db:
    image: mysql:8.0

.env はこう。

DB_HOST=db
DB_PORT=3306

docker compose が作るネットワークの中では、サービス名がそのままホスト名として名前解決できるようになっています。db と書けば DB コンテナにつながる、という仕組みです。

ℹ️ Laravel Sail を使っている場合、.env の初期値はサービス名に合わせて DB_HOST=mysql になっています。Sail が最初から上手くいくのはこのおかげ。

それでもつながらないときに見るところ

確認ポイントよくある間違い
DB_PORTports: "33060:3306" のホスト側の番号(33060)を書いている。コンテナ間ならコンテナ側の 3306
どこで artisan を実行しているかホストのターミナルで php artisan migrate すると、db という名前は解決できない(getaddrinfo failed)。docker compose exec app php artisan migrate のようにコンテナ内で実行する
起動順depends_on はコンテナの起動順を決めるだけで、MySQL の準備完了までは待たない。起動直後だけ失敗するならこれ
設定キャッシュ.env を直したのに反映されない → php artisan config:clear

起動順の問題は、DB 側に healthcheck を書いて condition: service_healthy で待たせると確実です。

services:
  app:
    depends_on:
      db:
        condition: service_healthy
  db:
    image: mysql:8.0
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 5s
      retries: 10

まとめ

  • コンテナ内の 127.0.0.1 は自分自身。DB には届かない
  • DB_HOST は docker-compose.yml のサービス名、DB_PORT はコンテナ側のポート
  • artisan はコンテナの中で実行する
  • 実際にどこへつなぎに行っているかの確認はLaravelで接続先チェックしたいときで

分かってしまえば一行の修正。だからこそ、アホらしいのでメモ。

docker, docker-compose, Laravel