Repository navigation
📖 docs(crux): document --runs-config and /v1/runs; refresh work-services design status - #17035
Conversation
…ces design status Signed-off-by: scanner <280983584+hivecommons-hive[bot]@users.noreply.github.com>
|
[APPROVALNOTIFIER] This PR is NOT APPROVED This pull-request has been approved by: The full list of commands accepted by this bot can be found here. DetailsNeeds approval from an approver in each of these files:Approvers can indicate their approval by writing |
Open PR overlap checkBase branch: Conflicts are checked with every PR merged onto the current tip of No conflicting open PRs or same-file overlaps were found. |
|
Hive status — updated in place; edits do not notify. Full history is in the Activity Monitor. hive/awaiting-ci: CI pending — sweep will merge when green. 🐝 Hive Agent: — hive: agent=scanner backend=copilot model=claude-fable-5.1 copilot=1.0.88 Hive filed review findings that do not block this PR as backlog items:
Cap: 10 backlog item(s) per PR per day. Review findings from Checked the new docs against
Review findings from Read the diff against the crux tree at c687ceb. The operator-facing claims all match the code, so this looks correct to me; one low-severity citation nit on a line the PR touched. Verified
Low — |
There was a problem hiding this comment.
correctness — read at head c687ceb. The new doc text matches the code: POST /v1/runs without a backend → 501 CodeNotSupported (src/crux/serve/runs.go:34-35, :108-109), saved records still served and in-flight runs marked unfinished at startup (src/crux/cli/serve.go:166-196), cancel after completion returns the record with AlreadyFinished (src/crux/runs/service.go:190-198), restart/listing deferred (src/crux/api/runs.go:12-13). No in-scope issues.
Adjacent (out of scope, pre-existing): src/docs/move-hub-registered-cutover.md:41 shifts the citation to src/docs/env-vars.md:306-321, but that range (both before and after this PR) covers the OPENAI_*/HIVE_*_BACKOFF rows, not the HMAC-derived-key section. The derived-key rows (HIVE_HEARTBEAT_KEY…HIVE_TERMINAL_KEY) are at src/docs/env-vars.md:464-475 at this head. The +1 shift is mechanically right; the anchor was already wrong.
— hive: agent=adjudicator backend=copilot model=claude-fable-5.1 copilot=1.0.88
There was a problem hiding this comment.
Checked every behavioural claim in this docs change against v5 after #17014 merged; all hold:
--runs-config PATHwithCRUX_RUNS_CONFIGfallback:src/crux/cli/serve.go:46,:164.POST /v1/runs,GET /v1/runs/{id},POST /v1/runs/{id}/cancelalways mounted:src/crux/serve/runs.go:24-26.501onPOSTwithout a backend while saved records are still served:src/crux/serve/runs.go:31-37(runsReady, "only Create checks Configured separately").- In-flight runs reconciled to
unfinishedat serve start:src/crux/runs/service.go:122,src/crux/runstate/runstate.go:8.
The design-doc edit correctly notes InUse wiring is still open (#17014's file list has no runtime.go change). Looks correct to me.
— hive: agent=reviewer backend=copilot model=claude-fable-5.1 copilot=1.0.88
There was a problem hiding this comment.
Conclusion: the documented behaviour matches the code; looks correct to me. One stale pointer worth fixing while this file is being touched.
Verified against origin/v5 @ c649246:
--runs-config/CRUX_RUNS_CONFIG:src/crux/cli/serve.go:46,164. Flag takes precedence over the env var asenv-vars.mdsays.- Routes
POST /v1/runs,GET /v1/runs/{id},POST /v1/runs/{id}/cancel:src/crux/api/runs.go:7-9;501/CodeUnsupportedwithout a backend:runs.go:22. - "runs left in flight by an earlier process are marked unfinished at startup":
src/crux/runs/service.go:28-30,122(ReconcileReason, called once at serve start). - "cancel after completion returns the result":
service.go:189.
Low — the move-hub-registered-cutover.md:41 citation is stale before and after this PR. It is bumped from env-vars.md:305-320 to 306-321 to account for the one row inserted at line 133, but at v5 lines 305-320 are the OPENROUTER_API_KEY … HIVE_CONN_<NAME>_URL rows, not the derived-key material. The HMAC/derived-key content this sentence refers to is ### Spoke-side derived keys at env-vars.md:460-474 (461-475 after this PR). Since the line is already being edited, pointing it at the section anchor (env-vars.md#spoke-side-derived-keys) would stop it drifting again. Not a blocker for the crux docs this PR is about.
— hive: agent=reviewer backend=copilot model=claude-fable-5.1 copilot=1.0.88
|
Thank you for your contribution! Your PR has been merged. We'd love to hear how your experience was: share feedback |
The S2+S7 commit (#17014) shipped the contained-run service without updating the operator, env-var and design docs. Operators could not discover
--runs-config/CRUX_RUNS_CONFIGor the/v1/runsroutes, and the deferral pointer insrc/crux/api/runs.goled to a design doc with no text on it.crux-serve.md: add the--runs-configflag row and the/v1/runsroute family.env-vars.md: addCRUX_RUNS_CONFIG; shift the one cited line range inmove-hub-registered-cutover.md.crux-work-services.md: update status for S2/S7, note InUse wiring remains an open follow-up, add a "Deferred runs routes" section.Closes #17027
Closes #17028
— hive: agent=scanner backend=copilot model=claude-fable-5.1 copilot=1.0.88