第6章 Docker Composeで複数のコンテナを動かす

LPIC-3 305(352.3)相当

WebサーバーとデータベースのDocker環境を作るたびに、長いdocker runのオプションを並べるのは大変です。Docker Composeを使うと、構成をファイルに書いておき、1つのコマンドで何度でも同じ環境を再現できます。

Docker Composeとは

Docker Composeは、複数のコンテナからなるアプリケーションの構成(イメージ・ポート・環境変数・ボリューム・ネットワーク・依存関係)を、YAML形式のファイルにまとめて管理するツールです。構成をファイルで管理するため、Gitで変更の履歴を残したり、ほかの人と同じ環境を共有したりできます。

現在のCompose(v2)は、Go言語で書かれたDocker CLIのプラグインで、docker compose(スペース区切り)で実行します。以前のPython製のdocker-compose(ハイフンつき、v1)は、2023年に更新が終了しています。Ubuntuでは、docker-compose-v2パッケージで導入します。

$ sudo docker compose version
docker: 'compose' is not a docker command.
See 'docker --help'
$ sudo apt install -y docker-compose-v2
$ sudo docker compose version
Docker Compose version 2.27.1+ds1-0ubuntu1~24.04.1

compose.yamlを書く

設定ファイルの名前はcompose.yamlが推奨されています(docker-compose.ymlも読み込まれます)。Webサーバー(nginx)とデータベース(MySQL)の例です。

~/myapp/compose.yaml
services:
  web:
    image: nginx
    ports:
      - "8080:80"
    depends_on:
      - db
  db:
    image: mysql
    environment:
      MYSQL_ROOT_PASSWORD: secret
    volumes:
      - dbdata:/var/lib/mysql

volumes:
  dbdata:

servicesの下に、コンテナの種類(サービス)ごとの設定を書きます。portsは-p、environmentは-e、volumesは-vに相当します。最上位のvolumesは、名前付きボリュームの宣言です。YAMLはインデント(字下げ)で構造を表すため、スペースで揃え、タブ文字は使いません。

豆知識:
古い記事では、ファイルの先頭にversion: "3.8"のような行が書かれていることがあります。
現在のComposeではこの指定は使われておらず、書いても無視され、警告が表示されます。

起動と確認:up・ps・logs

compose.yamlがあるディレクトリでdocker compose up -dを実行すると、ネットワーク・ボリューム・コンテナがまとめて作られ、起動します。-dを付けないと、ログを表示し続ける状態になります(Ctrl+Cで停止)。

$ cd ~/myapp
$ sudo docker compose up -d
[+] Running 4/4
 ✔ Network myapp_default  Created
 ✔ Volume "myapp_dbdata"  Created
 ✔ Container myapp-db-1   Started
 ✔ Container myapp-web-1  Started
$ sudo docker compose ps
NAME          IMAGE   COMMAND                  SERVICE   CREATED                  STATUS                  PORTS
myapp-db-1    mysql   "docker-entrypoint.s…"   db        Less than a second ago   Up Less than a second   3306/tcp, 33060/tcp
myapp-web-1   nginx   "/docker-entrypoint.…"   web       Less than a second ago   Up Less than a second   0.0.0.0:8080->80/tcp, [::]:8080->80/tcp

Composeは、ディレクトリ名をプロジェクト名として使い、コンテナを「プロジェクト名-サービス名-番号」、ネットワークを「プロジェクト名_default」と名付けます(-pでプロジェクト名を変えられます)。サービスは自動で同じネットワークに参加するため、webのコンテナからは、dbというサービス名でデータベースに接続できます。

$ sudo docker compose logs web             # サービスを指定してログを表示
$ sudo docker compose exec web cat /etc/os-release   # サービスのコンテナでコマンドを実行
$ sudo docker compose config               # 変数などを展開した最終的な設定を表示(書式の確認にも使える)

停止と削除:stop・down

コマンド動作
docker compose stopコンテナを停止する(削除はしない)。startで再開できる
docker compose downコンテナとネットワークを停止・削除する。ボリュームは残る
docker compose down -v名前付きボリュームも削除する(データが消える)
docker compose up -d --buildイメージを作り直してから起動する(build:を使うサービス)
$ sudo docker compose down
[+] Running 3/3
 ✔ Container myapp-web-1  Removed
 ✔ Container myapp-db-1   Removed
 ✔ Network myapp_default  Removed
注意:
down -vは、データベースのデータが入ったボリュームも削除します。
検証環境をまっさらに戻したいとき以外は、-vを付けないようにしましょう。

depends_onは「起動の順番」だけを決める

depends_onを書くと、dbのコンテナを起動してからwebのコンテナを起動します。ただし、待つのは「コンテナが起動したこと」だけで、データベースが接続を受け付けられる状態になったかどうかは待ちません。アプリケーションが起動直後に接続エラーになる場合は、データベース側にhealthcheckを定義し、condition: service_healthyで「正常と判定されるまで待つ」ように書きます。

compose.yaml(抜粋)
services:
  web:
    depends_on:
      db:
        condition: service_healthy
  db:
    image: mysql
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost"]
      interval: 10s
      retries: 5

環境変数と.envファイル

パスワードなどをcompose.yamlに直接書くと、Gitに登録したときに漏れてしまいます。compose.yamlと同じディレクトリに.envファイルを置くと、${DB_PASSWORD}のような変数が、そのファイルの値で置き換えられます。.envは.gitignoreに追加して、リポジトリには含めないようにします。

.env
DB_PASSWORD=change-me
compose.yaml(抜粋)
    environment:
      MYSQL_ROOT_PASSWORD: ${DB_PASSWORD}
試してみよう:
練習用ターミナルの課題モードの「Docker Composeで複数のコンテナをまとめて動かす」で、パッケージの導入からdown -vまでを実際に試せます。

この章のまとめ

Docker Composeは、複数のコンテナの構成をcompose.yamlにまとめ、docker compose up -dで起動、downで片付けるツールです。サービス名での名前解決、プロジェクト単位での命名、depends_onの限界、.envでの秘密情報の分離を押さえておけば、検証環境を素早く作れるようになります。次の章では、複数のホストでコンテナを動かすオーケストレーションを扱います。

この記事を書いた人:
こすけ(コマンド学習道場 運営者)。
AWSの運用保守に携わるエンジニアで、保有資格はCCNA・AWS-SAA・LPIC-3(305)。
詳しくは運営者情報をご覧ください。

この章で使ったコマンド

この章の実行例に出てきたコマンドです(全3個)。名前を選ぶと、オプションや実行例を詳しく確認できます。復習や、あとから調べ直すときに使ってください。

docker・apt・cd

この章の内容を練習できる課題

読んだ内容は、実際に打ってみると定着します。次の課題は、ブラウザの練習用ターミナルで、この章のコマンドを使って進めるものです。リンクを開くと、すぐに始まります。

ほかの課題は、練習問題の一覧から選べます。

確認クイズ

Q1. Ubuntu 24.04で、現在のDocker Compose(v2)を導入・実行する方法として正しいものはどれですか?

解説:
Compose v2はDocker CLIのプラグインで、docker compose(スペース区切り)で実行します。
Ubuntuではdocker-compose-v2パッケージで導入します。

Q2. docker compose downを実行したとき、既定で削除されないものはどれですか?

解説:
名前付きボリュームは、-v(--volumes)を付けた場合だけ削除されます。

Q3. depends_onについて、正しい説明はどれですか?

解説:
depends_onの既定の動作は、依存先のコンテナが起動したことだけを待ちます。

Q4. ~/myapp ディレクトリでdocker compose up -dを実行したとき、webサービスのコンテナの名前は、既定でどうなりますか?

解説:
Compose v2は、プロジェクト名(既定はディレクトリ名)・サービス名・番号をハイフンでつないで命名します。