Docker Compose のビルド プロパティ

「コンテナー ツールのビルド プロパティ」で説明している、個々の Docker プロジェクトを制御するプロパティに加え、ソリューション構築のために MSBuild で使用される Docker Compose プロパティを設定することで、Visual Studio による Docker Compose プロジェクトのビルド方法をカスタマイズすることもできます。 Docker Compose 構成ファイルでファイル ラベルを設定することで、Visual Studio デバッガーによる Docker Compose アプリの実行方法を制御することもできます。

MSBuild プロパティの設定方法

プロパティの値を設定するには、プロジェクト ファイルを編集します。 Docker Compose プロパティの場合、このプロジェクト ファイルは、次のセクションの表で特に示されていない限り、 .dcproj 拡張子を持つファイルです。 たとえば、デバッグを開始するときにブラウザーを起動するように指定するとします。 .dcproj プロジェクト ファイルの DockerLaunchAction プロパティは、次のように設定できます。

<PropertyGroup>
   <DockerLaunchAction>LaunchBrowser</DockerLaunchAction>
</PropertyGroup>

プロパティ設定を、既存の PropertyGroup 要素に追加できます。存在しない場合は、新しい PropertyGroup 要素を作成できます。

Docker Compose MSBuild のプロパティ

次の表は、Docker Compose プロジェクトで使用できる MSBuild プロパティを示しています。

例

DockerComposeBaseFilePathを相対パスに設定して、docker-compose ファイルの場所を変更する場合は、ソリューション フォルダーを参照するようにビルド コンテキストが変更されていることを確認する必要もあります。 たとえば、 docker-compose ファイルが DockerComposeFiles という名前のフォルダーである場合、Docker Compose ファイルはビルド コンテキストを ".." または ".に設定する必要があります。/.."。ソリューション フォルダーに対する相対位置に応じて異なります。

<?xml version="1.0" encoding="utf-8"?>
<Project ToolsVersion="15.0" Sdk="Microsoft.Docker.Sdk">
  <PropertyGroup Label="Globals">
    <ProjectVersion>2.1</ProjectVersion>
    <DockerTargetOS>Windows</DockerTargetOS>
    <ProjectGuid>154022c1-8014-4e9d-bd78-6ff46670ffa4</ProjectGuid>
    <DockerLaunchAction>LaunchBrowser</DockerLaunchAction>
    <DockerServiceUrl>{Scheme}://{ServiceIPAddress}{ServicePort}</DockerServiceUrl>
    <DockerServiceName>webapplication1</DockerServiceName>
    <DockerComposeBaseFilePath>DockerComposeFiles\mydockercompose</DockerComposeBaseFilePath>
    <AdditionalComposeFilePaths>AdditionalComposeFiles\myadditionalcompose.yml</AdditionalComposeFilePaths>
  </PropertyGroup>
  <ItemGroup>
    <None Include="DockerComposeFiles\mydockercompose.override.yml">
      <DependentUpon>DockerComposeFiles\mydockercompose.yml</DependentUpon>
    </None>
    <None Include="DockerComposeFiles\mydockercompose.yml" />
    <None Include=".dockerignore" />
  </ItemGroup>
</Project>

ビルド コンテキストがソリューション フォルダーの相対パスに設定された状態 (この場合は ..) では、mydockercompose ファイルは次のようになります。

version: '3.4'

services:
  webapplication1:
    image: ${DOCKER_REGISTRY-}webapplication1
    build:
      context: ..
      dockerfile: WebApplication1\Dockerfile

Visual Studio の Docker Compose 構成のオーバーライド

通常、docker-compose.override.yml は docker-compose.yml の特定の設定をオーバーライドするために使用されます。 さらに、Visual Studio では、(Fast モードの場合) docker-compose.vs.debug.g.ymlオーバーライド ファイルとdocker-compose.vs.release.g.yml (Regular モードの場合) ファイルが生成され、Visual Studio 内でのアプリケーションの実行に固有の設定が含まれます。 docker-compose.yml ファイルと同じディレクトリ内に docker-compose.vs.debug.yml (Fast モードの場合) または docker-compose.vs.release.yml (Regular モードの場合) という名前のファイルを置くことによって、このような Visual Studio の設定をオーバーライドできます。 Docker Compose プロジェクトを右クリックし、エクスプローラーで [フォルダーを開く] 選択し、Add>Existing Item を使用してファイルを Docker Compose プロジェクトに追加します。

Docker Compose ファイル ラベル

docker-compose.vs.debug.yml または docker-compose.vs.release.yml で、オーバーライド固有のラベルを次のように定義できます。

services:
  webapplication1:
    labels:
      com.microsoft.visualstudio.debuggee.workingdirectory: "C:\\my_app_folder"

前の例のように値を二重引用符で囲み、パスでバックスラッシュのエスケープ文字としてバックスラッシュを使用します。

Docker ビルド プロセスをカスタマイズする

build プロパティの target 設定を使用して、Dockerfile でどのステージをビルドするかを宣言できます。 このオーバーライドは、docker-compose.vs.debug.yml または docker-compose.vs.release.yml でのみ使用できます。

services:
  webapplication1:
    build:
      target: customStage
    labels:
      ...

アプリのスタートアップ プロセスをカスタマイズする

entrypoint 設定を使用し、それを DockerDevelopmentMode に依存させることによって、アプリの起動前にコマンドまたはカスタム スクリプトを実行できます。 たとえば、update-ca-certificates を実行することによって (Regular モードではなく) Fast モードでのみ証明書を設定する必要がある場合は、次のコードをdocker-compose.vs.debug.yml にのみ追加することができます。

services:
  webapplication1:
    entrypoint: "sh -c 'update-ca-certificates && tail -f /dev/null'"
    labels:
      ...

詳細については、「 Container エントリ ポイント」を参照してください。

次のステップ

MSBuild プロパティの一般情報については、MSBuild プロパティを参照してください。

関連項目

コンテナー ツールのビルド プロパティ

コンテナー ツールの起動設定

Visual Studio で Docker Compose の起動プロファイルを管理する

MSBuild の予約済みおよび既知のプロパティ