compose.yamlの解説

compose.yamlを開いてみましょう。以下の内容が記述されています。

services:
  # データベース層
  db:
    image: mysql:8.0
    command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
    environment:
      MYSQL_ROOT_PASSWORD: rootpass
      MYSQL_DATABASE: notedb
      MYSQL_USER: noteuser
      MYSQL_PASSWORD: notepass
    volumes:
      - db-data:/var/lib/mysql
      - ./db/init.sql:/docker-entrypoint-initdb.d/init.sql
    healthcheck:
      test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-prootpass"]
      interval: 10s
      timeout: 5s
      retries: 5

  # アプリケーション層
  api:
    build: ./api
    ports:
      - "8000:8000"
    environment:
      DB_HOST: db
      DB_USER: noteuser
      DB_PASSWORD: notepass
      DB_NAME: notedb
    depends_on:
      db:
        condition: service_healthy

  # プレゼンテーション層
  front:
    build: ./front
    ports:
      - "3000:80"
    depends_on:
      - api

volumes:
  db-data:

各設定について解説します。

1. servicesセクション

servicesセクションには、起動する3つのコンテナを定義しています。

サービス名 役割 説明
db データベース層 MySQLコンテナ。ノートデータを永続化する
api アプリケーション層 FastAPIコンテナ。REST APIを提供する
front プレゼンテーション層 Nginxコンテナ。ノート管理画面を表示する

2. dbサービスの設定

db:
  image: mysql:8.0
  command: --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
  environment:
    MYSQL_ROOT_PASSWORD: rootpass
    MYSQL_DATABASE: notedb
    MYSQL_USER: noteuser
    MYSQL_PASSWORD: notepass
  volumes:
    - db-data:/var/lib/mysql
    - ./db/init.sql:/docker-entrypoint-initdb.d/init.sql
  healthcheck:
    test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-prootpass"]
    interval: 10s
    timeout: 5s
    retries: 5

各設定を解説します。

image: mysql:8.0

imageで使用するDockerイメージを指定しています。ここではMySQLの公式イメージのバージョン8.0を使用します。

environment:
  MYSQL_ROOT_PASSWORD: rootpass
  MYSQL_DATABASE: notedb
  MYSQL_USER: noteuser
  MYSQL_PASSWORD: notepass

environmentで、MySQLコンテナの初期設定に必要な環境変数を指定しています。MYSQL_DATABASEを指定すると、コンテナ初回起動時にそのデータベースが自動的に作成されます。MYSQL_USERとMYSQL_PASSWORDで、アプリケーションがデータベースに接続するためのユーザを作成しています。

volumes:
  - db-data:/var/lib/mysql
  - ./db/init.sql:/docker-entrypoint-initdb.d/init.sql

volumesで、コンテナ内のデータをホスト側に保存する設定をしています。1行目のdb-data:/var/lib/mysqlは、MySQLのデータを名前付きボリュームに保存することで、コンテナを削除してもデータが失われないようにしています。2行目は、db/init.sqlをMySQLの初期化ディレクトリにマウントしています。これにより、コンテナ初回起動時にテーブル作成とテストデータ投入が自動で実行されます。

📝 MySQLの初期化スクリプトについて
MySQLの公式イメージは、コンテナ初回起動時に/docker-entrypoint-initdb.d/ディレクトリ内のSQLファイルを自動的に実行します。この仕組みを利用することで、テーブル作成やデータ投入を自動化できます。
healthcheck:
  test: ["CMD", "mysqladmin", "ping", "-h", "localhost", "-u", "root", "-prootpass"]
  interval: 10s
  timeout: 5s
  retries: 5

healthcheckは、コンテナの状態を定期的に確認するための設定です。mysqladmin pingコマンドを使って、MySQLが正常に応答するかをチェックしています。MySQLは起動に時間がかかるため、この設定がないと後述するAPIサーバがデータベース接続に失敗することがあります。

3. apiサービスの設定

api:
  build: ./api
  ports:
    - "8000:8000"
  environment:
    DB_HOST: db
    DB_USER: noteuser
    DB_PASSWORD: notepass
    DB_NAME: notedb
  depends_on:
    db:
      condition: service_healthy

各設定を解説します。

build: ./api

buildで、Dockerイメージをビルドするディレクトリを指定しています。./apiディレクトリ内のDockerfileをもとにイメージが作成されます。

ports:
  - "8000:8000"

portsで、ホストの8000番ポートをコンテナの8000番ポートに転送しています。これにより、ブラウザからhttp://localhost:8000でAPIにアクセスできるようになります。

environment:
  DB_HOST: db
  DB_USER: noteuser
  DB_PASSWORD: notepass
  DB_NAME: notedb

environmentで、APIがデータベースに接続するための情報を環境変数として渡しています。DB_HOSTにはdbというサービス名を指定しています。Docker Composeでは、同じネットワーク内のサービス同士はサービス名で通信できるため、IPアドレスではなくサービス名を使います。

depends_on:
  db:
    condition: service_healthy

depends_onで、サービスの起動順序を制御しています。condition: service_healthyを指定することで、dbサービスのhealthcheckが成功するまでAPIの起動を待機させています。これにより、MySQLが完全に起動してからAPIが接続を試みるようになります。

4. frontサービスの設定

front:
  build: ./front
  ports:
    - "3000:80"
  depends_on:
    - api

各設定を解説します。

build: ./front

buildで、./frontディレクトリのDockerfileからフロントエンド用のイメージをビルドします。

ports:
  - "3000:80"

portsで、ホストの3000番ポートをコンテナの80番ポートに転送しています。Nginxはコンテナ内で80番ポートで動作するため、ブラウザからはhttp://localhost:3000でアクセスできるようになります。

depends_on:
  - api

depends_onで、apiサービスが起動してからフロントエンドを起動するように順序を指定しています。

5. volumesセクション

volumes:
  db-data:

db-dataという名前付きボリュームを定義しています。このボリュームにMySQLのデータが保存されるため、コンテナを削除してもデータは保持されます。