Docker Composeでスタックを簡素化するためのサービスプロファイルの使い方
Docker Composeは、サービスの選択的使用のためのプロファイルをサポートするようになりました。docker-compose.yml内のサービスは、1つ以上の名前付きプロファイルにリンクできます。プロファイル名をdocker-compose upに渡すと、そのプロファイルにあるサービスだけが起動され、特定の環境や構成のためにスタックのバリアントを作成することができます。
Composeは以前、アプリケーションの標準的な配布である単一のスタックを定義することに注力してきました。プロファイルにより、スタックのどの部分を使用するかをカスタマイズする余地が増え、複雑なサービスのセットをよりモジュラーで設定可能にします。
なぜプロフィールを使用するのか?
プロファイルの使用は完全に任意です。既存のDocker Composeファイルは引き続き機能し、すぐにプロファイルを採用する必要はありません。
サービスプロファイルは、Docker Composeの開発とテストフローに関するいくつかの一般的なフラストレーションを解決します。デバッグコンテナやログサービスなど、開発中にのみ使用したいサービスがあるかもしれません。本番環境では、これらのサービスは必要なく、それらを起動することを避けたいと思うでしょう。
以前は、これを達成するためには、サービス定義を複数のファイルに分割する必要がありました。その後、扱いにくいものが必要でした。
up開発を開始するためのコマンド:
docker-compose.yml
version: "3"
services:
app:
image: my-app:latest
docker-compose-dev.yml
version: "3"
services:
debug:
image: my-app-debug:latest
start in production
docker-compose up -d
start in development
docker-compose -f docker-compose.yml -f docker-compose-dev.yml up -d
プロファイルを使用すると、両方のサービス定義を1つのファイルにまとめることができます。特定のプロファイルを選択するためにフラグや環境変数を使用でき、手動でファイルパスを入力する必要がありません。これにより、ドキュメント作成、記述、および実行がより便利で手間のかからない体験が提供されます。
プロファイルの定義
プロフィールは、あなたの docker-compose.yml 内のサービスで profiles フィールドを設定することによって作成されます。プロフィールはリストとして指定されます。各サービスには1つまたは複数のプロフィールを割り当てることができます。
version: "3"
services:
app:
image: my-app:latest
debug:
image: my-app-debug:latest
profiles:
- dev
プロファイルインスタンスは、profilesフィールドに付けられた名前から暗黙的に作成されます。プロファイルを共有するサービスは自動的に結合されます。
プロファイルに含まれるサービスを開始するには、docker-compose upに--profileフラグを追加します:
docker-compose up --profile devこのコマンドは、上記のComposeファイルからappサービスとdebugサービスの両方を起動します。もしdocker-compose upを実行し、--profileフラグを省略した場合、appサービスのみが起動します。
複数のプロファイルを同時に開始するには、--profileフラグを繰り返します。また、Composeは--profileの代わりにCOMPOSE_PROFILES環境変数もサポートしています。これは、カンマ区切りのプロファイル名のリストを受け入れます。
「profiles」フィールドがないサービスは、要求されたプロファイルに関係なく常に起動します。一度サービスにプロファイルが設定されると、そのプロファイルが要求された場合にのみ起動します。複数のプロファイルを持つサービスでは、そのうちのどれか一つを要求すれば、そのサービスを起動することができます。
暗黙のプロフィールが開始します
プロファイルは、docker-compose runを使用して手動でサービスを開始した場合、常に無視されます。この場合、Composeは、要求されたサービスが依存しているサービスも開始します。それらがプロファイルを共有しているか、プロファイルが割り当てられていない場合です。
ここで、docker-compose run debugを実行すると、debug-utilsサービスが開始されますが、devプロファイルは明示的に選択されていません。
version: "3"
services:
app:
image: my-app:latest
debug-utils:
image: my-app-debug-utils:latest
profiles:
- dev
debug:
image: my-app-debug:latest
depends_on: debug-utils
profiles:
- dev
暗黙のスタートは、指定されたサービスの直接の依存関係にのみ適用されます。もしdebug-utilsがdepends_onを持っていて、そのサービスがdevプロファイルを共有していなかった場合、正しく起動しません。
依存関係の解決が正しく機能するためには、docker-compose runで、ツリー内のすべてのサービスが最上位サービスのプロファイルを共有するか、常に有効になっている必要があります。どちらの条件も満たさない場合は、必要な追加のプロファイルを明示的にアクティブにするために、--profileフラグを追加する必要があります。
要約
サービスプロファイルは、さまざまなサービスの組み合わせを管理しやすくする便利なCompose機能です。プロファイルを使用することで、サービスを複数のComposeファイルに分割することを避けられます。--profileを追加することは、複数のYAMLファイルを統合するよりも、通常はより自然に感じられます。
プロファイルを使用すると、メインのComposeアプリケーション内にサブスタックを構築できます。Compose仕様の一部としての導入は、開発中のスタックが本番環境で使用されるもの以外の追加サービスを統合することが多いという認識の表れです。
一般的に、プロファイルはスタックのカスタマイズを容易にすることにより、Composeをより多機能にします。環境管理のアプローチとして考案されましたが、プロファイルはコミュニティが人気の画像の異なるバリエーションを作成するのにも役立つかもしれません。WordPressのdocker-compose.ymlがmysqlとmariadbプロファイルを持っていることを考えてみてください。これにより、好みに合ったエンジンを選択するために、事前に構成されたデータベースサービスの間で簡単に切り替えることができます。
Docker Compose 1.28は、今年初めにプロファイルを導入しました。最近のComposeバイナリ、またはWindowsおよびMac用のDocker Desktopを持っていれば、Composeファイルにprofilesを追加してサービスを選択的に有効にすることができます。
