Repository navigation
docs(architecture): Router Backends & Embedded Services ADR (#5603) - #5891
Merged
Merged
Conversation
Document the two orthogonal axes that #5603 asked to clarify: an engine's lifecycle (in-process / supervised / external / disabled) vs the relay routing backend selection (ts / bifrost / auto). Anchors the ADR on the typed `src/domain/routing/routerBackends.ts` registry as the single source of truth, and captures the /api/services/* status-code contract (409/200/404/403/500 + the LOCAL_ONLY loopback guard) so dashboard errors are interpretable. Stacked on the router-backend-registry work so it documents a real contract.
Contributor
|
Warning You have reached your daily quota limit. Please wait up to 24 hours and I will start processing your requests again! |
|
You have reached your Codex usage limits for code reviews. You can see your limits in the Codex usage dashboard. |
…5868; describe adoption as tracked, not current
Contributor
CI Coverage Report
Coverage artifact was not available for this run. |
Merged
tkgo11
pushed a commit
to tkgo11/OmniRoute
that referenced
this pull request
Sep 23, 2026
…inference#5603) (cheaper-inference#5891) * routing: add router backend registry * docs(architecture): add Router Backends & Embedded Services ADR (cheaper-inference#5603) Document the two orthogonal axes that cheaper-inference#5603 asked to clarify: an engine's lifecycle (in-process / supervised / external / disabled) vs the relay routing backend selection (ts / bifrost / auto). Anchors the ADR on the typed `src/domain/routing/routerBackends.ts` registry as the single source of truth, and captures the /api/services/* status-code contract (409/200/404/403/500 + the LOCAL_ONLY loopback guard) so dashboard errors are interpretable. Stacked on the router-backend-registry work so it documents a real contract. * docs(architecture): reduce ADR PR to docs-only — registry lands via cheaper-inference#5868; describe adoption as tracked, not current * docs(changelog): add 3.8.43 bullet for the Router Backends ADR (cheaper-inference#5891) --------- Co-authored-by: KooshaPari <kooshapari@gmail.com>
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
What
Adds
docs/architecture/ROUTER_BACKENDS.md— an ADR answering @KooshaPari's architecture question in #5603: howts/bifrost/cliproxy/9router/vibeproxyrelate as embedded services vs routing backends, and what the/api/services/*route contract is.Why
#5603 asked for "a concrete ADR/implementation note on service-model separation + a stable route contract". The recurring confusion is that embedded service (a supervised local process) and routing backend (a relay dispatch engine) are treated as one list when they are two orthogonal axes. This ADR pins that down and anchors it on the typed registry proposed in #5868.
Contents
RouterBackendDefinition:in-process/supervised/external/disabled(how it runs).ts/bifrost/auto(whether the relay dispatches to it).src/domain/routing/routerBackends.tsregistry as the intended single source of truth (per-backend lifecycle/capabilities/service identity/port/health table) — the registry itself lands separately via [codex] Add router backend registry #5868, and the ADR now states explicitly thatbootstrap.ts/routingBackend.tsstill branch per engine id until the adoption work that follows it.ServiceSupervisorlifecycle + the/api/services/*status-code contract (409 start-not-installed / 200 idempotent stop / 404 unknown tool / 403 loopback guard / 500·503 errors) and why the codes differ.resolveRelayRoutingBackendenv selection,auto/bifrost/tsbehavior, per-baseUrl cooldown, and that only the relay path (not/api/v1/chat/completions) consults it.HTTP <status>).Stacking / dependency
Originally stacked on #5868 (
Add router backend registry) and carried its commits. To avoid the two PRs colliding, this PR was reduced to genuinely docs-only: therouterBackends.tsregistry + its test were dropped from this branch so #5868 remains the sole owner of that code, and the ADR wording was softened to describe the registry as proposed/landing via #5868 rather than as current behavior. Retargeted torelease/v3.8.43and updated to its tip.Docs-only change (plus the 3.8.43 CHANGELOG bullet) —
check:docs-syncPASS, markdownlint clean.Addresses #5603. Related: #5670, #5817, #5868, #5869, #5870.