Skip to content

Fix #29: restart policies and memory limits for the main compose - #39

Open
xiaoyao-666-coder wants to merge 2 commits into
zhengdaodeguL:mainfrom
xiaoyao-666-coder:fix/issue-29-compose-restart-limits
Open

xiaoyao-666-coder wants to merge 2 commits into
zhengdaodeguL:mainfrom
xiaoyao-666-coder:fix/issue-29-compose-restart-limits

Conversation

@xiaoyao-666-coder

Copy link
Copy Markdown

问题

主 docker-compose.yml 三个服务都没有 restart,也没有 deploy.resources。API 是单容器部署,OOM/退出就直接 down;backend/Dockerfile 用 python:3.13-slim,镜像里没装 tini 之类,entrypoint 是 sh backend/docker-entrypoint.sh,set -eu + exec 链。

注:issue 描述有两处与 main 不符(以代码为准)——demo 用的不是 deploy.restart_policy:deploy/instabox/compose.demo.yml 的 API 实际写的是顶层 restart: unless-stopped + mem_limit: 1g,UI 是 restart: unless-stopped + mem_limit: 128m;local compose 也一样(另有 llm 服务 mem_limit: 4g/cpus: 3.0)。仓库自己的惯例就是顶层键。主 compose 确实三个服务都没有 restart 和资源限制,这部分属实。

修复

  • restart 选 unless-stopped,三个服务都有。理由:与 demo/local 的既有惯例一致;它在 OOM(exit 137)、进程异常退出、宿主机重启、daemon 重启后都会恢复服务,而 on-failure 在宿主机重启后默认不会拉起容器。entrypoint 以 exec "$@" 结尾,uvicorn 就是 PID 1,信号能正常传递,restart 语义成立,不需要 tini。
  • 没用 deploy.restart_policy / deploy.resources.limits(这是本次最关键的判断):这个栈是普通 docker compose up 部署,不是 swarm;deploy 块在非 swarm 下会被静默忽略,写上去等于没写。真正生效的是顶层 restart 和 mem_limit/cpus——demo/local 的写法已经证明了这一点。测试里也加了 assert "deploy:" not in compose 防止以后有人照抄 issue 的建议把死配置写回来。
  • 资源限制数值与依据(没拍脑袋,全抄仓库已有值):
    • API mem_limit: 1g——与 demo/local 里同一个镜像(同一个 backend/Dockerfile、同一个 app)的 1g 完全一致;
    • UI mem_limit: 128m——与 demo/local 里同一个 nginx 镜像的 128m 完全一致;
    • Gateway mem_limit: 128m——caddy:2.10-alpine,与 UI nginx 同属轻量反向代理,仓库里没有 gateway 的先例,取与 UI 相同的 128m。
    • 没加 cpus:demo/local 也没给 api/ui 设,保持最小改动;没加 reservations:那也是 swarm 调度用的。

验证

  • 后端:MEDGUIDE_MODE=test python -m pytest -q backend/tests 523 passed(基线 521 + 2 新)。新增 test_deployment_contracts.py 的 2 个测试(_compose_service_block helper + 主 compose 断言 + demo/local 一致性断言),沿用该文件已有的字符串断言风格,没用 pyyaml——它不在 backend/requirements.txt 里,测试里 import 会在 CI 全新环境炸掉。
  • pyyaml 解析:三个 compose 文件(主、demo、local)全部合法,restart/mem_limit 值与预期一致,主 compose 与 demo/local 的 api/ui 值完全对齐。
  • CI:.github/workflows/ci.yml 的 compose job 是 docker compose config --quiet(无环境变量);新增的键都是纯量值、无插值,不会破坏该校验。
  • 没动 demo/local、没动应用代码、没动 [高] 主 compose 不自带 Redis/Milvus/MySQL,必填外部依赖缺配时整站永久不 healthy(待实机验证) #20 的入口逻辑。

已知遗留

  • 无 Docker,没法真实验证:本机没有 docker CLI,docker compose config / docker compose up 的真实行为(包括 OOM 后是否自动拉起、mem_limit 是否生效)未跑过,需在有 Docker 的环境按 issue 复现步骤确认。
  • Gateway 的 128m 是类比值(仓库无先例),如上游认为 Caddy 自动 TLS/缓存需要更大,可再调。

Closes #29

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

None yet

Projects

None yet

Development

Successfully merging this pull request may close these issues.

[中] 主 compose 三个服务均无 restart 策略,也无资源限制(静态检查)

1 participant