odboy
f5ae80c1a8
- exec/rm/rmi/stop/restart 支持名称、ID 或唯一 ID 前缀，目标不存在或 前缀有歧义时在调用 docker 前报错；exec 默认 -it 并以 -- 分隔命令 - logs 新增 --since/--grep/--save；df 改为按占用排序的可读排行； stats 默认单次快照，无参数时统计全部运行中容器 - 破坏性确认：Command.ConfirmBuiltin 提供将删除对象的清单， rm/rmi 无 --yes 时列清单并退出码 2，拒绝 -f，运行中容器提示先 stop - 抽出 executor/dockertargets.go 统一镜像/容器解析与 docker 调用
504 lines
18 KiB
Go
504 lines
18 KiB
Go
package registry
|
||
|
||
// Builtin returns the registry compiled into kopsc. Every variant is explicit
|
||
// about the platform it targets; resolution picks the most specific match.
|
||
func Builtin() *Registry {
|
||
return &Registry{Commands: []Command{
|
||
// ----- read-only -----
|
||
{
|
||
ID: "docker.ps",
|
||
Group: "docker",
|
||
Summary: "列出运行中的容器",
|
||
Action: "只读：等价 docker ps，参数可透传（如 --format、--filter）",
|
||
Variants: runtimeVariants("ps"),
|
||
},
|
||
{
|
||
ID: "docker.psall",
|
||
Group: "docker",
|
||
Summary: "列出全部容器（含已停止）",
|
||
Action: "只读：等价 docker ps -a",
|
||
Variants: runtimeVariants("ps", "-a"),
|
||
},
|
||
{
|
||
ID: "docker.images",
|
||
Group: "docker",
|
||
Summary: "列出本地镜像",
|
||
Action: "只读：等价 docker images",
|
||
Variants: runtimeVariants("images"),
|
||
},
|
||
{
|
||
ID: "docker.stats",
|
||
Group: "docker",
|
||
Summary: "一次性查看容器 CPU/内存/IO 占用",
|
||
Action: "只读：等价 docker stats --no-stream，输出一次后退出；不给容器名时自动统计全部运行中的容器，" +
|
||
"给了名称或 ID 时只统计这些（需正在运行）；--format 等选项可透传",
|
||
Usage: "[容器...]",
|
||
Variants: runtimeBuiltinVariants("stats"),
|
||
},
|
||
{
|
||
ID: "docker.df",
|
||
Group: "docker",
|
||
Summary: "磁盘占用排行（镜像/容器/卷/构建缓存）",
|
||
Action: "只读：在 docker system df 之上按占用大小降序排列，输出「类型 / 项 / 可清理 / 大小 / 可回收」，" +
|
||
"并给出总计与一句可回收空间提示",
|
||
Variants: runtimeBuiltinVariants("df"),
|
||
},
|
||
{
|
||
ID: "docker.info",
|
||
Group: "docker",
|
||
Summary: "查看容器运行时与主机环境信息",
|
||
Action: "只读：等价 docker info",
|
||
Variants: runtimeVariants("info"),
|
||
},
|
||
{
|
||
ID: "docker.version",
|
||
Group: "docker",
|
||
Summary: "查看容器运行时版本",
|
||
Action: "只读：等价 docker version",
|
||
Variants: runtimeVariants("version"),
|
||
},
|
||
{
|
||
ID: "docker.logs",
|
||
Group: "docker",
|
||
Summary: "查看容器日志（可过滤、可落盘）",
|
||
Action: "等价 docker logs <容器>，并增加 kopsc 选项：--since 只看某时间段、--grep 只显示匹配行、--save 把显示的日志追加写入文件；" +
|
||
"--since/--grep/--save 必须写在容器名之前，容器名之后的 -f、--tail 等原样交给 docker",
|
||
Usage: "<容器> [选项...]",
|
||
MinArgs: 1,
|
||
Variants: runtimeBuiltinVariants("logs"),
|
||
},
|
||
{
|
||
ID: "docker.inspect",
|
||
Group: "docker",
|
||
Summary: "查看容器/镜像/网络/卷的详细信息",
|
||
Action: "只读：等价 docker inspect <对象>",
|
||
Usage: "<对象>",
|
||
MinArgs: 1,
|
||
Variants: runtimeVariants("inspect"),
|
||
},
|
||
{
|
||
ID: "docker.networks",
|
||
Group: "docker",
|
||
Summary: "列出容器网络",
|
||
Action: "只读：等价 docker network ls",
|
||
Variants: runtimeVariants("network", "ls"),
|
||
},
|
||
{
|
||
ID: "docker.volumes",
|
||
Group: "docker",
|
||
Summary: "列出数据卷",
|
||
Action: "只读：等价 docker volume ls",
|
||
Variants: runtimeVariants("volume", "ls"),
|
||
},
|
||
|
||
// ----- lifecycle -----
|
||
{
|
||
ID: "docker.start",
|
||
Group: "docker",
|
||
Summary: "启动已停止的容器",
|
||
Action: "启动一个或多个已存在的容器，不创建新容器",
|
||
Usage: "<容器>",
|
||
MinArgs: 1,
|
||
Variants: runtimeVariants("start"),
|
||
},
|
||
{
|
||
ID: "docker.stop",
|
||
Group: "docker",
|
||
Summary: "停止运行中的容器（按名称或 ID）",
|
||
Action: "等价 docker stop：容器按名称、ID 或唯一 ID 前缀解析，一次可停多个；" +
|
||
"先发送 SIGTERM，超时后由 docker 强制结束。-t/--time、-s/--signal 可透传",
|
||
Usage: "<容器>...",
|
||
MinArgs: 1,
|
||
Variants: runtimeBuiltinVariants("stop"),
|
||
},
|
||
{
|
||
ID: "docker.restart",
|
||
Group: "docker",
|
||
Summary: "重启容器（按名称或 ID）",
|
||
Action: "等价 docker restart：容器按名称、ID 或唯一 ID 前缀解析，一次可重启多个；" +
|
||
"-t/--time、-s/--signal 可透传",
|
||
Usage: "<容器>...",
|
||
MinArgs: 1,
|
||
Variants: runtimeBuiltinVariants("restart"),
|
||
},
|
||
{
|
||
ID: "docker.rm",
|
||
Group: "docker",
|
||
Summary: "删除容器（按名称或 ID）",
|
||
Action: "等价 docker rm：容器按名称、ID 或唯一 ID 前缀解析，一次可删多个；" +
|
||
"运行中的容器不会被强制删除，需先 kopsc docker stop。不再接受 -f，需要强删请用 --yes 确认",
|
||
Usage: "<容器>...",
|
||
MinArgs: 1,
|
||
RequiresYes: true,
|
||
ConfirmBuiltin: "docker.rm.preview",
|
||
Variants: runtimeBuiltinVariants("rm"),
|
||
},
|
||
{
|
||
ID: "docker.rmi",
|
||
Group: "docker",
|
||
Summary: "删除本地镜像（按名称或 ID）",
|
||
Action: "等价 docker rmi：镜像按名称、ID、sha256:ID 或唯一 ID 前缀解析，一次可删多个；" +
|
||
"未打标签的悬空镜像按 ID 删除。不再接受 -f，需要强删请用 --yes 确认",
|
||
Usage: "<镜像名|镜像ID>...",
|
||
MinArgs: 1,
|
||
RequiresYes: true,
|
||
ConfirmBuiltin: "docker.rmi.preview",
|
||
Variants: runtimeBuiltinVariants("rmi"),
|
||
},
|
||
{
|
||
ID: "docker.exec",
|
||
Group: "docker",
|
||
Summary: "在运行中的容器内执行命令（默认交互）",
|
||
Action: "等价 docker exec -it <容器> -- <命令...>：默认就是交互模式，无需再写 -it（显式传 -i/-t/-it 会报错）；" +
|
||
"容器名之后的参数一律作为在容器内执行的命令，其中的 -i、-p 等不会被当成 docker 选项；" +
|
||
"容器名之前的选项（如 -u、-w、-e）原样透传给 docker",
|
||
Usage: "<容器> <命令...>",
|
||
MinArgs: 1,
|
||
Variants: runtimeBuiltinVariants("exec"),
|
||
},
|
||
{
|
||
ID: "docker.pull",
|
||
Group: "docker",
|
||
Summary: "拉取镜像",
|
||
Action: "从镜像仓库拉取指定镜像",
|
||
Usage: "<镜像>",
|
||
MinArgs: 1,
|
||
Variants: runtimeVariants("pull"),
|
||
},
|
||
{
|
||
ID: "docker.tag",
|
||
Group: "docker",
|
||
Summary: "给镜像打标签",
|
||
Action: "把已有镜像标记为新的名称与标签",
|
||
Usage: "<源镜像> <目标镜像>",
|
||
MinArgs: 2,
|
||
Variants: runtimeVariants("tag"),
|
||
},
|
||
{
|
||
ID: "docker.save",
|
||
Group: "docker",
|
||
Summary: "把镜像导出为 <镜像名>.tar",
|
||
Action: "等价 docker save <镜像> -o <镜像名>.tar：归档文件按镜像的仓库名与标签命名，" +
|
||
"标签的冒号改写为下划线（alpine:3.20 → alpine_3.20.tar，registry:5000/team/app:1.0 → registry_5000_team_app_1.0.tar）；" +
|
||
"传入镜像 ID 时先解析出它对应的镜像名称，再据此命名；未打标签的镜像直接报错。" +
|
||
"--platform 等选项原样透传给底层运行时",
|
||
Usage: "<镜像名|镜像ID>",
|
||
MinArgs: 1,
|
||
Variants: runtimeBuiltinVariants("save"),
|
||
},
|
||
{
|
||
ID: "docker.load",
|
||
Group: "docker",
|
||
Summary: "从 <归档.tar> 导入镜像",
|
||
Action: "等价 docker load -i <归档.tar>：归档文件作为位置参数（对应原本的 docker load < xxx.tar），" +
|
||
"可一次给出多个；仍可用 -i/--input 指定，或传 - 表示从标准输入读取",
|
||
Usage: "<归档.tar>...",
|
||
MinArgs: 1,
|
||
Variants: runtimeBuiltinVariants("load"),
|
||
},
|
||
{
|
||
ID: "docker.cp",
|
||
Group: "docker",
|
||
Summary: "在容器与主机之间复制文件",
|
||
Action: "等价 docker cp <源> <目标>，任一方向均可",
|
||
Usage: "<源> <目标>",
|
||
MinArgs: 2,
|
||
Variants: runtimeVariants("cp"),
|
||
},
|
||
|
||
// ----- cleanup -----
|
||
{
|
||
ID: "docker.clearsafe",
|
||
Aliases: []string{"docker.prunesafe"},
|
||
Group: "docker",
|
||
Summary: "安全清理未使用的容器、网络与构建缓存",
|
||
Action: "执行容器运行时的默认清理作用域：不清理全部未使用镜像（-a），不删除卷（--volumes），仅移除停止的容器、未使用的网络和悬空镜像",
|
||
Variants: runtimeVariants("system", "prune", "-f"),
|
||
},
|
||
{
|
||
ID: "docker.pruneimages",
|
||
Group: "docker",
|
||
Summary: "清理悬空镜像（dangling）",
|
||
Action: "等价 docker image prune -f，只删除没有标签且未被引用的悬空镜像",
|
||
Variants: runtimeVariants("image", "prune", "-f"),
|
||
},
|
||
{
|
||
ID: "docker.prunecontainers",
|
||
Group: "docker",
|
||
Summary: "清理已停止的容器",
|
||
Action: "等价 docker container prune -f，删除所有已停止的容器",
|
||
Variants: runtimeVariants("container", "prune", "-f"),
|
||
},
|
||
{
|
||
ID: "docker.prunenets",
|
||
Group: "docker",
|
||
Summary: "清理未使用的网络",
|
||
Action: "等价 docker network prune -f，删除未被容器使用的网络",
|
||
Variants: runtimeVariants("network", "prune", "-f"),
|
||
},
|
||
{
|
||
ID: "docker.prunebuilder",
|
||
Group: "docker",
|
||
Summary: "清理构建缓存",
|
||
Action: "等价 docker builder prune -f，删除未被使用的构建缓存",
|
||
Variants: runtimeVariants("builder", "prune", "-f"),
|
||
},
|
||
{
|
||
ID: "docker.prunevolumes",
|
||
Group: "docker",
|
||
Summary: "清理未使用的数据卷（破坏性）",
|
||
Action: "等价 docker volume prune -f：删除所有未被容器使用的卷，卷内数据不可恢复；必须显式加 --yes 才会执行",
|
||
RequiresYes: true,
|
||
Variants: runtimeVariants("volume", "prune", "-f"),
|
||
},
|
||
{
|
||
ID: "docker.clearall",
|
||
Group: "docker",
|
||
Summary: "深度清理全部未使用镜像与资源（破坏性）",
|
||
Action: "等价 docker system prune -a -f：删除所有未使用镜像（含已打标签但未被容器引用的镜像）、停止的容器、未使用网络与构建缓存，但不删除卷；必须显式加 --yes 才会执行",
|
||
RequiresYes: true,
|
||
Variants: runtimeVariants("system", "prune", "-a", "-f"),
|
||
},
|
||
|
||
// ----- compose -----
|
||
{
|
||
ID: "docker.compose.up",
|
||
Group: "docker",
|
||
Summary: "以守护方式启动 Compose 服务",
|
||
Action: "等价 docker compose up -d；服务名可透传指定",
|
||
Variants: runtimeVariants("compose", "up", "-d"),
|
||
},
|
||
{
|
||
ID: "docker.compose.down",
|
||
Group: "docker",
|
||
Summary: "停止并移除 Compose 服务与网络",
|
||
Action: "等价 docker compose down；默认保留卷，删除卷需自行透传 -v",
|
||
Variants: runtimeVariants("compose", "down"),
|
||
},
|
||
{
|
||
ID: "docker.compose.ps",
|
||
Group: "docker",
|
||
Summary: "列出 Compose 服务状态",
|
||
Action: "只读：等价 docker compose ps",
|
||
Variants: runtimeVariants("compose", "ps"),
|
||
},
|
||
{
|
||
ID: "docker.compose.logs",
|
||
Group: "docker",
|
||
Summary: "查看 Compose 服务日志",
|
||
Action: "只读：等价 docker compose logs；-f、服务名可透传",
|
||
Variants: runtimeVariants("compose", "logs"),
|
||
},
|
||
|
||
// ----- cross-runtime diagnosis -----
|
||
{
|
||
ID: "diagnose",
|
||
Group: "diagnose",
|
||
Summary: "诊断容器或 Pod 当前状态的根因",
|
||
Action: "自动识别 Docker 容器或 Kubernetes Pod，采集状态、最近日志与事件，给出原因、依据与建议；只读，不修改任何对象。--kind 可强制来源，K8s 下 -n/--namespace 指定命名空间",
|
||
Usage: "<容器名或 Pod 名>",
|
||
MinArgs: 1,
|
||
Namespaced: true,
|
||
Variants: []Variant{
|
||
{
|
||
Match: Match{OS: "linux"},
|
||
Builtin: "diagnose",
|
||
Note: "Linux 内置诊断（docker 与 kubectl 自动识别）",
|
||
},
|
||
{
|
||
Match: Match{OS: "darwin"},
|
||
Builtin: "diagnose",
|
||
Note: "macOS 内置诊断（Docker Desktop 与 kubectl）",
|
||
},
|
||
{
|
||
Match: Match{OS: "windows"},
|
||
Builtin: "diagnose",
|
||
Note: "Windows 内置诊断（Docker Desktop 与 kubectl）",
|
||
},
|
||
},
|
||
},
|
||
|
||
// ----- non-container examples -----
|
||
{
|
||
ID: "disk.usage",
|
||
Aliases: []string{"disk.du"},
|
||
Group: "disk",
|
||
Summary: "列出目录下各直接子项的占用空间，按大小降序",
|
||
Action: "等价于 du -x --max-depth=1 -h <路径> | sort -hr：统计每个直接子项（文件或目录递归）的占用，" +
|
||
"不跨越文件系统边界，末尾输出该路径的合计。路径必填，可作位置参数或用 --path 指定；" +
|
||
"由于 Windows 没有等价的 du/sort，这里使用 kopsc 内置实现以保证三平台输出一致",
|
||
Variants: []Variant{
|
||
{
|
||
Match: Match{OS: "linux"},
|
||
Builtin: "disk.usage",
|
||
Note: "Linux 内置实现（等价 du -x -d 1 -h | sort -hr）",
|
||
},
|
||
{
|
||
Match: Match{OS: "darwin"},
|
||
Builtin: "disk.usage",
|
||
Note: "macOS 内置实现（BSD du 不支持 --max-depth）",
|
||
},
|
||
{
|
||
Match: Match{OS: "windows"},
|
||
Builtin: "disk.usage",
|
||
Note: "Windows 内置实现（系统没有 du/sort）",
|
||
},
|
||
},
|
||
},
|
||
{
|
||
ID: "net.pids",
|
||
Group: "net",
|
||
Summary: "查找占用指定端口的进程 PID",
|
||
Action: "等价 lsof -ti:<端口>：每行输出一个占用该端口的进程 PID。Linux/macOS 调用 lsof，Windows 解析 netstat -ano；无进程占用时无输出",
|
||
Usage: "<端口>",
|
||
MinArgs: 1,
|
||
Variants: []Variant{
|
||
{
|
||
Match: Match{OS: "linux"},
|
||
Builtin: "net.pids",
|
||
Note: "Linux 使用 lsof -ti",
|
||
},
|
||
{
|
||
Match: Match{OS: "darwin"},
|
||
Builtin: "net.pids",
|
||
Note: "macOS 使用 lsof -ti",
|
||
},
|
||
{
|
||
Match: Match{OS: "windows"},
|
||
Builtin: "net.pids",
|
||
Note: "Windows 解析 netstat -ano",
|
||
},
|
||
},
|
||
},
|
||
{
|
||
ID: "net.ports",
|
||
Group: "net",
|
||
Summary: "列出本机正在监听的 TCP/UDP 端口",
|
||
Action: "以只读方式列出监听中的套接字及持有进程",
|
||
Variants: []Variant{{
|
||
Match: Match{OS: "linux"},
|
||
Argv: []string{"ss", "-tulnp"},
|
||
Note: "Linux 使用 iproute2 的 ss",
|
||
},
|
||
{
|
||
Match: Match{OS: "darwin"},
|
||
Argv: []string{"lsof", "-iTCP", "-sTCP:LISTEN", "-nP"},
|
||
Note: "macOS 使用 lsof",
|
||
},
|
||
{
|
||
Match: Match{OS: "windows"},
|
||
Argv: []string{"netstat", "-ano"},
|
||
Note: "Windows 使用 netstat",
|
||
},
|
||
},
|
||
},
|
||
{
|
||
ID: "proc.nohup",
|
||
Group: "proc",
|
||
Summary: "在后台运行命令，输出写入日志（等价 nohup <命令> > output.log 2>&1 &）",
|
||
Action: "启动一个与当前终端脱离的命令并立即返回：标准输入接到空设备，" +
|
||
"标准输出与标准错误都追加写入日志文件（默认 <程序名>.out，可用 -o 指定），" +
|
||
"Unix 下进入新会话、无控制终端，Windows 下以 DETACHED_PROCESS 启动，关闭终端不会终止它。" +
|
||
"选项在命令之前解析，命令之后的参数（含 -i 之类）原样透传，不加 shell；" +
|
||
"命令自身的 -n/--dry-run 不会被 kopsc 截获；kopsc 自身的预览等选项写在命令之前或用 -- 分隔",
|
||
Usage: "<命令> [参数...]",
|
||
MinArgs: 1,
|
||
Variants: []Variant{
|
||
{
|
||
Match: Match{OS: "linux"},
|
||
Builtin: "proc.nohup",
|
||
Note: "Linux 内置实现（setsid 新会话 + 日志追加）",
|
||
},
|
||
{
|
||
Match: Match{OS: "darwin"},
|
||
Builtin: "proc.nohup",
|
||
Note: "macOS 内置实现（setsid 新会话 + 日志追加）",
|
||
},
|
||
{
|
||
Match: Match{OS: "windows"},
|
||
Builtin: "proc.nohup",
|
||
Note: "Windows 内置实现（DETACHED_PROCESS + 日志追加）",
|
||
},
|
||
},
|
||
},
|
||
{
|
||
ID: "pkg.refreshindex",
|
||
Group: "pkg",
|
||
Summary: "刷新系统包管理器的软件源索引",
|
||
Action: "只更新元数据索引，不升级或安装任何软件包",
|
||
Variants: []Variant{
|
||
{
|
||
Match: Match{OS: "linux", Distro: "centos"},
|
||
Argv: []string{"dnf", "makecache"},
|
||
Note: "CentOS 使用 dnf",
|
||
},
|
||
{
|
||
Match: Match{OS: "linux", DistroLike: []string{"rhel", "fedora"}},
|
||
Argv: []string{"dnf", "makecache"},
|
||
Note: "RHEL/Fedora 系发行版使用 dnf",
|
||
},
|
||
{
|
||
Match: Match{OS: "linux", DistroLike: []string{"debian", "ubuntu"}},
|
||
Argv: []string{"apt-get", "update"},
|
||
Note: "Debian/Ubuntu 系发行版使用 apt-get",
|
||
},
|
||
{
|
||
Match: Match{OS: "linux", Distro: "alpine"},
|
||
Argv: []string{"apk", "update"},
|
||
Note: "Alpine 使用 apk",
|
||
},
|
||
{
|
||
Match: Match{OS: "darwin"},
|
||
Argv: []string{"brew", "update"},
|
||
Note: "macOS 使用 Homebrew",
|
||
},
|
||
{
|
||
Match: Match{OS: "windows"},
|
||
Argv: []string{"winget", "source", "update"},
|
||
Note: "Windows 使用 winget",
|
||
},
|
||
},
|
||
},
|
||
}}
|
||
}
|
||
|
||
// runtimeBuiltinVariants builds the platform matrix for a container command
|
||
// that kopsc implements itself. Builtin variants carry no argv; the builtin
|
||
// learns the runtime's program name from Variant.Runtime instead.
|
||
func runtimeBuiltinVariants(name string) []Variant {
|
||
makeVariant := func(osName, note string) Variant {
|
||
return Variant{
|
||
Match: Match{OS: osName, Runtime: "docker"},
|
||
Builtin: "docker." + name,
|
||
Runtime: "docker",
|
||
Note: note,
|
||
}
|
||
}
|
||
return []Variant{
|
||
makeVariant("linux", "Linux 上的 Docker 运行时，由 kopsc 内置实现"),
|
||
makeVariant("darwin", "macOS 上的 Docker Desktop 运行时，由 kopsc 内置实现"),
|
||
makeVariant("windows", "Windows 上的 Docker Desktop 运行时，由 kopsc 内置实现"),
|
||
}
|
||
}
|
||
|
||
// runtimeVariants builds the platform matrix for a container command: docker
|
||
// on every platform (Docker Desktop on macOS and Windows).
|
||
func runtimeVariants(args ...string) []Variant {
|
||
makeVariant := func(osName, note string) Variant {
|
||
argv := make([]string, 0, 1+len(args))
|
||
argv = append(argv, "docker")
|
||
argv = append(argv, args...)
|
||
return Variant{
|
||
Match: Match{OS: osName, Runtime: "docker"},
|
||
Argv: argv,
|
||
Note: note,
|
||
}
|
||
}
|
||
|
||
return []Variant{
|
||
makeVariant("linux", "Linux 上的 Docker 运行时"),
|
||
makeVariant("darwin", "macOS 上的 Docker Desktop 运行时"),
|
||
makeVariant("windows", "Windows 上的 Docker Desktop 运行时"),
|
||
}
|
||
}
|