Commit 8437031
committed
docs(workflow): document queue and database ownership by service
## Summary
### Why?
Issue #211 (follow-up from PR #205) asks for a single place that records
the submitqueue topology at a high level: which service owns each queue
topic and database table, for reading and writing. The workflow RFC
already covers the cross-queue flow, so ownership belongs alongside it.
### What?
Append an "Ownership by service" section to doc/rfc/submitqueue/workflow.md,
organized per service to match how the system is operated:
- Gateway — RPC entry point and owner of the request log. Publishes the
entry topics (start, cancel), consumes log, and is the sole reader and
writer of request_log.
- Orchestrator — the pipeline. Publishes and consumes the pipeline-internal
topics (validate, batch, score, speculate, build, buildsignal, merge,
conclude; speculate is the re-entrant hub), publishes log without
consuming it, and owns the pipeline state tables (request, batch,
batch_dependent, build; with request_batch, speculation_tree, and
change_provider defined but not yet wired).
- Shared queue — the messagequeue tables both services read and write,
backed by a database kept separate from application state.
A closing "Request-log ownership invariant" section captures the crux of
PR #205: the orchestrator only emits log events, the gateway is the sole
consumer and persister. Code is referenced with inline spans (matching the
rest of the doc) rather than links.
Documentation only; no code, schema, or proto changes.
## Test Plan
- ✅ `make lint` (clean tree)
- Cross-checked topics against submitqueue/core/consumer/registry.go,
database ownership against the compose DSNs (mysql-app vs mysql-queue)
and the gateway/orchestrator store usage.
## Issue
Closes #2111 parent 43670be commit 8437031
1 file changed
Lines changed: 28 additions & 0 deletions
| Original file line number | Diff line number | Diff line change | |
|---|---|---|---|
| |||
80 | 80 | | |
81 | 81 | | |
82 | 82 | | |
| 83 | + | |
| 84 | + | |
| 85 | + | |
| 86 | + | |
| 87 | + | |
| 88 | + | |
| 89 | + | |
| 90 | + | |
| 91 | + | |
| 92 | + | |
| 93 | + | |
| 94 | + | |
| 95 | + | |
| 96 | + | |
| 97 | + | |
| 98 | + | |
| 99 | + | |
| 100 | + | |
| 101 | + | |
| 102 | + | |
| 103 | + | |
| 104 | + | |
| 105 | + | |
| 106 | + | |
| 107 | + | |
| 108 | + | |
| 109 | + | |
| 110 | + | |
0 commit comments