docker-compose.ymlでdepends_onを使わないで依存関係が生まれている理由を知りたい。

Question

最強のLaravel開発環境をDockerを使って構築する【新編集版】 - Qiita

こちらの記事に従って、開発環境をしているDockerを学びたての初心者です。

以下のdocker-compose.ymlを読んでいて疑問に思った点があったので質問させてください。

version: "3.8"
volumes:
  db-store:
  php-fpm-socket:
services:
  app:
    build: ./docker/php
    volumes:
      - php-fpm-socket:/var/run/php-fpm
      - ../backend:/work/backend
      - ./docker/php/bash/.bash_history:/root/.bash_history
      - ./docker/php/bash/psysh:/root/.config/psysh

  web:
    build: ./docker/nginx
    ports:
      - 80:80
    volumes:
      - php-fpm-socket:/var/run/php-fpm
      - ../backend:/work/backend

  db:
    build: ./docker/mysql
    volumes:
      - db-store:/var/lib/mysql
    ports:
      - 3306:3306

docker-laravel/docker-compose.yml at master · ucan-lab/docker-laravel

app,web,dbと依存関係が記載されていないのに、エラーが起きずに動く理由が知りたいです。
私の理解ではwebはappに依存関係があると思うのですが、このdocker-compose.ymlにはdepends_onが使われていません。

どうやって接続をコントロールしているのでしょうか。

よろしくおねがいします。

Answer 1

depends_onはコンテナの作成順序を決めるだけのもので質問者さんが想像するようなコンテナ間の依存関係を定義するものではありません。
depends_onが指定されていない場合、コンテナは~~記載された上から順番に作成されます。~~同時に作成されます。

また、冒頭に説明したようにコンテナの作成順を決めるだけなので、コンテナ中のプログラムやサービスの起動完了を待つわけではありません。ここに最も注意が必要です。

本件でwebがappに対して依存する要素はpho-fpm用のドメインソケットが作成されるディレクトリの共有部分- php-fpm-socket:/var/run/php-fpmのみで、app側が先にマウントしないといけませんが、これはコンテナ作成時にボリュームの共有化が完了するためコンテナ作成後の中身の処理が速かろうが遅延していようが関係ないので大丈夫になっています。

要するに、本件に限って言えば接続や中身のサービスをコントロールする必要が（たまたま）なかっただけです。

追記

docker-compose upだけで運用するなら全然問題ないのですが、docker-compose up [service-name]のように引数にサービス名をつけてupするような場合、起動サービスのdepends_onで記載されたサービスが先にビルドされます。無関係のサービスはビルドされません。このような場合では依存関係の記載が有効でしょう。
でもサービス名つけてupするような用事はほとんどないような・・・

追記2

本文も修正しましたが、depends_onが指定されていない場合、それぞれのコンテナは同時に作成が開始されます。
コンテナ作成開始時に、docker内部DNSにサービス名でアドレスが引けるよう登録されるようです。
bsdfanさんのコメント通り、nginx起動時にconfファイルを読み込み転送先ホストの名前解決を行うようです（相手ホストとの通信は発生せず、名前解決のみ？）それまでにDNSに相手ホスト情報が登録されていなければエラーとなりますが、コンテナが同時に起動されていれば十分間に合うようです。
意図的に逆向きにdepends_onを記載していない限りは実質大丈夫だと思われます。

Comments

[Kchan_01]

ご回答ありがとうございます。

以下のコードは別のdocker-compose.ymlです。
以下ではTCP通信を行うため、nginxのphpに対する依存関係が生まれる。
TCP通信ではビルド直後に最初に通信が行われる？ためdepends_onを使用している。という理解で良いでしょうか。

質問に上げたファイルはphp-fpm-socket:/var/run/php-fpmを共通部分としてUNIXドメインソケットを使用しており、

> コンテナ作成時にボリュームの共有化が完了するため

ビルドの順番が関係ない。ということでしょうか。

```docker-compose.yml
version: '3'
services:
nginx:
build:
context: ./docker/nginx
depends_on:
- php
ports:
- 80:80
volumes:
- ./src:/src

php:
container_name: laravel-app
build:
context: ./docker/phpfpm
environment:
DB_HOST: mysql
volumes:
- ./src:/src

mysql:
container_name: laravel-mysql
restart: always
image: mysql:5.7
volumes:
- ./docker/mysql:/var/lib/mysql
environment:
- MYSQL_ROOT_PASSWORD=root
- MYSQL_USER=tsunagu
- MYSQL_PASSWORD=password
- MYSQL_DATABASE=tsunagu
ports:
- 3306:3306
```

[hope_mucci]

この場合、php<->nginx間のTCP通信はユーザーがwebサーバ（の*.php）にアクセスしたときにはじめて発生するので、php側のコンテナが先に作成されていないとマズイということはありません。
つまりこの場合でもdepends_onの記述は特に意味はありません。

>ビルドの順番が関係ない。ということでしょうか。
というわけではありません。質問本文のほうはphp側が先でないとまずいと思います（たぶん）
php側のほうが先に書かれているからビルド順も先というだけで。

ただ、私も今気づいたのですがdocker-composeで個別にサービスを立ち上げるようなことがある場合、depends_onを記載しているとそのサービスを先に立ち上げるようになるようです。
詳しくは以下公式ドキュメントで。
http://docs.docker.jp/compose/compose-file.html#compose-file-depends-on

[Kchan_01]

公式ドキュメントのリンクもありがとうございます。

> この場合、php<->nginx間のTCP通信はユーザーがwebサーバ（の*.php）にアクセスしたときにはじめて発生する
そうなんですね。depends_onの記述にはいつも違和感があったので、すっきりしました。
確かに単体で存在できないものを依存関係なしに定義しているのは見方によっては危険かもしれないです。webアプリケーション全体というより、db周りとかでは、depends_onは役に立つ部分も考えられますね。
お付き合いいただき、ありがとうございます。

[bsdfan]

nginxの場合、転送先のコンテナが先に起動していないとconfファイルでホスト名が解決できずに落ちる場合がありますので、depends_onは必要です。(それか動的に名前解決するようにするか)

[Kchan_01]

@bsdfan さん
ご回答ありがとうございます。

今回、default.confファイルで
location ~ .php$ {
fastcgi_pass unix:/var/run/php-fpm/php-fpm.sock;
fastcgi_index index.php;
fastcgi_param SCRIPT_FILENAME $realpath_root$fastcgi_script_name;
include fastcgi_params;
}
として、UNIXドメインソケットでつなぐように定義しているので回避措置しなくてよい。

docker-laravel/default.conf at master · ucan-lab/docker-laravel
https://github.com/ucan-lab/docker-laravel/blob/master/infrastructure/docker/nginx/default.conf

以下のファイルのようにfastcgi_pass php:9000;と指定している場合は、一度、サーバ間で通信が行われ、それが失敗すると落ちる可能性があるので、depends_onは必要。ってことですか？
[tsunagu/default.conf at master · yoshikawa/tsunagu](https://github.com/yoshikawa/tsunagu/blob/master/docker/nginx/etc/nginx/conf.d/default.conf)

> php<->nginx間のTCP通信はユーザーがwebサーバ（の*.php）にアクセスしたときにはじめて発生する
というのは間違いで、設定によっては(むしろ、設定しないと)、コンテナ起動時にサーバー通信が起きる。という理解で良いでしょうか。

[bsdfan]

TCPの場合、confファイルを読む段階で、転送先のホスト名をIPアドレスに解決できずにhost not foundでエラーになります。(通信が発生する以前の問題です)
docker-composeでは、サービス名をホスト名として指定できますが、コンテナが起動していないとDNSで名前がひけません。
(UNIXソケットの場合も、ソケットファイルがないとエラーになりそうですが、そのあたり自信ないです。)

[hope_mucci]

bsdfanさんのコメント通り、php側コンテナ作成前の段階でnginxを起動したとき、conf読み込み時に名前解決が発生してエラーとなることを確認しました。(depends_onを逆にして検証)
nginxとphpでコンテナ作成順やdepends_onをいろいろ変更して起動実験をしてみた結果、depends_onをつけずに同時にコンテナを作成すると名前解決エラーは発生しませんでした。DNS参照時までにphp側コンテナ作成開始していれば良いようです。
万全を期すならdepends_on指定しておいたほうが良いと考えます。が、そこまで神経質にならなくてもいいのかも。

[hope_mucci]

UNIXソケット利用ケース（質問本文のケース）で、webとappの依存関係を逆（app側にdepends_on: -web)にしたりwebだけ単体で起動してみましたが、特にエラーは発生しませんでした。.sockファイルは起動時になくても良いようです。

Answer 2

webはappに依存関係があると思うのですが

アプリケーションとして依存関係はないので個別に起動できます。

機能が動作するときには依存関係(連携)が必要です
webがphpを処理するときにはphp-fpmが動いていなければならない。
phpがDBを参照するときはmysqlが動いていなければならない。