Tiltfile の prune 設定に苦労した話

こんにちは。たかしです。

Tilt イメージが無限に溜まって困った話と、解決法の備忘録です。

※要点をわかりやすくするために、必要最低限の設定にしています。

・docker_prune_settings を使えば定期的にイメージを掃除してくれる。

・max_age_mins に0を指定すると prune が動作しないため、かならず1以上を指定する。

docker_prune_settings の公式リファレンス：

　https://docs.tilt.dev/api.html#api.docker_prune_settings

コード変更時のコンテナの更新を自動化してくれます。

compose.yaml で volume を設定して bind mount するのと同じような感じです。

bind mount と違うのは以下のような点です。

・kubernetes リソースに対しても利用可能

・Dockerfile 等のマニフェストファイルの変更も監視/自動更新してくれる

Tilt 公式：

　https://tilt.dev

当時 Tilt で扱っていたイメージの一つに、2GBくらいのサイズを持つ playwright イメージがありました。Tilt はコンテナ更新の際、古いイメージを残して新しいイメージを生成・適用するといった振る舞いをします。

つまり、e2e テストを変更するたびに2GBのイメージが build されていたのです。

当時の私は wsl 上で docker を動かしていたので、該当イメージを削除後に diskpart とかいう謎のディスク領域解放コマンドを打つことで対処する形をとっていました。

別に仕事ではなかったので適当な気持ちでおこなっていたのですが、diskpart は中々リスキーなコマンドです。

さすがにまずいかなと思った私は、イメージの自動クリーンアップの方法を求めて公式リファレンスにて解決方法を探すことにしました。

イメージのクリーンアップ方法は簡単に見つかりました。どうやら docker_prune_settings というものを使えば自動で古いイメージを削除できるようです。

パラメータも少ないし、簡単に設定できそうだなと、このときは思っていました。

以下が問題を再現した Tiltfile です。

論点が分かりやすいように、必要最低限の構成にしてあります。注目すべきはやはり、docker_prune_settings ですね。

以下はこの関数のパラメータ仕様です。

・disable：true なら Docker Pruner を無効化する。

・max_age_mins：イメージ/コンテナの最大保存期間を設定する。

・num_builds: ここに設定した回数のビルドが実行されるたび prune を実行する

・keep_recent: prune 実行時に最新何件までを残すかを設定する。

パラメータ情報をそのまま受け取ると、先ほどの docker_prune_settings の挙動は次のようになります。

「ビルドが1回起こるたびに0分以上生存していたイメージを全て削除する」

Git を使っていれば開発用イメージの履歴は不要ですので、過去のイメージは全て削除する設定にしています。

tilt up で実行して挙動を確認していきましょう。

まず、起動直後のイメージ数を見ていきます。

起動直後は2つのイメージが表示されていますね。ImageID が同じなので、両方同じイメージを参照していることになります。つまり、実際にはイメージは1つしか生成されていません。

ここまでは問題ないですね。

ソースコードに2回ほど変更を加えて、再度イメージの数を確認します。

過去のすべてのイメージが削除されるはずなので、先ほどとは別のイメージが1つだけ存在しているはずです。

…おかしい。

無限に増殖するイメージ。

私は絶望し、この世に生まれたことを後悔しました。

「もう、アイツには勝てない…。」

私の心の弱い部分が、囁きかけてきます。

私は Tiltfile に敗北しました。そして再び、diskpart でイメージを削除する生活に戻っていったのです…。

あれから2週間。私は頭を冷やしました。

冷静に考えれば、docker_prune_settings が公式ドキュメントに存在する以上、正しく設定すれば動くはずなのです。私は決意を胸に、再度 docker_prune_settings と向き合ってみることにしました。

そして20分ほどの激闘の末、私は真理にたどり着くことになります。

違いはそう、max_age_mins です。コイツが問題でした。

なぜ0だと動かないのかはめんどくさくて検証していませんが、保存期間がデフォルトの360分になるか、保存期間が無限のような挙動になるかのどちらかだと思います。

挙動を確認するため、再度実行してみます。

先ほどと同じ、1つのイメージが生成されています。

すぐにソースコードに2回ほど変更を加えて、イメージの数を確認します。

3つのイメージが出現しました。max_age_mins を1に設定したので、まだイメージは削除されていません。

1分待った後、再度変更を加えます。

無事、イメージが消えました！

これで diskpart とはおさらばです。

公式ドキュメントは信頼しましょう。

以上、たかしでした。