👩‍👧‍👧

compose.yaml ???

2024/06/04に公開

TL;DR;

Docker Compose の推奨設定ファイル名は compose.yaml

蛇足

大した話ではないのですが、複数 compose ファイルの挙動を調べていたら以下の一文がありました。

By default, Compose reads two files, a compose.yml and an optional compose.override.yml file.

https://docs.docker.com/compose/multiple-compose-files/merge/

自分が携わっているプロダクトだと、設定ファイル名は docker-compose.yml だったので、compose.yml ???な状態になり、ググっても日本語ではあまり言及されていないようだったので記事にしました。

あと、さらにいうと yml よりも yaml が推奨らしいです。上記では公式が yml を使っていますが。

The default path for a Compose file is compose.yaml (preferred) or compose.yml that is placed in the working directory.

https://docs.docker.com/compose/compose-application-model/#the-compose-file

当然、後方互換性はあり、 docker-compose.yaml でも docker-compose.yml でも現状は動きます。ただ、いつサポートされなくなるかもわからないので、今後は compose.yaml で書くのが良さそうです。

Discussion