docker debug

描述	获取对任何容器或镜像的 shell 访问。一种替代使用 `docker exec` 进行调试的方法。
用法	`debug [OPTIONS] {CONTAINER\|IMAGE}`

订阅： Pro Team Business

要求： Docker Desktop 4.33.0 及更高版本

描述

Docker Debug 是一个 CLI 命令，通过保持镜像小巧且安全，帮助您遵循最佳实践。使用 Docker Debug，您可以在镜像仅包含运行应用程序所需的最少内容时对其进行调试。它通过允许您创建和使用通常难以调试的精简镜像或容器来实现这一点，因为这些镜像或容器已移除了所有工具。例如，虽然典型的调试方法（如 docker exec -it my-app bash）可能无法在精简容器上工作，但 docker debug 可以。

使用 docker debug，即使容器或镜像不包含 shell，您也可以获得调试 shell。您无需修改镜像即可使用 Docker Debug。然而，使用 Docker Debug 也不会修改您的镜像。Docker Debug 带来了自己的工具箱，您可以轻松自定义。工具箱预装了许多标准 Linux 工具，例如 vim、nano、htop 和 curl。使用内置的 install 命令可以添加在 https://search.nixos.org/packages 上提供的其他工具。Docker Debug 支持 bash、fish 和 zsh。默认情况下，它会尝试自动检测您的 shell。

自定义内置工具

install [tool1] [tool2]：从以下位置添加 Nix 包：https://search.nixos.org/packages，请参阅示例。
uninstall [tool1] [tool2]：卸载 Nix 包。
entrypoint：打印、检查或运行入口点，请参阅示例。
builtins：显示自定义内置工具。

注意
对于镜像和已停止的容器，退出 shell 时，所有更改都将被丢弃。更改在任何时候都不会影响实际的镜像或容器。访问运行中或已暂停的容器时，所有文件系统更改对容器都是直接可见的。/nix 目录对于实际的镜像或容器始终不可见。

选项

选项	默认值	描述
`--shell`	`auto`	选择 shell。支持：`bash`、`fish`、`zsh`、`auto`。
`-c, --command`		执行指定的命令，而不是启动交互式会话，请参阅示例。
`--host`		要连接的守护进程 docker socket。例如：`ssh://root@example.org`、`unix:///some/path/docker.sock`，请参阅示例。

示例

调试没有 shell 的容器（精简容器）

hello-world 镜像非常简单，只包含 /hello 二进制文件。它是精简镜像的一个很好的例子。没有其他工具，也没有 shell。

从 hello-world 镜像运行容器

$ docker run --name my-app hello-world

容器立即退出。要获取内部的调试 shell，请运行

$ docker debug my-app

调试 shell 允许您检查文件系统

docker > ls
dev  etc  hello  nix  proc  sys

文件 /hello 是运行容器时执行的二进制文件。您可以直接运行它来确认这一点

docker > /hello

运行二进制文件后，它会产生相同的输出。

调试（精简）镜像

您可以通过运行以下命令直接调试镜像

$ docker debug hello-world
...
docker > ls
dev  etc  hello  nix  proc  sys

您甚至无需拉取镜像，因为 docker debug 会像 docker run 命令一样自动执行此操作。

修改正在运行容器的文件

Docker debug 允许您修改任何正在运行容器中的文件。工具箱预装了 vim 和 nano。

运行一个 nginx 容器并更改默认的 index.html

$ docker run -d --name web-app -p 8080:80 nginx
d3d6074d0ea901c96cac8e49e6dad21359616bef3dc0623b3c2dfa536c31dfdb

要确认 nginx 正在运行，请打开浏览器并导航到 http://localhost:8080。您应该会看到默认的 nginx 页面。现在，使用 vim 更改它

vim /usr/share/nginx/html/index.html

将标题更改为 "Welcome to my app!" 并保存文件。现在，在浏览器中重新加载页面，您应该会看到更新后的页面。

使用 `install` 命令管理您的工具箱

内置的 install 命令允许您从 https://search.nixos.org/packages 将任何工具添加到工具箱。请记住，添加工具绝不会修改实际的镜像或容器。工具只添加到您的工具箱中。运行 docker debug，然后安装 nmap

$ docker debug nginx
...
docker > install nmap
Tip: You can install any package available at: https://search.nixos.org/packages.
installing 'nmap-7.93'
these 2 paths will be fetched (5.58 MiB download, 26.27 MiB unpacked):
/nix/store/brqjf4i23fagizaq2gn4d6z0f406d0kg-lua-5.3.6
/nix/store/xqd17rhgmn6pg85a3g18yqxpcya6d06r-nmap-7.93
copying path '/nix/store/brqjf4i23fagizaq2gn4d6z0f406d0kg-lua-5.3.6' from 'https://cache.nixos.org'...
copying path '/nix/store/xqd17rhgmn6pg85a3g18yqxpcya6d06r-nmap-7.93' from 'https://cache.nixos.org'...
building '/nix/store/k8xw5wwarh8dc1dvh5zx8rlwamxfsk3d-user-environment.drv'...

docker > nmap --version
Nmap version 7.93 ( https://nmap.org )
Platform: x86_64-unknown-linux-gnu
Compiled with: liblua-5.3.6 openssl-3.0.11 libssh2-1.11.0 nmap-libz-1.2.12 libpcre-8.45 libpcap-1.10.4 nmap-libdnet-1.12 ipv6
Compiled without:
Available nsock engines: epoll poll select

通过获取另一个镜像的调试 shell，您可以确认 nmap 现在是您工具箱的一部分

$ docker debug hello-world
...
docker > nmap --version

Nmap version 7.93 ( https://nmap.org )
Platform: x86_64-unknown-linux-gnu
Compiled with: liblua-5.3.6 openssl-3.0.11 libssh2-1.11.0 nmap-libz-1.2.12 libpcre-8.45 libpcap-1.10.4 nmap-libdnet-1.12 ipv6
Compiled without:
Available nsock engines: epoll poll select

docker > exit

nmap 仍然存在。

了解容器的默认启动命令（入口点）

Docker Debug 提供了一个内置工具，entrypoint。进入 hello-world 镜像并确认入口点是 /hello

$ docker debug hello-world
...
docker > entrypoint --print
/hello

entrypoint 命令会评估底层镜像的 ENTRYPOINT 和 CMD 语句，并允许您打印、检查或运行结果入口点。然而，要理解来自理解 CMD 和 ENTRYPOINT 如何交互的所有边缘情况可能很困难。在这些情况下，entrypoint 会有所帮助。

使用 entrypoint 查看从 Nginx 镜像运行容器时实际发生的情况

$ docker debug nginx
...
docker > entrypoint
Understand how ENTRYPOINT/CMD work and if they are set correctly.
From CMD in Dockerfile:
 ['nginx', '-g', 'daemon off;']

From ENTRYPOINT in Dockerfile:
 ['/docker-entrypoint.sh']

By default, any container from this image will be started with following   command:

/docker-entrypoint.sh nginx -g daemon off;

path: /docker-entrypoint.sh
args: nginx -g daemon off;
cwd:
PATH: /usr/local/sbin:/usr/local/bin:/usr/sbin:/usr/bin:/sbin:/bin

Lint results:
 PASS: '/docker-entrypoint.sh' found
 PASS: no mixing of shell and exec form
 PASS: no double use of shell form

Docs:
- https://docs.docker.net.cn/reference/dockerfile/#cmd
- https://docs.docker.net.cn/reference/dockerfile/#entrypoint
- https://docs.docker.net.cn/reference/dockerfile/#understand-how-cmd-and-entrypoint-interact

输出告诉您，在 nginx 镜像启动时，会执行脚本 /docker-entrypoint.sh，并带参数 nginx -g daemon off;。您可以使用 --run 选项测试入口点

$ docker debug nginx
...
docker > entrypoint --run
/docker-entrypoint.sh: /docker-entrypoint.d/ is not empty, will attempt to perform configuration
/docker-entrypoint.sh: Looking for shell scripts in /docker-entrypoint.d/
/docker-entrypoint.sh: Launching /docker-entrypoint.d/10-listen-on-ipv6-by-default.sh
10-listen-on-ipv6-by-default.sh: info: Getting the checksum of /etc/nginx/conf.d/default.conf
10-listen-on-ipv6-by-default.sh: info: Enabled listen on IPv6 in /etc/nginx/conf.d/default.conf
/docker-entrypoint.sh: Sourcing /docker-entrypoint.d/15-local-resolvers.envsh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/20-envsubst-on-templates.sh
/docker-entrypoint.sh: Launching /docker-entrypoint.d/30-tune-worker-processes.sh
/docker-entrypoint.sh: Configuration complete; ready for start up
2024/01/19 17:34:39 [notice] 50#50: using the "epoll" event method
2024/01/19 17:34:39 [notice] 50#50: nginx/1.25.3
2024/01/19 17:34:39 [notice] 50#50: built by gcc 12.2.0 (Debian 12.2.0-14)
2024/01/19 17:34:39 [notice] 50#50: OS: Linux 5.15.133.1-microsoft-standard-WSL2
2024/01/19 17:34:39 [notice] 50#50: getrlimit(RLIMIT_NOFILE): 1048576:1048576
2024/01/19 17:34:39 [notice] 50#50: start worker processes
2024/01/19 17:34:39 [notice] 50#50: start worker process 77
...

这会在您的调试 shell 中启动 nginx，而无需实际运行容器。您可以通过按 Ctrl+C 来关闭 nginx。

直接运行命令（例如，用于脚本编写）

使用 --command 选项直接执行命令，而不是启动交互式会话。例如，这类似于 bash -c "arg1 arg2 ..."。以下示例在 nginx 镜像中运行 cat 命令，而不启动交互式会话。

$ docker debug --command "cat /usr/share/nginx/html/index.html" nginx

<!DOCTYPE html>
<html>
<head>
<title>Welcome to nginx!</title>
<style>
html { color-scheme: light dark; }
body { width: 35em; margin: 0 auto;
font-family: Tahoma, Verdana, Arial, sans-serif; }
</style>
</head>
<body>
<h1>Welcome to nginx!</h1>
<p>If you see this page, the nginx web server is successfully installed and
working. Further configuration is required.</p>

<p>For online documentation and support please refer to
<a href="https://nginx.ac.cn/">nginx.org</a>.<br/>
Commercial support is available at
<a href="http://nginx.com/">nginx.com</a>.</p>

<p><em>Thank you for using nginx.</em></p>
</body>
</html>

使用 --host 选项进行远程调试

以下示例展示了如何使用 --host 选项。第一个示例使用 SSH 以 root 用户身份连接到 example.org 上的远程 Docker 实例，并获取进入 my-container 容器的 shell。

$ docker debug --host ssh://root@example.org my-container

以下示例连接到另一个本地 Docker Engine，并获取进入 my-container 容器的 shell。

$ docker debug --host=unix:///some/path/docker.sock my-container