在远程 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 扩展的快速入门连接到主机并在那里打开文件夹。
- 从命令面板中使用 Dev Containers: Reopen in Container 命令 (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 扩展的步骤连接到隧道主机并在那里打开文件夹。
- 从命令面板中使用 Dev Containers: Reopen in Container 命令 (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
中设置 Docker 扩展 docker.environment
属性并重启 VS Code(或重新加载窗口)一样简单。
例如:
"docker.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 一起使用的文章。
然后,将以下 Docker 扩展 docker.environment
属性添加到 settings.json
(根据需要替换值):
"docker.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
中设置其他 Docker 扩展 属性。这些是:
"docker.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 Contexts 允许您与不同的主机交互 - 您可以为每个主机设置上下文并在它们之间切换。
您可以使用 docker context create
创建新上下文。可以使用 docker context use <context>
更改当前上下文。
Docker 扩展带有 docker.environment
设置,可以在其中设置 DOCKER_HOST
或 DOCKER_CONTEXT
等环境变量,Dev Containers 扩展也会遵循这些变量。
注意: 以上设置仅在安装 Docker 扩展时可见。如果没有 Docker 扩展,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 # ...
如果您需要支持不同的场景,请参阅关于
volumes
的 Docker Compose 文档。 -
从命令面板 (F1) 运行 Dev Containers: Reopen in Container 命令或 Dev Containers: Rebuild Container。
-
如果您使用卷而不是绑定挂载,请使用 ⌃⇧` (Windows, Linux Ctrl+Shift+`) 在容器内打开终端。您可以从此处运行
git clone
以拉取您的源代码,并使用 文件 > 打开... / 打开文件夹... 打开克隆的存储库。
下次您想要连接到同一容器时,运行 Dev Containers: Open Folder in Container... 并在 VS Code 窗口中选择相同的本地文件夹。
可选:使远程源代码在本地可用
如果您的源代码存储在远程主机的文件系统上而不是 Docker 卷中,则有几种方法可以在本地访问文件:
使用 SSHFS 或 Docker Machine 的 mount 命令是更方便的选择,并且不需要任何文件同步。但是,性能将明显慢于通过 VS Code 工作,因此它们最适合用于单文件编辑和上传/下载内容。如果您需要使用一次性批量读取/写入许多文件的应用程序(例如本地源代码控制工具),rsync 是更好的选择。