[docker compose] down --rmi all --volumes --remove-orphans で環境を丸ごと消す

Tech

※ 本記事はアフィリエイト広告(Amazonアソシエイト)を含みます。

[docker compose] down --rmi all --volumes --remove-orphans で環境を丸ごと消す

docker compose で立てた環境を一旦クリーンにしたいとき。バルス。

docker compose down --rmi all --volumes --remove-orphans

依存を入れ直したのに挙動が変わらない、DBの初期化SQLが流れない、どこかに古いコンテナが残っている気がする——そういうときに「全部消して最初から」をやるための呪文です。

ℹ️ 以前は docker-compose(ハイフンあり)と書いていましたが、今は Docker 本体に統合された docker compose(スペース区切り)が標準です。旧来の docker-compose でもオプションは同じです。

何が消えるのか

素の docker compose down と、オプションを足したときの違いです。

コマンド / オプション消えるもの
down(オプションなし)コンテナ、compose が作ったネットワーク
--rmi all+ サービスが使っているイメージすべて(pull したものも含む)
--rmi local+ image: にタグ指定がない、ローカルでビルドしたイメージだけ
--volumes(-v)+ volumes: で定義した名前付きボリュームと匿名ボリューム
--remove-orphans+ compose ファイルから消したサービスの、取り残されたコンテナ

一番の注意点: --volumes は DB のデータも消す

MySQL や PostgreSQL のデータを名前付きボリュームに置いている場合、--volumes を付けるとデータは完全に消えます。ローカルの検証用DBならむしろそれが目的ですが、手で入れたテストデータを残したいときは --volumes を外すこと。

# データは残して、コンテナとイメージだけ作り直す
docker compose down --rmi local
docker compose up -d --build

--remove-orphans はどんなときに効く?

compose ファイルからサービスを削除したり名前を変えたりすると、前のコンテナが「孤児(orphan)」として残ります。up のときに

WARN Found orphan containers ([xxx]) for this project.

と警告が出ていたら、これを付けると掃除できます。

使い分けメモ

  • 普段の停止: docker compose down(または stop)だけで十分
  • 自分でビルドしたイメージを作り直したい: --rmi local。pull し直しが不要なぶん速い
  • 本当に最初からやり直したい: 冒頭の全部入り
  • プロジェクトに関係なく、マシン全体の不要物を掃除したい: docker system prune の出番

まとめ

  • docker compose down --rmi all --volumes --remove-orphans で、そのプロジェクトのコンテナ・ネットワーク・イメージ・ボリュームをまとめて削除
  • --volumes はDBのデータも消える。残したいなら外す
  • イメージは --rmi local にすると、自前ビルド分だけ消せて再構築が速い

困ったらバルス。ただし、唱える前にボリュームの中身だけは思い出してください。

docker-compose