[docker compose] long syntax の時に delegated を指定する

Tech

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

[docker compose] long syntax の時に delegated を指定する

Mac の Docker が遅くて、:delegated を付けて回っていた時期がありました。ショートハンドならお尻に付けるだけですが、long syntax に書き換えたら「どこに書くんだっけ」となったのでメモ。

書き方

従来のショートハンドで

volumes:
  - ${PROJECT_ROOT}:/var/:delegated

と書いていたものは、long syntax ではこうなります。

services:
  container:
    image: busybox
    volumes:
      - type: bind
        source: ${PROJECT_ROOT}
        target: /var/
        read_only: false
        consistency: delegated

consistency オプションで指定します。cached の場合も同じく consistency: cached。

各モードの意味

モードどちらが正向いている用途
consistent(デフォルト)ホストとコンテナが常に同じ確実さ優先
cachedホスト側が正。コンテナへの反映が遅れてもよいソースコードの読み込み中心
delegatedコンテナ側が正。ホストへの反映が遅れてもよいビルド成果物・キャッシュ・ログなど、コンテナが書き込む中心

今はもう付けなくていい

ここが一番大事なところで、cached / delegated は Docker Desktop for Mac の古いファイル共有方式(osxfs)が遅かった時代のための最適化でした。その後、gRPC FUSE、さらに VirtioFS へとファイル共有の仕組みが置き換わり、今の Docker Desktop ではこれらのフラグを付けても基本的に効果はありません。Linux ではもともと関係ない設定です。

  • 古い compose ファイルに書いてあっても、そのままで害はない
  • 新しく書くなら付けなくてOK
  • Mac で遅さに困っているなら、Docker Desktop の設定で VirtioFS が選ばれているかを確認する方が効きます

long syntax の他のオプション

せっかくなので、よく使うものを並べておきます。

volumes:
  - type: bind
    source: ./src
    target: /app/src
    read_only: true          # コンテナから書き込ませない
  - type: volume
    source: db-data          # 名前付きボリューム
    target: /var/lib/mysql
  - type: tmpfs
    target: /tmp             # メモリ上の一時領域

ショートハンドより行数は増えますが、何をマウントしているかが一目で分かるのが long syntax の良いところ。チームで触る compose ファイルほど効いてきます。

まとめ

  • long syntax では consistency: delegated(または cached)で指定する
  • cached はホスト優先、delegated はコンテナ優先
  • ただし現行の Docker Desktop では基本的に不要。遅いなら VirtioFS を確認

参考リンク

docker-compose