Buildeigenschaften von Docker Compose

Die Eigenschaften zur Verwaltung einzelner Docker-Projekte sind unter Buildeigenschaften von Containertools beschrieben. Diese Eigenschaften können Sie anpassen. Zusätzlich können Sie auch festlegen, wie Visual Studio Docker-Projekte erstellt. Dazu legen Sie die Docker Compose-Eigenschaften fest, die MSBuild zur Erstellung der Projektmappe verwendet. Außerdem können Sie steuern, wie der Visual Studio-Debugger Ihre Docker Compose-Apps ausführt, indem Sie Dateibezeichnungen in Docker Compose-Konfigurationsdateien festlegen.

Festlegen der MSBuild-Eigenschaften

Den Wert einer Eigenschaft legen Sie in der Projektdatei fest. Bei Docker Compose-Eigenschaften ist diese Projektdatei die Datei mit einer .dcproj Erweiterung, sofern nicht anders in der Tabelle im nächsten Abschnitt angegeben. Angenommen, Sie möchten festlegen, dass zu Beginn des Debuggens der Browser gestartet wird. Sie können die DockerLaunchAction Eigenschaft in der .dcproj Projektdatei wie folgt festlegen.

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

Sie können die Eigenschaftseinstellung einem vorhandenen PropertyGroup-Element hinzufügen oder ein neues PropertyGroup-Element erstellen, falls noch keines vorhanden ist.

MSBuild-Eigenschaften für Docker Compose

In der folgenden Tabelle werden die MSBuild-Eigenschaften aufgeführt, die für Docker Compose-Projekte verfügbar sind.

Beispiel

Wenn Sie den Speicherort der docker-compose Dateien ändern, müssen Sie durch Festlegen DockerComposeBaseFilePath auf einen relativen Pfad auch sicherstellen, dass der Buildkontext geändert wird, damit er auf den Lösungsordner verweist. Wenn Ihre docker-compose Datei beispielsweise ein Ordner namens DockerComposeFiles ist, sollte die Docker Compose-Datei den Buildkontext auf "." oder "." festlegen. /..", je nachdem, wo es sich relativ zum Lösungsordner befindet.

<?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>

Die Datei mydockercompose.yml sollte folgendermaßen aussehen, dabei muss der Buildkontext auf den relativen Pfad des Projektmappenordners (in diesem Fall ..) festgelegt sein.

version: '3.4'

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

Außerkraftsetzen der Docker Compose-Konfiguration von Visual Studio

In der Regel wird docker-compose.override.yml verwendet, um bestimmte Einstellung in docker-compose.yml außer Kraft zu setzen. Darüber hinaus generiert Visual Studio Dateien docker-compose.vs.debug.g.yml (für den Schnellmodus) und docker-compose.vs.release.g.yml (für den regulären Modus) Dateien mit Einstellungen, die für die Ausführung der Anwendung in Visual Studio spezifisch sind. Sie können diese Visual Studio-Einstellungen außer Kraft setzen, indem Sie eine Datei namens docker-compose.vs.debug.yml (für den Modus Fast) oder docker-compose.vs.release.yml (für den Modus Regular) im selben Verzeichnis wie die Datei docker-compose.yml ablegen. Klicken Sie mit der rechten Maustaste auf das Docker Compose-Projekt, und wählen Sie "Ordner öffnen" in Explorer aus, und verwenden Sie dann "Vorhandenes Element hinzufügen>", um die Datei ihrem Docker Compose-Projekt hinzuzufügen.

Docker Compose-Dateibezeichnungen

Sie können in docker-compose.vs.debug.yml oder docker-compose.vs.release.yml spezifische Bezeichnungen für das Außerkraftsetzen wie folgt definieren:

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

Setzen Sie wie im vorherigen Beispiel die Werte in doppelte Anführungszeichen, und verwenden Sie den umgekehrten Schrägstrich als Escapezeichen für umgekehrte Schrägstriche in Pfaden.

Anpassen des Docker-Buildprozesses

Mithilfe der Einstellung target in der build-Eigenschaft können Sie deklarieren, welche Stage in Ihrem Dockerfile erstellt werden soll. Diese Außerkraftsetzung kann nur in docker-compose.vs.debug.yml oder docker-compose.vs.release.yml verwendet werden.

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

Anpassen des App-Startvorgangs

Sie können einen Befehl oder ein benutzerdefiniertes Skript vor dem App-Start ausführen, indem Sie es mithilfe der Einstellung entrypoint vom DockerDevelopmentMode abhängig machen. Wenn Sie ein Zertifikat durch Ausführen von update-ca-certificates z. B. nur für den Modus Fast, aber nicht für den Modus Regular einrichten möchten, fügen Sie den folgenden Code nur in der Datei docker-compose.vs.debug.yml hinzu:

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

Weitere Informationen finden Sie unter Containereinstiegspunkt

Nächste Schritte

Weitere allgemeine Informationen zu MSBuild-Eigenschaften finden Sie unter MSBuild-Eigenschaften.

Siehe auch

Buildeigenschaften für Containertools

Starteinstellungen für Containertools

Verwalten von Startprofilen für Docker Compose in Visual Studio

Reservierte und bekannte Eigenschaften für MSBuild