Container Tools-Erweiterung anpassen

Die Container Tools-Erweiterung enthält mehrere Visual Studio Code-Tasks zur Steuerung des Verhaltens von Docker build und run und bildet die Grundlage für den Containerstart zum Debuggen.

Die Tasks ermöglichen eine weitgehende Kontrolle und Anpassung. Die endgültige Konfiguration ist eine Kombination aus allgemeinen Standardwerten, plattformspezifischen Standardwerten (wie Node.js, Python oder .NET) und Benutzereingaben. Benutzereingaben haben Vorrang, wenn sie mit Standardwerten kollidieren.

Alle gängigen Funktionen von Visual Studio Code-Tasks (z. B. Gruppierung von Tasks in zusammengesetzten Tasks) werden von den Container Tools-Erweiterungs-Tasks unterstützt. Weitere Informationen zu gängigen Taskfunktionen und -eigenschaften finden Sie in der Dokumentation zu den benutzerdefinierten Tasks von Visual Studio Code.

Docker Build-Task

Der Task docker-build erstellt Images mithilfe der Docker-Befehlszeile (CLI). Der Task kann eigenständig oder als Teil einer Taskkette zum Ausführen und/oder Debuggen einer Anwendung in einem Container verwendet werden.

Die wichtigsten Konfigurationseinstellungen für den Task docker-build sind dockerBuild und platform

• Das Objekt dockerBuild gibt Parameter für den Docker-Build-Befehl an. Die von diesem Objekt angegebenen Werte werden direkt auf die Docker-Build-CLI-Aufrufung angewendet.
• Die Eigenschaft platform ist ein Hinweis, der beeinflusst, wie der Task docker-build die Docker-Build-Standardwerte bestimmt.

Siehe Eigenschaftenreferenz für die vollständige Liste aller Task-Eigenschaften.

Plattformunterstützung

Während der Task docker-build in tasks.json zum Erstellen beliebiger Images verwendet werden kann, verfügt die Erweiterung über explizite Unterstützung (und vereinfachte Konfiguration) für Node.js, Python und .NET Core.

Node.js (docker-build)

Minimale Konfiguration mit Standardwerten

Ein auf Node.js basierendes Image ohne spezifische Plattformoptionen kann einfach die Eigenschaft platform auf node setzen

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Node Image",
      "type": "docker-build",
      "platform": "node"
    }
  ]
}

Plattformstandardwerte

Für auf Node.js basierende Images leitet der Task docker-build die folgenden Optionen ab

Python (docker-build)

Minimale Konfiguration mit Standardwerten

Ein auf Python basierendes Image ohne spezifische Plattformoptionen kann einfach die Eigenschaft platform auf python setzen

{
  "tasks": [
    {
      "type": "docker-build",
      "label": "docker-build",
      "platform": "python"
    }
  ]
}

Plattformstandardwerte

Für auf Python basierende Images leitet der Task docker-build die folgenden Optionen ab

.NET (docker-build)

Minimale Konfiguration mit Standardwerten

Beim Erstellen eines auf .NET basierenden Images können Sie die Eigenschaft platform weglassen und stattdessen das Objekt netCore festlegen (platform wird implizit auf netcore gesetzt, wenn das Objekt netCore vorhanden ist). Beachten Sie, dass appProject eine erforderliche Eigenschaft ist

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Build Node Image",
      "type": "docker-build",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

Plattformstandardwerte

Für auf .NET basierende Images leitet der Task docker-build die folgenden Optionen ab

Build-Task-Referenz

Hier sind alle Eigenschaften aufgeführt, die zur Konfiguration des Tasks docker-build verfügbar sind. Alle Eigenschaften sind optional, sofern nicht anders angegeben.

Eigenschaften des dockerBuild-Objekts

Eigenschaften des Node-Objekts (Task docker-build)

Eigenschaften des netCore-Objekts (Task docker-build)

Docker Run-Task

Der Task docker-run in tasks.json erstellt und startet einen Container mithilfe der Docker-Befehlszeile (CLI). Der Task kann eigenständig oder als Teil einer Taskkette zum Debuggen einer Anwendung in einem Container verwendet werden.

Die wichtigsten Konfigurationseinstellungen für den Task docker-run sind dockerRun und platform

• Das Objekt dockerRun gibt Parameter für den Docker-Run-Befehl an. Die von diesem Objekt angegebenen Werte werden direkt auf die Docker-Run-CLI-Aufrufung angewendet.
• Die Eigenschaft platform ist ein Hinweis, der beeinflusst, wie der Task docker-run die Docker-Run-Standardwerte bestimmt.

Siehe Eigenschaftenreferenz für die vollständige Liste aller Task-Eigenschaften.

Docker Run-Plattformunterstützung

Während der Task docker-run zum Ausführen beliebiger Docker-Images verwendet werden kann, verfügt die Erweiterung über explizite Unterstützung (und vereinfachte Konfiguration) für Node.js, Python und .NET.

Node.js (docker-run)

Minimale Konfiguration mit Standardwerten

Ein auf Node.js basierendes Image ohne spezifische Plattformoptionen kann einfach die Eigenschaft platform auf node setzen.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run Node Image",
      "node": "docker-run",
      "platform": "node"
    }
  ]
}

Plattformstandardwerte

Für auf Node.js basierende Images leitet der Task docker-run die folgenden Optionen ab

Python (docker-run)

Beim Erstellen eines auf Python basierenden Images können Sie die Eigenschaft platform weglassen und stattdessen das Objekt python festlegen (platform wird implizit auf python gesetzt, wenn das Objekt python vorhanden ist)

Minimale Konfiguration für Django-Apps

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "python": {
    "args": ["runserver", "0.0.0.0:8000", "--nothreading", "--noreload"],
    "file": "path_to/manage.py"
  }
}

Minimale Konfiguration für Flask-Apps

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "dockerRun": {
    "env": {
      "FLASK_APP": "path_to/flask_entry_point.py"
    }
  },
  "python": {
    "args": ["run", "--no-debugger", "--no-reload", "--host", "0.0.0.0", "--port", "5000"],
    "module": "flask"
  }
}

Minimale Konfiguration für allgemeine Apps

{
  "type": "docker-run",
  "label": "docker-run: debug",
  "dependsOn": ["docker-build"],
  "python": {
    "file": "path_to/app_entry_point.py"
  }
}

Plattformstandardwerte

Für auf Python basierende Images leitet der Task docker-run die folgenden Optionen ab

.NET (docker-run)

Minimale Konfiguration mit Standardwerten

Beim Erstellen eines auf .NET basierenden Images können Sie die Eigenschaft platform weglassen und stattdessen das Objekt netCore festlegen (platform wird implizit auf netcore gesetzt, wenn das Objekt netCore vorhanden ist). Beachten Sie, dass appProject eine erforderliche Eigenschaft ist

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run .NET Core Image",
      "type": "docker-run",
      "netCore": {
        "appProject": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

Plattformstandardwerte

Für auf .NET basierende Images leitet der Task docker-run die folgenden Optionen ab

Run-Task-Referenz

Hier sind alle Eigenschaften aufgeführt, die zur Konfiguration des Tasks docker-run verfügbar sind. Alle Eigenschaften sind optional, sofern nicht anders angegeben.

Eigenschaften des dockerRun-Objekts

Eigenschaften des Ports-Objekts

Eigenschaften des extraHosts-Objekts

Eigenschaften des Volumes-Objekts

Eigenschaften des Node-Objekts (Task docker-run)

Eigenschaften des Python-Objekts (Task docker-run)

Eigenschaften des netCore-Objekts (Task docker-run)

Docker Compose-Task

Der Task docker-compose in tasks.json erstellt und startet Container mithilfe der Docker Compose-Befehlszeile (CLI). Der Task kann eigenständig oder als Teil einer Taskkette zum Debuggen einer Anwendung in einem Container verwendet werden.

Die wichtigste Konfigurationseinstellung für den Task docker-compose ist dockerCompose

• Das Objekt dockerCompose gibt Parameter für den Docker Compose-Befehl an. Die von diesem Objekt angegebenen Werte werden direkt auf die Docker Compose-CLI-Aufrufung angewendet.

Siehe Eigenschaftenreferenz für die vollständige Liste aller Task-Eigenschaften.

Beispielkonfiguration

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "Run docker-compose up",
      "type": "docker-compose",
      "dockerCompose": {
        "up": {
          "detached": true,
          "build": true,
          "services": ["myservice"]
        },
        "files": [
          "${workspaceFolder}/docker-compose.yml",
          "${workspaceFolder}/docker-compose.debug.yml"
        ]
      }
    }
  ]
}

Compose-Task-Referenz

Hier sind alle Eigenschaften aufgeführt, die zur Konfiguration des Tasks docker-compose verfügbar sind. Alle Eigenschaften sind optional, sofern nicht anders angegeben.

Eigenschaften des dockerCompose-Objekts

Eigenschaften des up-Objekts

Eigenschaften des down-Objekts

Befehlseinstellungen

Die Container Tools-Erweiterung führt eine Reihe von Docker-CLI-Befehlen aus, wenn Sie verschiedene Operationen durchführen, wie z. B. Images erstellen, Container starten, an Container anhängen und Containerprotokolle anzeigen. Einige dieser Befehle haben eine große Anzahl optionaler Argumente, die oft in sehr spezifischen Szenarien verwendet werden. Als Alternative zu den oben genannten Visual Studio Code-Tasks können mehrere Befehle angepasst werden, wenn keine Tasks verwendet werden.

Zum Beispiel ermöglichen die Token ${serviceList} und ${profileList} im Befehl Compose Up das einfache Starten einer Teilmenge der Dienste in Ihrer(n) Docker Compose YAML-Datei(en).

Für jeden dieser anpassbaren Docker-Befehle ist eine Konfigurationseinstellung verfügbar, um die Vorlage für die Ausführung festzulegen. Alternativ können Sie mehrere Vorlagen definieren, optional mit einem regulären Ausdruck, der, wenn er übereinstimmt, den Kontext angibt, in dem eine Vorlage verwendet werden soll. Die Vorlagen unterstützen einige Token ähnlich wie launch.json und tasks.json, z. B. ${workspaceFolder}.

Schema der Einstellungs-JSON

Sie haben zwei Optionen zur Konfiguration jeder der Vorlagen (unten aufgeführt). Die erste Option ist eine einzelne Vorlage, die das Standardverhalten überschreibt.

{
  "containers.commands.build": "docker build --rm -f \"${dockerfile}\" -t ${tag} \"${context}\""
}

Die zweite Option sind mehrere Vorlagen, die basierend auf dem regulären Ausdruck match sowie Benutzereingaben ausgewählt werden.

Zum Beispiel werden im folgenden Beispiel drei Vorlagen gezeigt.

{
  "containers.commands.build": [
    {
      "label": "Default build command",
      "template": "docker build --rm -f \"${dockerfile}\" -t ${tag} \"${context}\""
    },
    {
      "label": "Alpine-specific build command",
      "template": "docker build -p 1234:1234 -f \"${dockerfile}\" -t ${tag} \"${context}\"",
      "match": "alpine"
    }
  ]
}

Auswahlverhalten

Die ausgewählte Befehlsvorlage wird basierend auf den folgenden Regeln ausgewählt.

1. Wenn keine Einstellung konfiguriert ist, wird die Standard-Befehlsvorlage gewählt.
2. Wenn nur eine Vorlage konfiguriert ist (das erste Beispiel oben), wird diese Vorlage gewählt.
3. Wenn mehrere Vorlagen konfiguriert sind.
   1. Eingeschränkte Vorlagen werden geprüft. Eine eingeschränkte Vorlage hat ein match. Der reguläre Ausdruck match wird mit kontextbezogenen Hinweisen verglichen – z. B. Image-Name, Container-Name usw.
   2. Wenn mehrere eingeschränkte Vorlagen zutreffen, wird der Benutzer zur Auswahl aufgefordert. Wenn nur eine zutrifft, wird der Benutzer nicht aufgefordert.
   3. Wenn keine zutreffenden eingeschränkten Vorlagen vorhanden sind, werden nicht eingeschränkte Vorlagen geprüft. Eine nicht eingeschränkte Vorlage hat kein match und ist daher immer zutreffend.
   4. Wenn mehrere nicht eingeschränkte Vorlagen zutreffen, wird der Benutzer zur Auswahl aufgefordert. Wenn nur eine zutrifft, wird der Benutzer nicht aufgefordert.

Docker Build

Unterstützte Token

Hinweis: Wenn die Einstellung containers.commands.build das Token ${tag} nicht enthält, wird der Benutzer nicht aufgefordert, ein Tag einzugeben/zu bestätigen.

Hinweis: Der reguläre Ausdruck match wird mit dem ausgewählten Dockerfile-Namen und dem Namen des Arbeitsbereichsordners verglichen.

Docker Run

Unterstützte Token

Hinweis: Der reguläre Ausdruck match wird mit dem vollständigen Tag des ausgewählten Images verglichen.

Container Attach

Unterstützte Token

Hinweis: Der reguläre Ausdruck match wird mit dem Containernamen und dem vollständigen Tag des Container-Images verglichen.

Container Logs

Unterstützte Token

Hinweis: Der reguläre Ausdruck match wird mit dem Containernamen und dem vollständigen Tag des Container-Images verglichen.

Docker Compose Up

Unterstützte Token

Docker Compose Down

Unterstützte Token

Zusätzlich unterstützte Token

Zusätzlich zu den Befehlsspezifischen unterstützten Token werden die folgenden Token in allen Befehlsvorlagen unterstützt.