Docker compose 実行構成

名前

実行構成の名前を指定して、編集または実行時に他の構成の間ですばやく識別できるようにします。

Allow multiple instances

この実行構成の複数のインスタンスを並行して実行できるようにします。

デフォルトでは無効になっており、別のインスタンスがまだ実行されているときにこの構成を開始すると、PyCharm は実行中のインスタンスを停止して別のインスタンスを開始することを提案します。 これは、実行構成が多くのリソースを消費し、複数のインスタンスを実行する正当な理由がない場合に役立ちます。

プロジェクトファイルとして保存

実行構成設定を含むファイルを保存して、他のチームメンバーと共有します。 デフォルトの場所は .idea/runConfigurations です。 ただし、 .idea ディレクトリを共有したくない場合は、プロジェクト内の他のディレクトリに構成を保存できます。

デフォルトでは無効になっており、PyCharm は実行構成設定を .idea/workspace.xml に保存します。

サーバー

実行構成に使用する Docker デーモン接続を選択します。

Compose files

必要なサービスを定義する作成ファイルを指定します。 Docker Compose は指定された順序で構成を構築するため、後続のファイルはすべてオーバーライドされ、前のファイルの同じサービスのフィールドに追加されます。

これは、 docker compose コマンドで -f オプションを使用するのと似ています。

サービス

構築、作成、開始するサービスを指定します。

をクリックして、YML ファイルにリストされているサービスを選択します。

起動前

実行構成を開始する前に実行するタスクのリストを指定します。 例: 別の構成を実行し、必要なアーティファクトを構築し、外部ツールまたは Web ブラウザーを実行します。

をクリックするか、 Alt+Insert を押して、使用可能なタスクの 1 つを追加します。

および を使用してリスト内のタスクを移動し、タスクを実行する順序を変更します。 タスクを選択し、 をクリックしてタスクを編集します。 をクリックして、選択したタスクをリストから削除します。

Show this page

実際に起動する前に、実行構成設定を表示します。

Activate tool window

Depending on the type of configuration, open the Run, Debug, or Services tool window when you start this run configuration. このオプションが無効になっている場合は、ツールウィンドウを手動で開くことができます。

• 表示 | ツールウィンドウ | 実行 または Alt+4

• View | Tool Windows | Debug または Alt+5

• View | Tool Windows | Services または Alt+8

ツールウィンドウにフォーカス

テストの実行中は、実行構成ツールウィンドウにフォーカスを当てます。

Specify project name

Docker Compose の代替プロジェクト名を指定します。 デフォルトでは、現在のディレクトリの名前になります。

これは、 docker compose コマンドで -p オプションを使用するのと似ています。

Profiles

アプリケーション内のさまざまな環境またはユースケースの プロファイル(英語)を指定します。

プロファイルを使用すると、サービスをグループ化して必要な場合にのみアクティブ化できるため、単一の compose.yml ファイルで複数のシナリオ (開発、デバッグ、本番など) をサポートできます。

複数のプロファイルを指定するには、コンマを使用して区切ります。

環境変数

Docker Compose 環境変数(英語)を指定します。 これらは Docker Compose プロセスでのみ使用されます。 それらはどのコンテナーにも渡されません。

Environment variables files

Docker Compose 環境変数(英語)を定義するカスタム 環境ファイル(英語)へのパスを指定します。

これは、 docker compose コマンドで --env-file オプションを使用するのと似ています。

デフォルトでは、 Docker Compose 実行構成は、Docker Compose ファイルを含むディレクトリで .env という名前のファイルを探します。

Enable compatibility mode

v3 サービス定義を v2 互換パラメーターに変換します。

これは、 docker compose コマンドで --compatibility オプションを使用するのと似ています。

Remove orphans on `down`

アプリケーションを停止するときに、現在の Compose ファイルで定義されていないサービスのコンテナーを削除します。

Remove volumes on `down`

コンテナーを停止および削除するときは、Docker Compose ファイルで宣言されている名前付きボリュームおよびコンテナーに接続されている匿名ボリュームも削除します。

これは、 docker compose down コマンドで -v または --volumes オプションを使用するのと似ています。

Remove images on `down`

コンテナーを停止および削除するときに削除するイメージを構成します。 サービスで使用されているすべてのイメージを削除するか、 image フィールドにカスタムタグが設定されていないイメージのみを削除するかを選択できます。

これは、 docker compose down コマンドで --rmi オプションを使用するのと似ています。

SIGKILL timeout

正常にシャットダウンしないコンテナーを強制的に終了するには、タイムアウトを秒単位で設定します。

Docker はまず SIGTERM を使用して正常なシャットダウンを試行しますが、コンテナーは無期限に実行を続ける可能性があります。 タイムアウトを設定し、その時間が経過すると Docker は SIGKILL を発行して強制シャットダウンを実行します。

これは、 docker compose up コマンドで -t または --timeout オプションを使用するのと似ています。

Return exit code

選択したサービスコンテナーの終了コードを返します。

選択したサービス内のコンテナーが停止するたびに、その終了コードを返し、サービス内の他のすべてのコンテナーを停止します。

これは、 docker compose up コマンドで --exit-code-from および --abort-on-container -exit オプションを使用するのと似ています。

Override scale

各サービスで開始するコンテナー数を設定します。

このオプションは、Docker Compose ファイルに scale パラメーターが存在する場合、それをオーバーライドします。

これは、 docker compose up コマンドで --scale オプションを使用するのと似ています。

Recreate dependencies

サービスの開始時に依存コンテナーを再作成します。

これは、 docker compose up コマンドで --always-recreate-deps オプションを使用するのと似ています。

Recreate anonymous volumes

以前のコンテナーからデータを取得するのではなく、匿名ボリュームを再作成します。

これは、 docker compose up コマンドで -V または --renew-anon-volumes オプションを使用するのと似ています。

Remove orphans

Docker Compose ファイルで定義されていないサービスのコンテナーを削除します。

これは、 docker compose up コマンドで --remove-orphans オプションを使用するのと似ています。

Don't print prefix in logs

ログ出力でサービス名接頭辞を無効にすると、よりクリーンでシンプルなログが生成されます。

開始

起動するサービスを構成します：

• Selected and dependencies: デフォルトでは、Docker Compose は指定されたすべてのサービスとリンクされたサービスを開始します。

• なし: サービスを作成した後は、サービスを開始しないでください。 これは、 docker compose up コマンドで --no-start オプションを使用するのと似ています。

• Selected services: リンクされたサービスを開始しないでください。 これは、 docker compose up コマンドで --no-deps オプションを使用するのと似ています。

Attach to

出力ストリームを表示するコンテナーを構成します：

• Selected services: デフォルトでは、Docker Compose は、指定されたサービスの開始されたすべてのコンテナーに接続します。

• なし: コンテナーに取り付けないでください。 これは、 docker compose up コマンドで -d または --detach オプションを使用するのと似ています。

• Selected and dependencies: 指定されたサービスおよびリンクされたサービスのコンテナーにアタッチします。 これは、 docker compose up コマンドで --attach-dependencies オプションを使用するのと似ています。

Recreate containers

どのコンテナーを停止して新しいコンテナーと置換するかを構成します：

• Changed configuration: デフォルトでは、Docker Compose は、対応する構成またはイメージが変更された場合にのみコンテナーを再作成します。

• すべて: 対応する構成またはイメージが変更されていない場合でも、サービス内のすべてのコンテナーを再作成します。 これは、 docker compose up コマンドで --force-recreate オプションを使用するのと似ています。

• なし: 対応する構成が変更された場合でも、サービス内のコンテナーを再作成しないでください。 これは、 docker compose up コマンドで --no-recreate オプションを使用するのと似ています。

Build

コンテナーを起動する前にビルドするイメージを構成します：

• Only missing images: デフォルトでは、Docker Compose は使用できないイメージのみをビルドし、可能な場合は以前にビルドしたイメージを使用します。

• なし: イメージを作成しないでください。 以前に作成したイメージを常に使用するか、一部のイメージが利用できない場合はエラーをスローします。 これは、 docker compose up コマンドで --no-build オプションを使用するのと似ています。

• 常に: コンテナーを起動する前に、必ずイメージを作成します。 これは、 docker compose up コマンドで --build オプションを使用するのと似ています。

Stop Containers

サービス内のコンテナーを停止する方法を構成します。 デフォルトでは、Docker Compose はサービス内の他のコンテナーを停止しません。 手動で停止する必要があります。

ただし、サービス内のいずれかのコンテナーが停止した場合は、すべてのコンテナーを停止することを選択できます。 これは、 docker compose up コマンドで --abort-on-container-exit オプションを使用するのと似ています。