在 VS Code 中试试

附加到正在运行的容器

Visual Studio Code 可以为你创建和启动容器,但这可能不符合你的工作流程,你可能更喜欢将 VS Code“附加”到已在运行的 Docker 容器 - 无论它如何启动。附加后,你可以像使用 devcontainer.json 在容器中打开文件夹一样安装扩展、编辑和调试。

附加到 Docker 容器

要附加到 Docker 容器,可以从命令面板 (F1) 中选择 Dev Containers: Attach to Running Container...,或者在活动栏中使用 Remote Explorer,然后在 Containers 视图中,选择要连接的容器上的 Attach to Container 行内操作。

Containers Explorer screenshot

注意:使用 Alpine Linux 容器时,某些扩展可能无法工作,因为扩展中的原生代码依赖于 glibc

附加容器配置文件

VS Code 支持镜像或容器名称级别的配置文件,以便在你重复连接到给定 Docker 容器时加快设置速度。附加后,任何时候你打开文件夹、安装扩展转发端口时,都会自动更新本地特定镜像的配置文件,以记住你的设置,这样当你再次附加时,一切都会恢复到正确的位置。

  • 默认情况下,使用镜像级别的配置。附加后,要查看或更新它,请从命令面板 (F1) 中选择 Dev Containers: Open Container Configuration File

  • 如果你希望将配置绑定到容器名称,附加后请从命令面板 (F1) 中选择 Dev Containers: Open Named Configuration File。从此之后的所有更新都将应用于此名称级别的配置,而不是镜像级别。

这两个文件都支持 devcontainer.json 属性的子集

{
  // Default path to open when attaching to a new container.
  "workspaceFolder": "/path/to/code/in/container/here",

  // Set *default* container specific settings.json values on container create.
  "settings": {
    "terminal.integrated.defaultProfile.linux": "bash"
  },

  // Add the IDs of extensions you want installed when the container is created.
  "extensions": ["dbaeumer.vscode-eslint"],

  // An array port numbers to forward
  "forwardPorts": [8000],

  // Container user VS Code should use when connecting
  "remoteUser": "vscode",

  // Set environment variables for VS Code and sub-processes
  "remoteEnv": { "MY_VARIABLE": "some-value" }
}

有关属性及其用法的完整列表,请参阅附加容器配置参考

保存后,当你首次使用相同的镜像/容器名称打开容器时,将使用这些属性来配置环境。

提示:如果你的配置有问题,你也可以在未附加到容器时进行编辑,方法是从命令面板 (F1) 中选择 Dev Containers: Open Attached Container Configuration File...,然后从显示的列表中选择镜像/容器名称。

最后,如果你有一些无论附加到哪个容器都希望安装的扩展,可以更新 settings.json 来指定应始终安装的扩展列表

附加容器配置参考

附加容器配置文件类似于 devcontainer.json,并支持其属性的子集。

属性 类型 描述
workspaceFolder string 设置 VS Code 连接到容器时应打开的默认路径(通常是指在容器中找到源代码的卷挂载路径)。默认未设置(将打开一个空窗口)。
extensions array 一个扩展 ID 数组,指定在创建容器时应在容器内部安装的扩展。默认为 []
settings object 将默认的 settings.json 值添加到特定于容器/机器的设置文件中。
forwardPorts array 应从容器内部转发到本地机器的端口列表。
portsAttributes object 将端口号、"host:port" 值、范围或正则表达式映射到一组默认选项的对象。有关可用选项,请参阅端口属性。例如
"portsAttributes": {"3000": {"label": "应用程序端口"}}
otherPortsAttributes object 对于未使用 portsAttributes 配置的端口、端口范围和主机,这是其默认选项。有关可用选项,请参阅端口属性。例如
"otherPortsAttributes": {"onAutoForward": "silent"}
remoteEnv object 一组键值对,用于设置或覆盖 VS Code(或终端等子进程)的环境变量,但不影响整个容器。值中可以引用环境和预定义变量
例如:"remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path" }
remoteUser string 覆盖 VS Code 在容器中运行所使用的用户(以及终端、任务或调试等子进程)。默认为整个容器运行所使用的用户(通常是 root)。
userEnvProbe enum 指示用于“探测”用户环境变量以包含在 VS Code 或其他连接工具进程中的 Shell 类型:noneinteractiveShellloginShellloginInteractiveShell(默认)。使用的具体 Shell 基于用户的默认 Shell(通常是 bash)。例如,bash 交互式 Shell 通常会包含在 /etc/bash.bashrc~/.bashrc 中设置的变量,而登录 Shell 通常包含来自 /etc/profile~/.profile 的变量。将此属性设置为 loginInteractiveShell 将从所有这四个文件获取变量。
postAttachCommand string,
array
在 VS Code 附加到容器后要运行的命令字符串或命令参数列表。在字符串中使用 && 执行多个命令。例如,"yarn install""apt-get update && apt-get install -y curl"。数组语法 ["yarn", "install"] 将直接调用命令(在本例中是 yarn),而不使用 Shell。默认未设置。
请注意,数组语法将在不使用 Shell 的情况下执行命令。你可以了解更多信息,了解如何格式化字符串和数组属性。

附加容器配置文件中的变量

在附加配置文件中的某些字符串值中,可以使用以下格式引用变量:${variableName}。下表列出了可以使用的可用变量。

变量 属性 描述
${containerEnv:VAR_NAME} remoteEnv 容器内部(本例中为 VAR_NAME)已存在的环境变量的值,一旦容器启动并运行即可获取。例如:"remoteEnv": { "PATH": "${containerEnv:PATH}:/some/other/path" }

附加到 Kubernetes 集群中的容器

要附加到 Kubernetes 集群中的容器,请从命令面板 (⇧⌘P (Windows, Linux Ctrl+Shift+P)) 中选择 Dev Containers: Attach to Running Kubernetes Container...。或者,首先安装 Kubernetes 扩展kubectl 以及 Dev Containers 扩展。然后从活动栏中选择 Kubernetes 资源管理器,展开要附加的容器所在的集群和 Pod。最后,右键单击容器,从上下文菜单中选择 Attach Visual Studio Code

注意:目前尚不支持 Kubernetes 集群中容器的附加容器配置文件。

Attach to Kubernetes Container

后续步骤