主题
中间件命令
middleware 命令组管理五个组件:docker、postgresql、mysql、redis、elasticsearch。组件的安装模式(docker 容器 / native 原生)与参数含义见 组件与模式。
中间件的安装与启停都是一次普通运行(Run),所以 deploy logs <runId> -f 能看实时日志,退出码沿用全局约定(见 输出约定与退出码)。
平台与模式边界
- 中间件操作只在 Linux 服务端可用;其他平台只能
--dry-run预演。服务端是唯一裁决者:非 Linux 上真安装会直接返回 400(退出码 2),而不是等日志。 elasticsearch只支持容器方式(docker),docker只支持原生方式(native);传错模式服务端会明确拒绝(退出码 2)。- 容器模式依赖服务端有可用的 docker;
middleware list会在 docker 不可用时给出警告。
list / get / fields / script
bash
deploy middleware list # 方式 / 已装 / 在跑 / 版本 / 位置
deploy middleware list --json
deploy middleware get redis # 状态 + 详情 + 可编辑参数表
deploy middleware fields redis # 只要参数表
deploy middleware fields # 不带 key 列出全部组件的参数
deploy middleware script > install.sh # 导出内嵌安装脚本,可拿去手动跑get / fields 的参数表里,密码类字段只显示「已设置 / 未设置」,绝不回显明文;普通字段为空时显示「使用默认值」。script 在 --json 下输出 { "script": "..." }。
install / start / stop / restart
四个动作流程一致:触发一次运行,可选跟随日志。
bash
# 先预演(只打印计划,不做任何修改;任何平台都可用)
deploy middleware install redis --dry-run --no-follow
# 真装:--no-follow 立刻返回 runId;不加则默认跟随日志到结束
deploy middleware install redis --no-follow --json
deploy logs 88 -f
deploy middleware install docker redis postgresql --no-follow # 一次多个;docker 应在最前
deploy middleware install --missing --no-follow # 只装缺失的
deploy middleware install redis -m native --no-follow # 指定方式
deploy middleware install redis --force --no-follow # 已装的也重建(数据卷保留)
deploy middleware start redis --no-follow
deploy middleware stop redis --no-follow
deploy middleware restart redis --no-follow| flag | 说明 |
|---|---|
-m, --mode docker|native | 安装方式(缺省用组件默认值) |
--missing | 处理全部缺失组件(仅 install;--all 是同义写法) |
--dry-run | 只打印计划,不做任何修改(仅 install) |
-F, --force | 已装的也重建;容器模式保留数据卷 |
--follow | 跟随日志到结束(默认 true) |
--no-follow | 只触发不跟随(脚本/AI 用;与 --follow 同时给时以它为准) |
要点:
--no-follow与--follow(默认 true)成对:AI/脚本用前者拿到 runId 再自行跟日志,人用后者直接看到结束。- 组件按传入顺序安装,docker 必须排在依赖它的组件之前;重复与空项会被自动去掉。
- 全部已安装且未加
--force时返回「无事可做」,不触发运行。 - 安装往往要拉几分钟镜像,Ctrl+C 只断开跟随、不会取消安装。
- 安装/启停失败会让跟随的日志以退出码 1 收尾。
logs:组件自身日志
bash
deploy middleware logs redis --no-follow # 最近 100 行日志
deploy middleware logs redis # 默认跟随到这次日志运行结束docker 模式取容器日志,native 模式取 systemd 日志。这也是一次运行,--no-follow 时返回 runId,可用 deploy logs <runId> 回放。
remove:只删容器,不删数据
bash
deploy middleware remove redis --yes --no-follow- 非交互环境必须
--yes;交互环境下要求输入 yes 确认。 - 不删任何数据:容器模式只移除容器,命名数据卷
deploy-mw-<key>-data原样保留;native 模式不卸载系统包,只打印手动卸载命令。要彻底清数据需自行docker volume rm deploy-mw-<key>-data。 --force让「容器不存在」也算成功(幂等移除)。- 同样支持
--no-follow/ 默认跟随。
set:保存安装参数
参数就是安装脚本读的环境变量名,保存后在下次安装/重建时生效:
bash
deploy middleware set redis -p REDIS_PORT=16380 -p REDIS_PASSWORD=<密码>
deploy middleware set postgresql -p PG_VERSION=17 --mode native
deploy middleware set redis -p REDIS_PASSWORD= # 空串 = 清空(回到随机生成)| flag | 说明 |
|---|---|
-p KEY=VALUE | 参数键值对(可重复;KEY 不能为空,VALUE 允许空串) |
--mode docker|native | 同时切换该组件的安装方式 |
- 至少要传一个
-p或--mode,否则退出码 2。 - 密码类参数(PG_PASSWORD / MYSQL_ROOT_PASSWORD / REDIS_PASSWORD)在服务端加密存储:API 绝不回显明文,只报告「已设置」;CLI 输出里显示为「(stored encrypted)」。
- 空串表示清空该参数:密码清空后回到安装时随机生成。
- 可用
middleware fields <key>查看每个组件支持哪些参数及默认值。
脚本化示例
bash
deploy middleware install --missing --dry-run --no-follow --json # 先看计划
deploy middleware install docker redis --no-follow --json # 拿 runId
deploy logs 88 -f --json # JSONL 跟随到结束
deploy middleware set redis -p REDIS_PORT=16380
deploy middleware install redis --force --no-follow # 用新参数重建