自定义容器工具扩展

容器工具扩展包含多个Visual Studio Code任务，用于控制Docker的构建和运行行为，并作为容器启动调试的基础。

这些任务允许玩家高度控制和自定义。最终配置是通用默认、平台特定默认（如Node.js、Python或.NET）和用户输入的组合。当用户输入与默认值冲突时，它会优先考虑。

Visual Studio Code 任务的所有常见功能（例如将任务分组为复合任务）均由容器工具扩展任务支持。有关常见任务功能和属性的更多信息，请参见Visual Studio Code自定义任务文档。

Docker 构建任务

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

最重要的配置设置docker-build任务如下docker构建以及平台:

• 该docker构建object 指定了 Docker 构建命令的参数。该对象指定的值直接应用于 Docker 构建 CLI 调用中。
• 该平台属性是一个改变docker-build任务决定了 Docker 构建的默认值。

有关所有任务属性的完整列表，请参见属性参考。

平台支持

虽然docker-build任务tasks.json可用于构建任何镜像，该扩展明确支持（并简化配置）支持 Node.js、Python 和 .NET Core。

Node.js （docker-build）

使用默认值的最小配置

基于Node.js的镜像没有特定平台选项，只需设置平台属性到节点:

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

平台默认设置

对于基于Node.js的图像，以下docker-build任务推断出以下选项：

Python（docker构建）

使用默认值的最小配置

一个基于Python、没有特定平台选项的镜像可以直接设置平台属性到派森:

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

平台默认设置

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

.NET （docker-build）

使用默认值的最小配置

当你构建一个 .基于NET的镜像，你可以省略平台属性，并仅设网核对象（平台隐式设置为网络核心当网核物体存在）。注意app项目是必修属性：

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

平台默认设置

对于 。基于NET的图像，docker-build任务推断出以下选项：

构建任务参考

以下是所有可用于配置的属性docker-build任务。除非另有说明，所有属性均为可选。

dockerBuild 对象属性

节点对象属性（docker-build任务）

netCore 对象属性（docker-build任务）

Docker 运行任务

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

最重要的配置设置docker-run任务如下dockerRun以及平台:

• 该dockerRunobject 指定了 Docker 运行命令的参数。该对象指定的值会直接应用到 Docker 运行 CLI 调用中。
• 该平台属性是一个改变docker-run任务决定了 Docker 运行的默认值。

有关所有任务属性的完整列表，请参见属性参考。

Docker 运行平台支持

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

Node.js （docker-run）

使用默认值的最小配置

基于Node.js的镜像没有特定平台选项，只需设置平台属性到节点.

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

平台默认设置

对于基于Node.js的图像，以下docker-run任务推断出以下选项：

Python（docker运行）

在构建基于Python的镜像时，你可以省略平台属性，并仅设派森对象（平台隐式设置为派森当派森物体存在）

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

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-run任务推断出以下选项：

.NET （docker-run）

使用默认值的最小配置

构建 .基于NET的镜像，你可以省略平台属性，并仅设网核对象（平台隐式设置为网络核心当网核物体存在）。注意app项目是必修属性：

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

平台默认设置

对于 。基于NET的图像，docker-run任务推断出以下选项：

运行任务引用

以下是所有可用于配置的属性docker-run任务。除非另有说明，所有属性均为可选。

dockerRun 对象属性

端口对象属性

extraHosts 对象属性

volumes 对象属性

节点对象属性（docker-run任务）

Python 对象属性（docker-run任务）

netCore 对象属性（docker-run任务）

Docker Compose 任务

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

最重要的配置设置docker-compose任务是dockerCompose:

• 该dockerComposeobject 指定了 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"
        ]
      }
    }
  ]
}

Compose 任务引用

以下是所有可用于配置的属性docker-compose任务。除非另有说明，所有属性均为可选。

dockerCompose 对象属性

UP 对象属性

下对象属性

命令定制

Container Tools 扩展在执行各种作时执行多个 Docker CLI 命令，比如构建镜像、运行容器、附加容器和查看容器日志。其中一些命令包含大量可选参数，通常用于非常特定的场景。作为上述Visual Studio Code任务的替代方案，当任务未被使用时，可以自定义若干命令。

例如，标记${serviceList}以及${profileList}在 Compose Up 命令中，允许你轻松启动 Docker Compose YAML 文件中的部分服务。

对于这些可定制的 Docker 命令，都提供了一个配置设置，用于设置执行的模板。或者，你也可以定义多个模板，可选地使用正则表达式，匹配后会提示模板的使用上下文。模板支持一些类似于的标记launch.json以及tasks.json，例如，${workspaceFolder}.

设置 JSON schema

你有两种配置模板的选项（如下所示）。第一种方案是一个覆盖默认行为的单一模板：

{
  "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 构建

支持的代币：

注意：如果containers.commands.build设置不包含${tag}用户不会被提示输入或确认标签。

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

Docker 运行

支持的代币：

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

容器附着

支持的代币：

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

集装箱日志

支持的代币：

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

Docker 组合

支持的代币：

Docker 组合下降

支持的代币：

其他支持的代币

除了命令专用支持的令牌外，以下令牌在所有命令模板中都支持：