Skip to content

ctl.md

Latest commit

 

History

History
140 lines (94 loc) · 3.29 KB

ctl.md

File metadata and controls

140 lines (94 loc) · 3.29 KB
Raw

revm ctl

English

revm ctl 控制已有 session 的控制面。它不会启动新 VM，也不会执行 guest 命令。

当前支持的控制操作：

  • --list-port: 展示当前 gvproxy 端口映射。
  • --port-export: 暴露 guest TCP 端口到 host。
  • --port-unexport: 取消 host 端口暴露。
  • --export-rootfs: 将 session 目录中的 rootfs 导出为 host 上的 tar.zst 文件。
  • --import-rootfs: 将 host 上的 tar.zst 文件导入为 --id 对应 session 的 rootfs。

连接 guest 或执行命令请使用 revm attach。

基本用法

revm ctl --id <session-id> --list-port
revm ctl --id <session-id> --port-export <spec>
revm ctl --id <session-id> --port-unexport <spec>
revm ctl --id <session-id> --export-rootfs <path.tar.zst>
revm ctl --id <session-id> --import-rootfs <path.tar.zst>

端口操作要求 --id 指向一个正在运行的 session。rootfs 导入和导出直接操作 session 目录，--id 就是目标 rootfs 的 session ID。

导出 rootfs

将 session 目录中的 rootfs 导出为 tar.zst：

revm ctl --id web --export-rootfs ./rootfs.tar.zst

tar 内容以 rootfs 内容为根，不会额外包含一层 rootfs/ 目录。导出目标不能放在该 session 的 rootfs 目录内。

导入 rootfs

将 tar.zst 导入为 --id 对应 session 的 rootfs：

revm ctl --id web --import-rootfs ./rootfs.tar.zst

导入会先解包到 session 目录下的临时目录，解包成功后替换：

~/.cache/revm/<session-id>/rootfs

因此 --id 是导入后的 rootfs ID。导入会替换已有 rootfs；不要在对应 VM 正在使用该 rootfs 时导入。

展示端口

展示当前所有端口映射：

revm ctl --id web --list-port

输出包括 revm 内部 SSH forward、容器端口发布和手动暴露的端口：

PROTOCOL  HOST            GUEST
tcp       127.0.0.1:6123  192.168.127.2:22
tcp       127.0.0.1:8080  192.168.127.2:8000

暴露端口

暴露 guest 端口：

revm ctl --id web --port-export 127.0.0.1:8080:8000
curl http://127.0.0.1:8080

取消暴露：

revm ctl --id web --port-unexport 127.0.0.1:8080

可以一次更新多个端口：

revm ctl --id web \
  --port-export 127.0.0.1:8080:8000 \
  --port-export 127.0.0.1:8443:8443

端口格式：

--port-export [tcp:]<host-port>:<guest-port>
--port-export [tcp:]<host-ip>:<host-port>:<guest-port>
--port-unexport [tcp:]<host-port>
--port-unexport [tcp:]<host-ip>:<host-port>

未指定 host IP 时默认使用 127.0.0.1。当前只支持 TCP 和 IPv4。

工作方式

revm ctl 先通过 session 的管理 API 读取 VM 信息：

~/.cache/revm/<session-id>/socks/vmctl.sock

端口更新会从管理 API 获取 gvproxy control endpoint，然后调用 gvproxy forwarder API：

/services/forwarder/expose
/services/forwarder/unexpose

因此端口更新要求 VM 使用 gvisor 网络。tsi 网络不支持 --port-export 或 --port-unexport。

错误用法

下面的命令会失败，因为没有选择控制操作：

revm ctl --id dev

下面的命令会失败，因为 ctl 不执行 guest 命令：

revm ctl --id dev -- sh

应该改用：

revm attach --id dev -- sh