开发容器提示和技巧
本文包含一些关于在不同环境中启动和运行开发容器扩展的提示和技巧。
安装 Docker 的其他方法
您可以通过以下几种方式将 Docker 与开发容器扩展一起使用,包括:
- 本地安装 Docker。
- 在远程环境中安装 Docker。
- 其他符合 Docker 标准的 CLI,本地或远程安装。
- 虽然其他 CLI 可能有效,但它们并未获得官方支持。请注意,附加到 Kubernetes 集群仅需要正确配置的 kubectl CLI。
您可以在替代 Docker 选项文档中了解更多信息。
自定义 AI 聊天响应
自定义指令使您能够描述通用准则或规则,以获取符合您特定编码实践和技术堆栈的响应。
您可以将自定义指令与开发容器一起使用,以便为 Copilot 提供更多关于您所连接的开发容器类型的信息(例如安装了哪些语言或工具链)。您可以通过以下几种方式实现这一点:
- 直接在您的
devcontainer.json
中添加"github.copilot.chat.codeGeneration.instructions"
- 像在本地一样使用
copilot-instructions.md
文件
Docker Desktop for Windows 技巧
Windows 版 Docker Desktop 在大多数设置中都能良好运行,但也有一些可能导致问题的“陷阱”。以下是一些避免这些问题的提示:
-
考虑在 Windows 10 (2004+) 上使用新的 Docker WSL 2 后端。如果您正在使用 Docker Desktop 的 WSL 2 后端,您可以使用它在 WSL 内部以及本地打开文件夹。容器也在 Windows 和 WSL 内部共享,并且这个新引擎更不容易出现文件共享问题。详情请参阅快速入门。
-
退出“Windows 上的 Linux 容器 (LCOW)”模式。虽然默认禁用,但最新版本的 Docker 支持 Windows 上的 Linux 容器 (LCOW),这允许您同时使用 Windows 和 Linux 容器。然而,这是一个新功能,因此您可能会遇到问题,并且开发容器扩展目前仅支持 Linux 容器。您可以随时通过右键单击 Docker 任务栏项目并从上下文菜单中选择 Switch to Linux Containers... 来退出 LCOW 模式。
-
确保您的防火墙允许 Docker 设置共享驱动器。Docker 只需要在两个本地 IP 机器之间进行连接,但某些防火墙软件可能仍会阻止任何驱动器共享或所需的端口。请参阅这篇 Docker 知识库文章,了解解决此问题的后续步骤。
以下是一些适用于旧版 Windows 版 Docker 的提示,但现在应该已经解决。如果您因可能的回归而遇到奇怪的行为,这些提示在过去曾解决过问题。
-
共享驱动器时,请使用 AD 域帐户或本地管理员帐户。请勿使用 AAD(基于电子邮件的)帐户。AAD(基于电子邮件的)帐户存在众所周知的问题,如 Docker 问题 #132 和 问题 #1352 中所述。如果您必须使用 AAD 帐户,请在您的机器上创建一个单独的本地管理员帐户,专门用于共享驱动器。按照此博客文章中的步骤进行设置。
-
坚持使用字母数字密码以避免驱动器共享问题。在 Windows 上被要求共享驱动器时,系统会提示您输入具有机器管理员权限的帐户的用户名和密码。如果收到用户名或密码不正确的警告,这可能是由于密码中包含特殊字符。例如,
!
、[
和]
已知会导致问题。更改密码为字母数字字符即可解决。有关详细信息,请参阅关于Docker 卷挂载问题的此问题。 -
使用您的 Docker ID 登录 Docker(而非您的电子邮件)。Docker CLI 仅支持使用您的 Docker ID,因此使用电子邮件可能会导致问题。详情请参阅 Docker 问题 #935。
如果您仍然遇到问题,请参阅 Docker Desktop for Windows 故障排除指南。
在 Docker Desktop 中启用文件共享
VS Code 的 开发容器 扩展仅当您的代码位于与 Docker 共享的文件夹或驱动器中时,才能自动将您的源代码挂载到容器中。如果您从非共享位置打开开发容器,容器将成功启动,但工作区将为空。
请注意,使用 Docker Desktop 的 WSL 2 引擎时,此步骤不是必需的。
要更改 Docker 的驱动器和文件夹共享设置:
Windows
- 右键单击 Docker 任务栏项目并选择 Settings(设置)。
- 转到 Resources > File Sharing(资源 > 文件共享)并勾选源代码所在的驱动器。
- 如果您看到关于本地防火墙阻止共享操作的消息,请参阅这篇 Docker 知识库文章了解后续步骤。
macOS
- 单击 Docker 菜单栏项目并选择 Preferences(首选项)。
- 转到 Resources > File Sharing(资源 > 文件共享)。确认包含您源代码的文件夹位于列出的共享文件夹之一中。
解决容器中的 Git 行尾问题(导致大量文件被修改)
由于 Windows 和 Linux 使用不同的默认行尾符,Git 可能会报告大量除了行尾符之外没有其他区别的修改文件。为防止这种情况发生,您可以使用 .gitattributes
文件或在 Windows 端全局禁用行尾符转换。
通常,在您的仓库中添加或修改 .gitattributes
文件是解决此问题最可靠的方法。将此文件提交到源代码管理将帮助其他人,并允许您根据需要按仓库改变行为。例如,将以下内容添加到仓库根目录的 .gitattributes
文件中,将强制所有内容为 LF,除了需要 CRLF 的 Windows 批处理文件:
* text=auto eol=lf
*.{cmd,[cC][mM][dD]} text eol=crlf
*.{bat,[bB][aA][tT]} text eol=crlf
请注意,这适用于 Git v2.10+,因此如果您遇到问题,请确保已安装最新的 Git 客户端。您可以在同一文件中添加仓库中其他需要 CRLF 的文件类型。
如果您仍然希望始终上传 Unix 风格的行尾符 (LF),可以使用 input
选项。
git config --global core.autocrlf input
如果您希望完全禁用行尾符转换,请运行以下命令:
git config --global core.autocrlf false
最后,您可能需要再次克隆仓库,这些设置才能生效。
使用 Docker Compose 时避免在容器中设置 Git
有关解决此问题的信息,请参阅主容器文章中的与容器共享 Git 凭据。
解决从容器执行 Git push 或 sync 时卡顿的问题
如果您使用 SSH 克隆 Git 仓库,并且您的 SSH 密钥有密码短语,则 VS Code 的拉取和同步功能在远程运行时可能会卡住。
您可以选择使用不带密码短语的 SSH 密钥,使用 HTTPS 克隆,或从命令行运行 git push
来解决此问题。
解决 Linux 依赖缺失的错误
某些扩展依赖于某些 Docker 镜像中未找到的库。请参阅容器文章,了解解决此问题的几种方法。
加速 Docker Desktop 中的容器
默认情况下,Docker Desktop 只为容器分配您机器容量的一小部分。在大多数情况下,这已足够,但如果您正在执行需要更多容量的操作,可以增加内存、CPU 或磁盘使用量。
首先,尝试停止任何您不再使用的正在运行的容器。
如果这不能解决您的问题,您可能需要查看 CPU 使用率是否确实是问题所在,或者是否有其他情况发生。检查此问题的一个简单方法是安装资源监视器扩展。当安装在容器中时,它会在状态栏中提供有关容器容量的信息。
如果您希望此扩展始终安装,请将其添加到您的 settings.json
中:
"dev.containers.defaultExtensions": [
"mutantdino.resourcemonitor"
]
如果您确定需要为容器分配更多机器容量,请按照以下步骤操作:
- 右键单击 Docker 任务栏项目并选择 Settings(设置)/ Preferences(首选项)。
- 转到 Advanced(高级)以增加 CPU、内存或交换空间。
- 在 macOS 上,转到 Disk(磁盘)以增加 Docker 允许在您的机器上消耗的磁盘空间量。在 Windows 上,此设置位于 Advanced(高级)下的其他设置中。
最后,如果您的容器正在执行磁盘密集型操作或您只是寻求更快的响应时间,请参阅提高容器磁盘性能获取提示。VS Code 的默认设置旨在优化便利性和通用支持,但可以进行优化。
清理未使用的容器和镜像
如果您看到 Docker 报告磁盘空间不足的错误,通常可以通过清理未使用的容器和镜像来解决。有几种方法可以做到这一点:
选项 1:使用远程资源管理器
您可以通过选择远程资源管理器,右键单击要删除的容器,然后选择 Remove Container(删除容器)来删除容器。
然而,这不会清理您可能已下载的任何镜像,这会使您的系统变得混乱。
选项 2:使用容器工具扩展
-
在 VS Code 中打开一个本地窗口(File > New Window)。
-
如果尚未安装,请从扩展视图安装容器工具扩展。
-
然后您可以转到容器资源管理器并展开 Containers(容器)或 Images(镜像)节点,右键单击并选择 Remove Container / Image(删除容器 / 镜像)。
选项 3:使用 Docker CLI 选择要删除的容器
- 打开一个本地终端/命令提示符(或在 VS Code 中使用本地窗口)。
- 输入
docker ps -a
以查看所有容器的列表。 - 从此列表中输入
docker rm <Container ID>
以删除容器。 - 输入
docker image prune
以删除任何未使用的镜像。
如果 docker ps
未能提供足够的信息来识别要删除的容器,以下命令将列出由 VS Code 管理的所有开发容器及其用于生成它们的文件夹。
docker ps -a --filter="label=vsch.quality" --format "table {{.ID}}\t{{.Status}}\t{{.Image}}\tvscode-{{.Label \"vsch.quality\"}}\t{{.Label \"vsch.local.folder\"}}"
选项 4:使用 Docker Compose
- 打开一个本地终端/命令提示符(或在 VS Code 中使用本地窗口)。
- 进入包含
docker-compose.yml
文件的目录。 - 输入
docker-compose down
以停止并删除容器。如果您有多个 Docker Compose 文件,可以使用-f
参数指定额外的 Docker Compose 文件。
选项 4:删除所有未运行的容器和镜像
- 打开一个本地终端/命令提示符(或在 VS Code 中使用本地窗口)。
- 输入
docker system prune --all
。
解决使用 Debian 8 镜像的 Dockerfile 构建失败问题
当构建使用基于 Debian 8/Jessie 的镜像的容器时(例如旧版本的 node:8
镜像),您可能会遇到以下错误:
...
W: Failed to fetch http://deb.debian.org/debian/dists/jessie-updates/InRelease Unable to find expected entry 'main/binary-amd64/Packages' in Release file (Wrong sources.list entry or malformed file)
E: Some index files failed to download. They have been ignored, or old ones used instead.
...
这是一个众所周知的问题,原因是 Debian 8 已被“归档”。最新版本的镜像通常通过升级到 Debian 9/Stretch 来解决此问题。
有两种方法可以解决此错误:
-
选项 1:删除任何依赖于该镜像的容器,删除该镜像,然后再次尝试构建。这应该会下载一个不受此问题影响的更新镜像。详情请参阅清理未使用的容器和镜像。
-
选项 2:如果您不想删除容器或镜像,请在任何
apt
或apt-get
命令之前将此行添加到您的 Dockerfile 中。它为 Jessie 添加了所需的源列表:# Add archived sources to source list if base image uses Debian 8 / Jessie RUN cat /etc/*-release | grep -q jessie && printf "deb http://archive.debian.org/debian/ jessie main\ndeb-src http://archive.debian.org/debian/ jessie main\ndeb http://security.debian.org jessie/updates main\ndeb-src http://security.debian.org jessie/updates main" > /etc/apt/sources.list
解决使用电子邮件登录 Docker Hub 时的错误
Docker CLI 仅支持使用您的 Docker ID,因此使用电子邮件登录可能会导致问题。详情请参阅 Docker 问题 #935。
作为一种解决方法,请使用您的 Docker ID 而不是电子邮件登录 Docker。
macOS 上 Hyperkit 的高 CPU 利用率
Docker for Mac 存在一个已知问题,可能导致 CPU 使用率飙升。特别是,在监视文件和构建时,CPU 使用率会很高。如果您在活动监视器中看到 com.docker.hyperkit
的 CPU 使用率很高,而您的开发容器中几乎没有活动,则很可能遇到了这个问题。请关注该 Docker 问题以获取更新和修复。
使用 SSH 隧道连接到远程 Docker 主机
文章在远程 Docker Machine 或 SSH 主机上的容器中进行开发介绍了在使用远程 Docker 主机时如何设置 VS Code。这通常就像在 settings.json
中设置 容器工具扩展的 containers.environment
属性,或将 DOCKER_HOST
环境变量设置为 ssh://
或 tcp://
URI 一样简单。
然而,由于 SSH 配置的复杂性或其他限制,您可能会遇到在您的环境中无法正常工作的情况。在这种情况下,SSH 隧道可以作为备用方案使用。
将 SSH 隧道作为备用选项
您可以设置 SSH 隧道,并将 Docker 套接字从远程主机转发到本地机器。
请按照以下步骤操作:
-
安装一个兼容 OpenSSH 的 SSH 客户端。
-
更新您的用户或工作区
settings.json
中容器工具扩展的containers.environment
属性,如下所示:"containers.environment": { "DOCKER_HOST": "tcp://:23750" }
-
从本地终端 / PowerShell 运行以下命令(将
user@hostname
替换为远程用户和您的服务器主机名 / IP):ssh -NL localhost:23750:/var/run/docker.sock user@hostname
现在,VS Code 将能够附加到远程主机上的任何正在运行的容器。您还可以使用专门的本地 devcontainer.json
文件来创建/连接远程开发容器。
完成后,在终端 / PowerShell 中按 Ctrl+C 以关闭隧道。
注意:如果
ssh
命令失败,您可能需要在 SSH 主机上设置AllowStreamLocalForwarding
。
- 在SSH 主机(而非本地)上使用编辑器(如 Vim、nano 或 Pico)打开
/etc/ssh/sshd_config
。- 添加设置
AllowStreamLocalForwarding yes
。- 重启 SSH 服务器(在 Ubuntu 上,运行
sudo systemctl restart sshd
)。- 重试。
持久化用户配置文件
您可以使用 mounts
属性来持久化开发容器中的用户配置文件(以保留 shell 历史记录等),使其在重建后仍然存在。
"mounts": [
"source=profile,target=/root,type=volume",
"target=/root/.vscode-server,type=volume"
],
上述代码首先创建了一个名为 profile
的命名卷并将其挂载到 /root
,该卷将在重建后保留。接着,它创建了一个匿名卷并将其挂载到 /root/.vscode-server
,该卷将在重建时被销毁,这允许 VS Code 重新安装扩展和点文件。
高级容器配置技巧
有关以下主题的信息,请参阅高级容器配置文章:
- 添加环境变量
- 添加另一个本地文件挂载
- 更改或移除默认源代码挂载
- 提高容器磁盘性能
- 向开发容器添加非 root 用户
- 为 Docker Compose 设置项目名称
- 在容器内部使用 Docker 或 Kubernetes
- 同时连接到多个容器
- 在远程 Docker Machine 或 SSH 主机上的容器中进行开发
- 减少 Dockerfile 构建警告
- 与容器共享 git 凭据
扩展技巧
虽然许多扩展可以未经修改地工作,但仍有一些问题可能导致某些功能无法按预期运行。在某些情况下,您可以使用其他命令来解决问题,而在其他情况下,可能需要修改扩展。在远程扩展技巧部分提供了常见问题及其解决方法。您还可以参考关于支持远程开发的主扩展文章,获取关于修改扩展以支持远程扩展主机的深入指南。
问题和反馈
报告问题
如果您在使用开发容器扩展时遇到问题,收集正确的日志非常重要,这样我们才能帮助诊断您的问题。您可以通过开发容器:显示容器日志获取开发容器扩展日志。
如果您在使用其他扩展进行远程操作时遇到问题(例如,其他扩展在远程上下文中无法正确加载或安装),则从远程扩展主机输出通道(输出:聚焦输出视图)获取日志,并从下拉列表中选择 Log (Remote Extension Host)(日志(远程扩展主机))将很有帮助。
注意:如果您只看到 Log (Extension Host)(日志(扩展主机)),这是本地扩展主机,并且远程扩展主机未启动。这是因为日志通道仅在日志文件创建后才会创建,因此如果远程扩展主机未启动,则不会创建远程扩展主机日志文件,也不会在“输出”视图中显示。这仍然是包含在您的问题中的有用信息。
远程问题和反馈资源
我们有各种其他远程资源
- 在 Stack Overflow 上搜索。
- 添加功能请求或报告问题。