在远程 Docker 主机上开发
有时,您可能希望使用 Dev Containers 扩展程序在位于远程服务器上的容器内进行开发。Docker 不支持将本地文件系统装载(绑定)到远程开发容器中,因此 Visual Studio Code 默认的 devcontainer.json 行为(使用本地源代码)将无法工作。虽然这是默认行为,但在本节中,我们将介绍如何连接到远程主机,以便您可以通过以下方式之一:使用 Remote - SSH 扩展程序在容器中打开远程主机上的文件夹、附加到任何正在运行的容器,或者使用本地 devcontainer.json 文件作为配置、创建和连接到使用套接字的远程开发容器的方法。
使用 Remote - SSH 扩展程序连接
如果您使用的是 Linux 或 macOS SSH 主机,则可以将 Remote - SSH 和 Dev Containers 扩展程序一起使用。您甚至不需要在本地安装 Docker 客户端。具体操作如下:
- 按照 Remote - SSH 扩展程序的安装和 SSH 主机设置步骤进行操作。
- 可选: 设置 SSH 基于密钥的身份验证到服务器,这样你就不需要多次输入密码。
- 在 SSH 主机上安装 Docker。您不需要在本地安装 Docker。
- 按照 Remote - SSH 扩展程序的快速入门连接到主机并在其中打开文件夹。
- 从命令面板(F1,⇧⌘P (Windows, Linux Ctrl+Shift+P))使用 开发容器:在容器中重新打开 命令。
Dev Containers 快速入门的其余部分照常适用。您可以在 Remote - SSH 扩展程序的文档中了解更多信息。
使用 Remote - Tunnels 扩展程序连接
您可以将 Remote - Tunnels 和 Dev Containers 扩展程序一起使用,在容器中打开远程主机上的文件夹。您甚至不需要在本地安装 Docker 客户端。这类似于上面的 SSH 主机方案,但使用 Remote - Tunnels 代替。具体操作如下:
- 按照 Remote - Tunnels 扩展程序的入门说明进行操作。
- 在隧道主机上安装 Docker。您不需要在本地安装 Docker。
- 按照 Remote - Tunnels 扩展程序的步骤连接到隧道主机并在其中打开文件夹。
- 从命令面板(F1,⇧⌘P (Windows, Linux Ctrl+Shift+P))使用 开发容器:在容器中重新打开 命令。
Dev Containers 快速入门的其余部分照常适用。您可以在 Remote - Tunnels 扩展程序的文档中了解更多信息。
使用 Docker CLI 连接
此模型仅要求 Docker Engine 在远程主机上运行,并且本地 Docker CLI 可以连接到该主机。虽然使用 Remote - SSH 和 Remote - Tunnels 扩展程序更容易,并且甚至不需要在本地安装 Docker CLI,但此模型对于您已经从命令行连接到主机的场景非常有用。如果您希望附加到此远程服务器上已在运行的容器,此方法也很有用。
一个基本的远程示例
设置 VS Code 以附加到远程 Docker 主机上的容器可以像在 settings.json 中设置 Container Tools extension 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... 命令使用了相同的技术。如果您在 GitHub 存储库中已经有一个引用镜像或 Dockerfile 的 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 extension 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 extension 属性。这些属性是:
"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
如果您不想使用 settings.json,可以在终端中设置环境变量。具体步骤如下:
- 关闭 VS Code 的所有实例。
- 确保 VS Code 位于操作系统的
PATH中。 - 在终端/命令提示符中设置环境变量(例如
DOCKER_HOST)。 - 在此终端/命令提示符中键入
code以启动设置了变量的 VS Code。
使用 Docker Contexts 连接
Docker 上下文允许您与不同的主机进行交互 - 您可以为每个主机设置上下文并在它们之间切换。
您可以使用 docker context create 创建新上下文。可以使用 docker context use <context> 更改当前上下文。
Container Tools extension 带有 containers.environment 设置,可以在其中设置环境变量,例如 DOCKER_HOST 或 DOCKER_CONTEXT,这些变量也受 Dev Containers 扩展程序尊重。
注意: 上述设置仅在安装了 Container Tools 扩展程序时可见。如果没有 Container Tools 扩展程序,Dev Containers 将使用当前上下文。
转换现有或预定义的 devcontainer.json
要将现有或预定义的本地 devcontainer.json 转换为远程文件,请按照以下步骤操作:
-
在 VS Code 中打开您要转换文件的本地文件夹(而不是远程文件夹)。
-
如果您没有选择包含
devcontainer.json的文件夹,则可以通过从命令面板 (F1) 运行 Dev Containers: Add Container Configuration File... 来选择预定义的文件夹。 -
根据您的
.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。 -
从命令面板 (F1) 运行 Dev Containers: Reopen in Container 命令或 Dev Containers: Rebuild Container。
-
如果您使用卷而不是绑定装载,请使用 ⌃⇧` (Windows, Linux Ctrl+Shift+`) 在容器内打开终端。您可以从此处运行
git clone以下拉源代码,然后使用 File > Open... / Open Folder... 打开克隆的存储库。
下次要连接到同一个容器时,运行 Dev Containers: Open Folder in Container... 并在 VS Code 窗口中选择相同的本地文件夹。
可选:使远程源代码在本地可用
如果您将源代码存储在远程主机的本地文件系统上而不是 Docker 卷中,您可以通过几种方式访问本地文件:
- 使用 SSHFS 装载远程文件系统.
- 使用
rsync将文件从远程主机同步到本地计算机. - 如果您正在使用 Docker Machine,请使用
mount命令。
使用 SSHFS 或 Docker Machine 的 mount 命令是更方便的选择,并且不需要任何文件同步。但是,性能会比通过 VS Code 工作慢得多,因此它们最适合用于单个文件编辑和内容上传/下载。如果您需要使用同时对许多文件进行批量读取/写入的应用程序(例如本地源代码控制工具),rsync 是更好的选择。