Docker の使い方（その６：Docker Compose）

Compose ファイルは、docker-compose.yml という名前のファイルです。 拡張子からわかるように YAML 形式になります。 YAML 形式なのでコメントも書けます。

このファイルをプロジェクトのルートディレクトリなどに作成します。 Git などのバージョン管理ツールに登録しておくと良いでしょう。 そうすることで、そのファイルを使って他のユーザーさんも同じ環境を作れるようになります。

Compose ファイルにはいくつかバージョンがありますので、作成する際はバージョンを定義することから始めましょう。 その次に、作成したいサービス（コンテナ）の一覧を定義します。

デフォルトでは、専用のネットワークが自動的に作成されます。 定義したコンテナ同士はデフォルトで接続できる状態になりますので、それで問題ない場合はネットワークを自分で定義する必要はありません。

Compose ファイルの詳しい書き方については、ここでは記載しません。 あまりにも大量にありますので、公式のドキュメントを見てもらった方が良いと思います。

• Compose ファイル — Docker-docs-ja 20.10 ドキュメント
• Compose file | Docker Documentation

書式と簡単な例だけ記載しておきます。

version: "バージョン番号"

services:
  コンテナ構成の一覧

version: "3.7"

services:

  # httpd コンテナ
  # コンテナイメージ「httpd:2.4」をベースとする
  # ポートマッピングはホスト側ポート「8080」、コンテナ側ポート「80」とする
  httpd:
    image: httpd:2.4
    ports:
      - 8080:80

  # mysql コンテナ
  # コンテナイメージ「mysql:5.7」をベースとする
  # ポートマッピングはホスト側ポート「3306」、コンテナ側ポート「3306」とする
  # 名前付きボリューム「todo-mysql-data」を使用する
  mysql:
    image: mysql:5.7
    ports:
      - 3306:3306
    volumes:
      - todo-mysql-data:/var/lib/mysql
    environment:
      MYSQL_ROOT_PASSWORD: secret
      MYSQL_DATABASE: todos

volumes:
  todo-mysql-data:

Docker Desktop で構成の一覧を表示するには、Docker Desktop の左メニューの「Containers / Apps」をクリックします。 コンテナの一覧も一緒に表示されます。

コマンドで構成の一覧を表示するには、docker compose ls コマンドを使用します。 オプション無しで実行した場合は、動作中の構成のみ表示され、停止中の構成は表示されません。

docker compose ls

NAME                STATUS
test-proj           running(2)

docker compose ls -a

新しい構成を作成するには、 Compose ファイルを置いてあるディレクトリで docker container create コマンドを実行します。

docker container create コマンドは、新しい構成を作成しますが、その構成の起動は行いません。 構成の作成のみを行います。

docker compose create

新しい構成を作成して起動するには、 Compose ファイルを置いてあるディレクトリで docker compose up コマンドを実行します。

docker compose up コマンドは、新しい構成を作成し、その構成を起動します。 構成を作成した後にいちいち構成を起動させるのがメンドウな場合は、こちらのコマンドを使った方が便利です。 docker compose create コマンドの後に docker compose start コマンド（後述）を実行するのと同じです。

-d オプションを付けると、全てのコンテナがデタッチモード（バックグラウンド）で起動します。 忘れずに付けておきましょう。

docker compose up -d

Docker Desktop で構成を起動するには、Docker Desktop の「Containers / Apps」から起動したい構成の「START」ボタンをクリックします。

コマンドで構成を起動するには、 Compose ファイルを置いてあるディレクトリで docker compose start コマンドを使用します。

docker compose start

Docker Desktop で構成のログを表示するには、Docker Desktop の「Containers / Apps」からログを表示したい構成をクリックします。

コマンドで構成のログを表示するには、 Compose ファイルを置いてあるディレクトリで docker compose logs コマンドを使用します。

docker compose logs

docker compose logs -f

Docker Desktop でコンテナを停止するには、Docker Desktop の「Containers / Apps」から停止したい構成の「STOP」ボタンをクリックします。

コマンドで構成を停止するには、 Compose ファイルを置いてあるディレクトリで docker compose stop コマンドを使用します。

docker compose stop

Docker Desktop で構成を削除するには、Docker Desktop の「Containers / Apps」から削除したい構成の「DELETE」ボタンをクリックします。 構成が動作中の場合でも削除できるので注意してください。

コマンドで構成を削除するには、 Compose ファイルを置いてあるディレクトリで docker compose rm コマンドを使用します。 構成を削除するには、その構成を先に停止しておく必要があります。

docker compose rm

docker compose down