定制容器工具扩展

Container Tools 扩展包括几个 Visual Studio Code 任务来控制 Docker 的行为构建和运行，并为调试提供容器启动的基础。

这些任务允许进行大量的控制和自定义。最终配置是默认设置、特定平台的默认设置（如 Node.js、Python 或 .NET）和用户输入的组合。当用户输入与默认设置冲突时，用户输入优先。

Visual Studio Code 任务的所有常见功能（例如，将任务分组到复合任务中）都由 Container Tools 扩展任务支持。有关常见任务功能和属性的详细信息，请参阅 Visual Studio Code 自定义任务 文档。

Docker 构建任务

该Docker 构建任务使用Docker命令行（CLI）构建镜像。该任务可以单独使用，或者作为链式任务的一部分，在容器内运行和/或调试应用程序。

最重要的配置设置Docker 构建任务是docker构建和平台输入：

• 该docker构建对象指定Docker build命令的参数。此对象指定的值将直接应用于Docker build命令行界面调用。
• 该平台属性是一个提示，改变了Docker 构建任务确定Docker构建默认设置。

参见属性参考以获取所有任务属性的完整列表。

平台支持

虽然Docker 构建任务在任务.json可以用来构建任何镜像，该扩展明确支持（并简化了配置）Node.js、Python 和 .NET Core。

Node.js (docker建)

使用默认设置的最小配置

一个基于Node.js的镜像，没有特定的平台选项，可以直接设置平台属性到节点输入：

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "构建节点镜像",
      "type": "docker建镜像",
      "平台": "节点"
    }
  ]
}

平台默认设置

对于基于Node.js的镜像，Docker 构建任务推断出以下选项：

Python (docker建)

使用默认设置的最小配置

一个基于Python的图像，没有特定的平台选项，只需设置平台属性到Python输入：

{
  "tasks": [
    {
      "type": "docker建镜像",
      "标签": "docker建镜像",
      "平台": "python"
    }
  ]
}

平台默认设置

对于基于Python的图像，Docker 构建任务推断出以下选项：

.NET (docker建)

使用默认设置的最小配置

当您构建一个基于 .NET 的镜像时，您可以省略平台属性并仅设置网核对象 (平台被隐式设置为网核当网核对象存在）。请注意应用程序项目是一个必需的属性：

{
  "版本": "2.0.0",
  "任务": [
    {
      "标签": "构建节点图像",
      "类型": "docker建镜像",
      "netCore": {
        "应用程序项目": "${workspaceFolder}/project.csproj"
      }
    }
  ]
}

平台默认设置

对于基于 .NET 的图像，Docker 构建任务推断出以下选项：

构建任务参考

以下是所有可用的配置属性Docker 构建任务。所有属性都是可选的，除非另有说明。

dockerBuild 对象属性

节点对象属性 (Docker 构建任务)

netCore 对象属性 (Docker 构建任务)

Docker 运行任务

该docker运行任务在任务.json使用Docker命令行（CLI）创建并启动一个容器。该任务可以单独使用，或者作为调试容器内应用程序的任务链的一部分。

最重要的配置设置docker运行任务是docker运行和平台输入：

• 该docker运行对象指定Docker run命令的参数。此对象指定的值将直接应用于Docker run命令行界面调用。
• 该平台属性是一个提示，改变了docker运行任务确定Docker运行默认设置。

参见属性参考以获取所有任务属性的完整列表。

Docker运行平台支持

虽然docker运行任务可以用来运行任何Docker镜像，该扩展明确支持（并简化了配置）Node.js、Python和.NET。

Node.js (docker-run)

使用默认设置的最小配置

一个基于Node.js的镜像，没有特定的平台选项，可以直接设置平台属性到节点输入：.

{
  "version": "2.0.0",
  "tasks": [
    {
      "label": "运行节点镜像",
      "node": "docker-run",
      "platform": "node"
    }
  ]
}

平台默认设置

对于基于Node.js的镜像，docker运行任务推断出以下选项：

Python (docker-run)

在构建基于Python的镜像时，你可以省略平台属性并仅设置Python对象 (平台被隐式设置为Python当Python对象存在

Django 应用的最小配置

{
  "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"
  }
}

Flask 应用程序的最小配置

{
  "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"
  }
}

通用应用程序的最低配置

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

平台默认设置

对于基于Python的图像，docker运行任务推断出以下选项：

.NET (docker-run)

使用默认设置的最小配置

构建基于 .NET 的镜像时，您可以省略平台属性并仅设置网核对象 (平台被隐式设置为网核当网核对象存在）。请注意应用程序项目是一个必需的属性：

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

平台默认设置

对于基于 .NET 的图像，docker运行任务推断出以下选项：

运行任务参考

以下是所有可用的配置属性docker运行任务。所有属性都是可选的，除非另有说明。

dockerRun 对象属性

端口对象属性

额外主机对象属性

卷对象属性

节点对象属性 (docker运行任务)

Python 对象属性 (docker运行任务)

netCore 对象属性 (docker运行任务)

Docker Compose 任务

该Docker Compose任务在任务.json使用Docker Compose命令行界面（CLI）创建并启动容器。该任务可以单独使用，或者作为调试容器内应用程序的任务链的一部分。

最重要的配置设置为Docker Compose任务是Docker Compose输入：

• 该Docker Compose对象指定用于Docker Compose命令的参数。此对象指定的值将直接应用于Docker Compose CLI调用。

参见属性参考以获取所有任务属性的完整列表。

示例配置

{
  "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"
        ]
      }
    }
  ]
}

编排任务参考

以下是所有可用的配置属性Docker Compose任务。所有属性都是可选的，除非另有说明。

dockerCompose 对象属性

向上对象属性

向下对象属性

命令定制

Container Tools 扩展在执行各种操作时（例如构建镜像、运行容器、附加到容器和查看容器日志）会执行一些 Docker CLI 命令。其中一些命令具有大量可选参数，通常用于非常特定的场景。作为上述 Visual Studio Code 任务的替代方案，当任务不使用时，可以自定义一些命令。

例如，这些代币${服务列表}和${profileList} 在 Compose Up 命令允许轻松启动你的Docker Compose YAML文件中的一组服务。

对于这些可定制的Docker命令，有一个配置设置可以设置要执行的模板。或者，您可以定义多个模板，可选地使用正则表达式，当匹配时，提示模板应使用的上下文。模板支持类似于的一些令牌launch.json和任务.json例如，${工作区文件夹}输入：.

设置 JSON 模式

您有两个选项来配置每个模板（如下所示）。第一个选项是一个单独的模板，它覆盖了默认行为：

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

第二个选项是多个模板，将根据比赛正则表达式以及用户输入。

例如，在以下示例中展示了三个模板：

{
  "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"
    }
  ]
}

选择行为

所选择的命令模板是根据以下规则选择的：

1. 如果未配置任何设置，则选择默认命令模板。
2. 如果只配置了一个模板（上面的第一个示例），则选择该模板。
3. 如果配置了多个模板：
   1. 受约束的模板会被检查。一个受约束的模板有比赛。比赛正则表达式与上下文提示进行比较——例如，图像名称、容器名称等。
   2. 如果多个受限模板适用，系统将提示用户进行选择。如果只有一个适用，系统将不会提示用户。
   3. 如果没有适用的受限模板，则检查无约束模板。无约束模板没有比赛，因此始终适用。
   4. 如果有多个无约束模板适用，系统将提示用户进行选择。如果只有一个适用，系统将不会提示用户。

Docker 构建

支持的代币：

注意：如果容器.命令.构建设置不包含${tag} 代币，用户将不被提示输入/确认标签。

注意：该比赛正则表达式将与所选的Dockerfile名称和工作区文件夹名称进行比较。

Docker 运行

支持的代币：

注意：该比赛正则表达式将与所选图像的完整标签进行比较。

容器附加

支持的代币：

注意：该比赛正则表达式将与容器名称和容器镜像的完整标签进行比较。

容器日志

支持的代币：

注意：该比赛正则表达式将与容器名称和容器镜像的完整标签进行比较。

Docker Compose 启动

支持的代币：

Docker Compose 停止

支持的代币：

其他支持的代币

除了特定命令支持的标记外，所有命令模板还支持以下标记：