Docker Composeコマンド
続いて、Docker Composeに関連するコマンドを見ていきたいと思います。
1. docker compose up
定義されたサービスを起動します。
1.1 docker composeの起動
docker compose up
このコマンドを実行すると、compose.yamlに定義されたすべてのサービスが起動します。必要なネットワークは自動的に作成され、depends_onで指定された順序でコンテナが起動します。フォアグラウンドで実行されるため、各コンテナのログがまとめて表示されます。
1.2 バックグラウンドでの起動
バックグラウンドで起動する場合は-d(detached)オプションを付けます。
docker compose up -d
-dオプションを付けると、コンテナがバックグラウンドで起動し、ターミナルの制御がすぐに戻ります。ログを確認したい場合はdocker compose logsを使用します。
2. docker compose down
起動中のサービスを停止し、コンテナとネットワークを削除します。
docker compose down
このコマンドを実行すると、すべてのサービスのコンテナを停止し、停止したコンテナを削除します。さらに、Docker Composeが作成したネットワークも削除されます。
| 💡 ポイント |
|---|
ボリュームも一緒に削除する場合はdocker compose down -vを使用します。-vオプションを付けると、名前付きボリュームも削除されます。データベースのデータなど、永続化されたデータが完全に削除されるため、注意が必要です。 |
3. docker compose ps
サービスの状態を確認します。
docker compose ps
このコマンドを実行すると、現在のプロジェクトに属するコンテナの一覧と状態が表示されます。
NAME IMAGE COMMAND SERVICE STATUS
project-api-1 project-api "python app.py" api Up 2 minutes
project-db-1 mysql:8.0 "docker-entrypoint..." db Up 2 minutes (healthy)
project-web-1 nginx:alpine "/docker-entrypoint..." web Up 2 minutes
表示される情報は以下のとおりです。
| 項目 | 説明 |
|---|---|
| NAME | コンテナ名(プロジェクト名-サービス名-番号) |
| IMAGE | 使用しているイメージ |
| SERVICE | compose.yamlで定義したサービス名 |
| STATUS | コンテナの状態(Up/Exited/healthyなど) |
4. docker compose logs
サービスのログを表示します。
4.1 ログの全体出力
docker compose logs
このコマンドを実行すると、すべてのサービスのログがまとめて表示されます。各行の先頭にはサービス名が表示されるため、どのコンテナからのログかを識別できます。
db-1 | 2024-01-15 10:00:00 [Note] mysqld: ready for connections.
api-1 | INFO: Application startup complete.
web-1 | 172.18.0.1 - - "GET / HTTP/1.1" 200 612
リアルタイムでログを監視する場合は-f(follow)オプションを付けます。
docker compose logs -f
-fオプションを付けると、新しいログが出力されるたびに画面に表示されます。Ctrl + Cで監視を終了します。
4.2 特定サービスのログの出力
特定のサービスのログだけを表示する場合は、サービス名を指定します。
docker compose logs api
この例では、apiサービスのログのみが表示されます。
5. docker compose exec
起動中のサービス内でコマンドを実行します。
5.1 基本的な使い方
docker compose exec db mysql -u root -p
この例では、dbサービス(MySQLコンテナ)内でMySQLクライアントを起動し、データベースに接続します。
5.2 コマンドの構成
db: compose.yamlで定義したサービス名mysql -u root -p: コンテナ内で実行するコマンド(MySQLにrootユーザで接続)
実行すると、パスワードの入力を求められます(MYSQL_ROOT_PASSWORDで設定した値を入力)。
5.3 対応するDockerコマンド
docker container exec -it <コンテナ名> mysql -u root -p
6. docker compose build
Dockerfileを使用するサービスのイメージを(再)ビルドします。
docker compose build
このコマンドは、compose.yamlでbuildオプションを指定しているサービスのイメージをビルドします。imageオプションのみを使用しているサービス(既存のイメージを使う場合)は対象外です。
services:
api:
build: ./api # ← このサービスがビルド対象
db:
image: mysql:8.0 # ← このサービスはビルド対象外
特定のサービスだけをビルドする場合は、サービス名を指定します。
docker compose build api
ソースコードを変更した後、イメージを再ビルドして反映させたい場合に使用します。