{"id":13614318,"url":"https://github.com/zeromake/docker-debug","last_synced_at":"2025-05-15T14:04:52.110Z","repository":{"id":44896715,"uuid":"170485616","full_name":"zeromake/docker-debug","owner":"zeromake","description":"use new container attach on already container go on debug","archived":false,"fork":false,"pushed_at":"2025-04-17T01:38:15.000Z","size":329,"stargazers_count":595,"open_issues_count":1,"forks_count":40,"subscribers_count":13,"default_branch":"master","last_synced_at":"2025-05-14T07:21:42.994Z","etag":null,"topics":["cli","debug","docker","exec"],"latest_commit_sha":null,"homepage":null,"language":"Go","has_issues":true,"has_wiki":null,"has_pages":null,"mirror_url":null,"source_name":null,"license":"mit","status":null,"scm":"git","pull_requests_enabled":true,"icon_url":"https://github.com/zeromake.png","metadata":{"files":{"readme":"README-zh-Hans.md","changelog":"CHANGELOG.md","contributing":null,"funding":".github/FUNDING.yml","license":"LICENSE","code_of_conduct":null,"threat_model":null,"audit":null,"citation":null,"codeowners":null,"security":null,"support":null,"governance":null,"roadmap":null,"authors":null,"dei":null,"publiccode":null,"codemeta":null,"zenodo":null},"funding":{"github":null,"patreon":null,"open_collective":"docker-debug","ko_fi":null,"tidelift":null,"custom":null}},"created_at":"2019-02-13T10:09:13.000Z","updated_at":"2025-05-14T06:39:12.000Z","dependencies_parsed_at":"2023-09-23T14:38:27.124Z","dependency_job_id":"16a63dd2-3996-43de-8885-1b20b3177c31","html_url":"https://github.com/zeromake/docker-debug","commit_stats":{"total_commits":129,"total_committers":6,"mean_commits":21.5,"dds":"0.10077519379844957","last_synced_commit":"421445468117a945ff1dde5c8a545979463344ad"},"previous_names":[],"tags_count":23,"template":false,"template_full_name":null,"repository_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromake%2Fdocker-debug","tags_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromake%2Fdocker-debug/tags","releases_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromake%2Fdocker-debug/releases","manifests_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories/zeromake%2Fdocker-debug/manifests","owner_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners/zeromake","download_url":"https://codeload.github.com/zeromake/docker-debug/tar.gz/refs/heads/master","host":{"name":"GitHub","url":"https://github.com","kind":"github","repositories_count":254355334,"owners_count":22057354,"icon_url":"https://github.com/github.png","version":null,"created_at":"2022-05-30T11:31:42.601Z","updated_at":"2022-07-04T15:15:14.044Z","host_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub","repositories_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repositories","repository_names_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/repository_names","owners_url":"https://repos.ecosyste.ms/api/v1/hosts/GitHub/owners"}},"keywords":["cli","debug","docker","exec"],"created_at":"2024-08-01T20:00:59.783Z","updated_at":"2025-05-15T14:04:52.091Z","avatar_url":"https://github.com/zeromake.png","language":"Go","readme":"# Docker-debug\n\n[![Build Status](https://github.com/zeromake/docker-debug/actions/workflows/release.yml/badge.svg)](https://github.com/zeromake/docker-debug/actions/workflows/release.yml)\n[![Go Report Card](https://goreportcard.com/badge/zeromake/docker-debug)](https://goreportcard.com/report/zeromake/docker-debug)\n\n[English](README.md) ∙ [简体中文](README-zh-Hans.md)\n\n## Overview\n\n`docker-debug` 是一个运行中的 `docker` 容器故障排查方案,\n在运行中的 `docker` 上额外启动一个容器，并将目标容器的 `pid`, `network`, `uses`, `filesystem` 和 `ipc` 命名空间注入到新的容器里，\n因此，您可以使用任意故障排除工具，而无需在生产容器镜像中预先安装额外的工具环境。\n\n## Demo\n[![asciicast](https://asciinema.org/a/235025.svg)](https://asciinema.org/a/235025)\n## Quick Start\n\n安装 `docker-debug` 命令行工具\n\n**mac brew**\n\n```shell\nbrew install zeromake/docker-debug/docker-debug\n```\n\n**下载二进制文件**\n\n\u003cdetails\u003e\n\u003csummary\u003e\n\u003ckbd\u003e使用 bash 或 zsh\u003c/kbd\u003e\n\u003c/summary\u003e\n\n``` bash\n# get latest tag\nVERSION=`curl -w '%{url_effective}' -I -L -s -S https://github.com/zeromake/docker-debug/releases/latest -o /dev/null | awk -F/ '{print $NF}'`\n\n# MacOS Intel\ncurl -Lo docker-debug https://github.com/zeromake/docker-debug/releases/download/${VERSION}/docker-debug-darwin-amd64\n\n# MacOS M1\ncurl -Lo docker-debug https://github.com/zeromake/docker-debug/releases/download/${VERSION}/docker-debug-darwin-arm64\n\n# Linux\ncurl -Lo docker-debug https://github.com/zeromake/docker-debug/releases/download/${VERSION}/docker-debug-linux-amd64\n\nchmod +x ./docker-debug\nsudo mv docker-debug /usr/local/bin/\n\n# Windows\ncurl -Lo docker-debug.exe https://github.com/zeromake/docker-debug/releases/download/${VERSION}/docker-debug-windows-amd64.exe\n```\n\n\u003c/details\u003e\n\n\u003cdetails\u003e\n\u003csummary\u003e\n\u003ckbd\u003e使用 fish\u003c/kbd\u003e\n\u003c/summary\u003e\n\n``` fish\n# get latest tag\nset VERSION (curl -w '%{url_effective}' -I -L -s -S https://github.com/zeromake/docker-debug/releases/latest -o /dev/null | awk -F/ '{print $NF}')\n\n# MacOS Intel\ncurl -Lo docker-debug https://github.com/zeromake/docker-debug/releases/download/$VERSION/docker-debug-darwin-amd64\n\n# MacOS M1\ncurl -Lo docker-debug https://github.com/zeromake/docker-debug/releases/download/$VERSION/docker-debug-darwin-arm64\n\n# Linux\ncurl -Lo docker-debug https://github.com/zeromake/docker-debug/releases/download/$VERSION/docker-debug-linux-amd64\n\nchmod +x ./docker-debug\nsudo mv docker-debug /usr/local/bin/\n\n# Windows\ncurl -Lo docker-debug.exe https://github.com/zeromake/docker-debug/releases/download/$VERSION/docker-debug-windows-amd64.exe\n```\n\u003c/details\u003e\n\n\n或者到 [release page](https://github.com/zeromake/docker-debug/releases/lastest) 下载最新可执行文件并添加到 PATH。\n\n**我们来试试吧！**\n``` shell\n# docker-debug [OPTIONS] CONTAINER COMMAND [ARG...] [flags]\ndocker-debug CONTAINER COMMAND\n\n# More flags\ndocker-debug --help\n\n# info\ndocker-debug info\n```\n\n## Build from source\nClone this repo and:\n``` shell\ngo build -o docker-debug ./cmd/docker-debug\nmv docker-debug /usr/local/bin\n```\n\n## 默认镜像\ndocker-debug 使用 `nicolaka/netshoot` 作为默认镜像来运行额外容器。\n你可以通过命令行 `flag(--image)` 覆盖默认镜像，或者直接修改配置文件 `~/.docker-debug/config.toml` 中的 `image`。\n``` toml\n# 配置文件版本号\nversion = \"0.7.4\"\n# 目标容器文件系统挂载点\nmount_dir = \"/mnt/container\"\n# 默认镜像\nimage = \"nicolaka/netshoot:latest\"\n# 大多数docker操作的超时，默认为 10s。\ntimeout = 10000000000\n# 默认使用哪个配置来连接docker\nconfig_default = \"default\"\n\n# docker 连接配置\n[config]\n  # docker 默认连接配置\n  [config.default]\n    # docker 客户端版本指定默认 1.40\n    version = \"1.40\"\n    host = \"unix:///var/run/docker.sock\"\n    # 是否为 tls\n    tls = false\n    # 证书目录\n    cert_dir = \"\"\n    # 证书密码\n    cert_password = \"\"\n```\n\n## 详细\n1. 在 `docker` 中查找镜像，没有调用 `docker` 拉取镜像。\n2. 查找目标容器, 没找到返回报错。\n3. 通过自定义镜像创建一个容器并挂载 `ipc`, `pid`, `network`, `etc`, `filesystem`。\n4. 在新容器中创建并运行 `docker exec`。\n5. 在新容器中进行调试。\n6. 等待调试容器退出运行，把调试用的额外容器清理掉。\n\n## Reference \u0026 Thank\n1. [kubectl-debug](https://github.com/aylei/kubectl-debug): `docker-debug` 想法来自这个 kubectl 调试工具。\n2. [Docker核心技术与实现原理](https://draveness.me/docker): `docker-debug` 的文件系统挂载原理来自这个博文。\n3. [docker-engine-api-doc](https://docs.docker.com/engine/api/latest): docker engine api 文档。\n","funding_links":["https://opencollective.com/docker-debug"],"categories":["Go","Containers"],"sub_categories":["Shell into containers"],"project_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeromake%2Fdocker-debug","html_url":"https://awesome.ecosyste.ms/projects/github.com%2Fzeromake%2Fdocker-debug","lists_url":"https://awesome.ecosyste.ms/api/v1/projects/github.com%2Fzeromake%2Fdocker-debug/lists"}