在 VS Code 中尝试

在远程 Docker 主机上进行开发

有时您可能希望使用 Dev Containers 扩展在位于远程服务器上的容器内进行开发。Docker 支持将本地文件系统挂载(绑定)到远程开发容器中,因此 Visual Studio Code 使用本地源代码的默认 devcontainer.json 行为将不起作用。虽然这是默认行为,但在本节中,我们将介绍如何连接到远程主机,以便您可以使用 Remote - SSH 扩展在容器中打开远程主机上的文件夹,附加到任何正在运行的容器,或使用本地 devcontainer.json 文件作为配置、创建和连接到使用套接字的远程开发容器的方式。

使用 Remote - SSH 扩展连接

如果您使用的是 Linux 或 macOS SSH 主机,可以一起使用Remote - SSH和 Dev Containers 扩展。您甚至不需要在本地安装 Docker 客户端。为此:

  1. 遵循 Remote - SSH 扩展的安装和 SSH 主机设置步骤。
  2. 可选:设置 SSH 基于密钥的身份验证到服务器,这样您就不需要多次输入密码。
  3. 在您的 SSH 主机上安装 Docker。您不需要在本地安装 Docker。
  4. 遵循 Remote - SSH 扩展的快速入门以连接到主机并在那里打开文件夹。
  5. 使用命令面板(F1⇧⌘P (Windows, Linux Ctrl+Shift+P))中的 Dev Containers: Reopen in Container 命令。

Dev Containers 快速入门的其余部分照常适用。您可以在其文档中了解更多关于Remote - SSH 扩展的信息。

使用 Remote - Tunnels 扩展连接

您可以一起使用Remote - Tunnels和 Dev Containers 扩展,在容器中打开远程主机上的文件夹。您甚至不需要在本地安装 Docker 客户端。这与上面的 SSH 主机场景类似,但使用 Remote - Tunnels 代替。为此:

  1. 遵循 Remote - Tunnels 扩展的入门说明。
  2. 在您的隧道主机上安装 Docker。您不需要在本地安装 Docker。
  3. 遵循 Remote - Tunnels 扩展的步骤,连接到隧道主机并在那里打开文件夹。
  4. 使用命令面板(F1⇧⌘P (Windows, Linux Ctrl+Shift+P))中的 Dev Containers: Reopen in Container 命令。

Dev Containers 快速入门的其余部分照常适用。您可以在其文档中了解更多关于Remote - Tunnels 扩展的信息。

使用 Docker CLI 连接

此模型仅要求 Docker Engine 在远程主机上运行,并且您的本地 Docker CLI 可以连接到该主机。虽然使用 Remote - SSH 和 Remote - Tunnels 扩展更容易,甚至不需要在本地安装 Docker CLI,但此模型对于您已经从命令行连接的主机场景可能很有用。如果您希望附加到此远程服务器上已在运行的容器,此方法也很有用。

一个基本的远程示例

设置 VS Code 以附加到远程 Docker 主机上的容器,可以像在 settings.json 中设置Container Tools 扩展containers.environment 属性并重启 VS Code(或重新加载窗口)一样简单。

例如:

"containers.environment": {
    "DOCKER_HOST": "ssh://your-remote-user@your-remote-machine-fqdn-or-ip-here"
}

使用 SSH 需要受支持的 SSH 客户端,您已配置了到远程主机的基于密钥的身份验证,并且密钥已导入到本地 SSH 代理中。有关配置代理和添加密钥的详细信息,请参阅关于将 SSH 密钥与 Git 配合使用的文章。

此时,您可以附加到远程主机上的容器。我们将在本节后面介绍更多关于如何使用设置和环境变量Docker 上下文进行连接的信息。

对于 devcontainer.json,还有一个额外的步骤:您需要更新任何已配置(或自动配置)的绑定挂载,使其不再指向本地文件系统。

此设置有两种变体。第一种是先创建您的远程开发容器,然后将您的源代码克隆到命名卷中,因为这不需要您直接访问远程主机上的文件系统。

这是一个基本的 devcontainer.json 示例:

{
  "image": "node", // Or "dockerFile"
  "workspaceFolder": "/workspace",
  "workspaceMount": "source=remote-workspace,target=/workspace,type=volume"
}

实际上,命令面板(F1)中的 Dev Containers: Clone Repository in Container Volume... 命令使用相同的技术。如果您已经在引用镜像或 Dockerfile 的 GitHub 仓库中有一个 devcontainer.json 文件,该命令将自动使用命名卷而不是绑定挂载 - 这也适用于远程主机。

第二种方法是将远程机器上的文件夹绑定挂载到您的容器中。这需要您访问远程文件系统,但也允许您使用远程机器上现有的源代码

更新上面示例中的 workspaceMount 属性以使用此模型代替:

"workspaceMount": "source=/absolute/path/on/remote/machine,target=/workspace,type=bind,consistency=cached"

无论哪种情况,要尝试它,请运行 Dev Containers: Open Folder in Container...,然后选择包含 .devcontainer.json 文件的本地文件夹。

有关 Docker Compose 等其他场景的信息,请参阅转换现有或预定义的 devcontainer.json

使用 VS Code 设置或本地环境变量连接

如果您已经有一个远程 Docker 主机正在运行,您可以在工作区或用户 settings.json 中使用以下属性来指定主机。

SSH 协议

Docker 的最新版本(18.06+)增加了对 SSH 协议连接到远程 Docker 主机的支持。这很容易配置,您只需要在 settings.json 中设置一个属性即可使用它。

首先,安装一个受支持的 SSH 客户端,配置基于密钥的身份验证,然后将您的密钥导入到本地 SSH 代理中(在 Windows 和 Linux 上通常默认不运行)。有关配置代理和添加密钥的详细信息,请参阅关于将 SSH 密钥与 Git 配合使用的文章。

然后,将以下Container Tools 扩展 containers.environment 属性添加到 settings.json 中(根据需要替换值):

"containers.environment": {
    "DOCKER_HOST": "ssh://your-remote-user@your-remote-machine-fqdn-or-ip-here"
}

重启 VS Code(或重新加载窗口)后,您现在将能够附加到远程主机上的任何正在运行的容器。您还可以使用专门的本地 devcontainer.json 文件创建/连接到远程开发容器

提示:如果这不奏效,但您可以通过命令行使用 SSH 连接到主机,请确保您的SSH 代理正在运行并带有您的身份验证密钥。如果所有方法都失败,您可以使用 SSH 隧道作为备用方案

使用 TCP 协议

虽然 SSH 协议有其内置的授权机制,但使用 TCP 协议通常需要在您的 settings.json 中设置其他Container Tools 扩展属性。它们是:

"containers.environment": {
    "DOCKER_HOST": "tcp://your-remote-machine-fqdn-or-ip-here:port",
    "DOCKER_CERT_PATH": "/optional/path/to/folder/with/certificate/files",
    "DOCKER_TLS_VERIFY": "1" // or "0"
}

与 SSH 一样,重启 VS Code(或重新加载窗口)以使设置生效。

使用环境变量代替 settings.json

如果您 prefer 不使用 settings.json,可以在终端中设置环境变量。步骤如下:

  1. 关闭 所有 VS Code 实例。
  2. 确保 VS Code 在您的操作系统 PATH 中。
  3. 在终端/命令提示符中设置环境变量(例如 DOCKER_HOST)。
  4. 在此同一终端/命令提示符中键入 code 以启动设置了变量的 VS Code。

使用 Docker Contexts 连接

Docker Contexts 允许您与不同的主机交互 - 您可以为每个主机设置上下文并在它们之间切换。

您可以使用 docker context create 创建新的上下文。可以使用 docker context use <context> 更改当前上下文。

Container Tools 扩展提供了 containers.environment 设置,您可以在其中设置 DOCKER_HOSTDOCKER_CONTEXT 等环境变量,Dev Containers 扩展也会遵循这些设置。

注意:只有安装了 Container Tools 扩展,上述设置才可见。如果未安装 Container Tools 扩展,Dev Containers 将使用当前上下文。

转换现有或预定义的 devcontainer.json

要将现有或预定义的本地 devcontainer.json 转换为远程文件,请遵循以下步骤:

  1. 在 VS Code 中打开一个要转换文件的本地文件夹(而不是远程文件夹)。

  2. 如果您没有选择包含 devcontainer.json 的文件夹,可以通过运行命令面板(F1)中的 Dev Containers: Add Container Configuration File... 来选择一个预定义的。

  3. 根据您的 .devcontainer/devcontainer.json.devcontainer.json 引用内容,遵循以下步骤修改源代码挂载:

    Dockerfile 或镜像:

    如果您没有登录到远程主机的权限,请使用 Docker“卷”来存放您的源代码。按照如下方式更新 .devcontainer/devcontainer.json(如果需要,将 remote-workspace 替换为唯一的卷名称):

    "workspaceMount": "source=remote-workspace,target=/workspace,type=volume"
    "workspaceFolder": "/workspace",
    

    如果您登录权限,可以使用远程文件系统绑定挂载代替:

    "workspaceMount": "source=/absolute/path/on/remote/machine,target=/workspace,type=bind,consistency=cached"
    "workspaceFolder": "/workspace",
    

    如果您有其他场景,workspaceMount 属性支持与Docker CLI --mount 标志相同的值。

    Docker Compose:

    如果您没有登录到远程主机的权限,请更新(或扩展)您的 docker-compose.yml。将 your-service-name-here 替换为 devcontainer.json"service" 属性指定的值,并将 remote-workspace 替换为唯一的卷名称:

    version: '3'
    services:
      your-service-name-here:
        volumes:
            - remote-workspace:/workspace
        # ...
    
    volumes:
      remote-workspace:
    

    如果您登录权限,可以使用远程文件系统绑定挂载代替:

    version: '3'
    services:
      your-service-name-here:
        volumes:
          - /absolute/path/on/remote/machine:/workspace:cached
        # ...
    

    如果您需要支持不同的场景,请参阅Docker Compose 关于 volumes 的文档

  4. 运行命令面板(F1)中的 Dev Containers: Reopen in Container 命令或 Dev Containers: Rebuild Container

  5. 如果您使用的是卷而不是绑定挂载,请使用⌃⇧` (Windows, Linux Ctrl+Shift+`) 在容器内打开终端。您可以从这里运行 git clone 来拉取您的源代码,并使用 文件 > 打开... / 打开文件夹... 打开克隆的仓库。

下次您想连接到同一个容器时,运行 Dev Containers: Open Folder in Container... 并在 VS Code 窗口中选择相同的本地文件夹。

可选:使远程源代码可在本地访问

如果您的源代码存储在远程主机的的文件系统上,而不是 Docker 卷内,有几种方法可以在本地访问这些文件:

  1. 使用 SSHFS 挂载远程文件系统.
  2. 使用 rsync 将文件从远程主机同步到本地机器.
  3. 如果您正在使用Docker Machine使用 mount 命令

使用 SSHFS 或 Docker Machine 的 mount 命令是更便捷的选项,不需要任何文件同步。然而,性能会显著慢于通过 VS Code 工作,因此最适合用于单个文件编辑和上传/下载内容。如果您需要使用会批量读写许多文件的应用程序(如本地源代码控制工具),rsync 是更好的选择。