21 lines
2.0 KiB
Markdown
21 lines
2.0 KiB
Markdown
# Eddy 维护任务的全局租约(locks)
|
||
|
||
有些维护任务全世界只能同时跑一个,比如 Eddy 的定时自动发布(Eddy 仓 `maintainer/autorelease`,每天两次检查 DeviceSim main、TikTok M / Notes / Whee 的 alpha 版本,比线上新就打包发布)。它们在开始前向控制面登记一个具名租约,运行中心跳,结束时注销。代码 `control-server/src/eddy_locks.ts`,表 `eddy_locks`(迁移 `drizzle/0074_eddy_locks.sql`)。
|
||
|
||
## 接口
|
||
|
||
都在 `/api/eddy/admin/locks`,权限和 `/admin/releases/*` 相同:SSO 管理员,或 `Authorization: Bearer $EDDY_RELEASE_TOKEN`(`X-Eddy-User` 只做归因,记为 `actor`)。名字是 1–64 位小写字母、数字、`.`、`_`、`-`。
|
||
|
||
| 请求 | 体 | 成功 | 失败 |
|
||
|---|---|---|---|
|
||
| `POST /:name/register` | `{holder, ttlSeconds?, info?}` | `{token, lock}` | 409 `eddy_lock_held`,`lock` 里是当前持有者 |
|
||
| `POST /:name/heartbeat` | `{token, ttlSeconds?, status?}` | `{lock}`,过期时间顺延 | 409 `eddy_lock_lost`:已被别人接管或已注销 |
|
||
| `POST /:name/unregister` | `{token, result?}` | `{lock}`,`lock.last` 记下这次运行 | 409 `eddy_lock_lost` |
|
||
| `GET /:name`、`GET /` | — | 当前状态(不含 token) | — |
|
||
|
||
- `holder` 1–128 个可打印 ASCII 字符(如 `mac-a pid 123`);`ttlSeconds` 30–3600,默认 600;`info` / `status` 不超过 4 KB,`result` 不超过 8 KB,都必须是 JSON 对象。
|
||
- token 只在 register 的响应里出现一次,表里只存它的 SHA-256。
|
||
- 空闲或已过期的租约才能 register,同一条 SQL 完成判断和写入,并发登记只有一个成功。
|
||
- 过期但还没人接管时,原持有者的心跳仍然有效(token 没变)。被接管后原 token 失效,`last` 记录被接管的那次运行(`end: expired`、它最后的 `status`)。持有者应在每个不可逆步骤前确认自己还持有租约。
|
||
- 正常注销后 `last` 是 `{holder, info, actor, acquiredAt, endedAt, end: "released", status, result}`。
|