- requirements.md (new): the three use cases pinned as REQ-1..4 with the node/pool/fleet/engine vocabulary defined once — ends per-session re-derivation of consumer facts. REQ-2 (replicator fleet over one shared pg pool, incl. large-blob serving) is recorded as a planning fact predating all POCs, on the operator's authority. - ADR-008: Backend trait gains size(key) length probe (before any backend ships data — ADR-002 one-way-door discipline); fleet GC mechanism (DB-backed pin rows committed atomically with entries, TTL+renewal semantics, liveness = embedder-owned table, protect callback is single-node-only, advisory-locked single sweeper, staged re-arbitrated delete window on both engines); fs tier becomes engine-selectable (local default; pg-lo named candidate) with the fleet locality contract (shared media or re-routing; mixed tiers are a documented deployment invariant, not a constructor-provable one). - poc-pglo-spec.md (new): POC #7 spec — pg Large Objects as the fs tier's pg-lo engine; instruments, decision gate, registered in phase-0.md OQ-BL-06. - ADR-003/005 status amendments point to ADR-008's extensions; specs ripple (backends/store-api/gc/ops/overview/README). - open-questions.md: deferral-policy header gains the decisions-vs- sequenced-work distinction; pg-lo's why-not-parked audit trail recorded. - research fixes: postgres POC renumbered #4->#5 to the canonical register (phase-0 OQ-BL-06), redb cross-refs fixed, thinking- artifact sentence in B1 replaced with the honest reading. Verification: docs-only change; reference-integrity sweep across the tree (ADR/REQ/POC refs resolve); architecture-reviewer pass on the delta — original 3 criticals addressed, its follow-up (fleet liveness form, pin TTL, staged-delete semantics, enforceability, shared-media caveats) fixed in this commit.
6.6 KiB
status, last_updated
| status | last_updated |
|---|---|
| draft | 2026-10-03 |
alkblobs — Architecture
Current State
Phase 1 (Architecture). Phase 0 (Exploration) converged — see
docs/research/phase-0.md for the vision, the evidence trail, and the
POC register (all POCs passed or were absorbed; POC code lives in
standalone crates (/workspace/alkblobs-trait-poc,
/workspace/alkblobs-largeblob-poc); findings live in
docs/research/). No implementation exists yet (src/lib.rs is a
placeholder).
The converged Phase 0 posture has been promoted into the specs and ADRs below. Two framing corrections from the convergence review are captured there — not inherited as hedges:
- ADR-001 makes the substrate posture explicit: the store layer carries no alkcall dependency by design — which is conformance to the family pattern, not deviation from it — and the ops surface rides alkcall, feature-gated.
- ADR-004 fixes the "two backends" framing: the crate ships exactly two backends (kv small / fs large — both required by measured scale economics); the path→hash mapping layer (the alkfs/alknet "vfs" shape) is a consumer-layer concern and must never become a third backend.
- ADR-007 widens the kv tier's engine set rather than hedging it: sqlite (default) + postgres (feature-gated) behind one trait. The deployment economics this records: a downstream node (git server, vfs) classically needed three storage systems — kv + fs + relational — and this design collapses them to one relational engine + fs, with the engine a per-node constructor choice. Resolved from evidence in hand (POCs #3/#5/#6); the would-be "deployment trigger" framing was caught at review as circular hedging (a deployment running alkblobs cannot pre-exist the engine) and closed on the OQ-09 precedent.
- ADR-008 (2026-10-03) repairs the seams ADR-007 stressed, against
the pinned consumer requirement REQ-2 (requirements.md — a replicator
node may run a fleet of store instances sharing one pg pool, a
planning fact predating all POCs): the
Backendtrait gains asizeprobe (before any backend ships data); fleet GC gets DB-backed pins, an advisory-locked single sweeper, and SQL-level delete arbitration (single-node postures unchanged); and the fs tier becomes engine-selectable (localdefault;pg-lonamed candidate, admission-gated on POC #7). It also adds requirements.md — the REQ anchor that ends per-session re-derivation of consumer facts.
Architecture Documents
| Document | Scope | Status |
|---|---|---|
| overview.md | Purpose, consumers, layer map, dependency posture | draft |
| requirements.md | Consumer requirements REQ-1..4, node/pool/fleet vocabulary | draft |
| hashing-and-keys.md | Canonical hash, key encoding (the one-way door) | draft |
| store-api.md | Store facade: put/get/stat/range/pin/batch/sweep surface, errors, invariants | draft |
| backends-and-dispatch.md | Backend trait contract, shipped backends, size-threshold dispatch | draft |
| gc-and-namespaces.md | Pooled CAS, liveness seams, mark-and-sweep, delete windows | draft |
| ops-surface.md | alkcall-backed have/need + fetch/put ops, ACL mapping | draft |
| open-questions.md | Centralized OQ tracker (incl. promoted Phase 0 register) | draft |
Decision Records
| ADR | Decision | Status |
|---|---|---|
| 001 | Substrate posture & ops-surface placement (conformance, not deviation) | Accepted |
| 002 | Canonical hash + key encoding (the wire-format ADR; precedes any consumer) | Accepted |
| 003 | Backend contract, shipped backends, dispatch policy | Accepted |
| 004 | Exactly two backends; manifest layers stay above | Accepted |
| 005 | Pooled CAS, liveness seams, mark-and-sweep, delete windows | Accepted |
| 006 | Whole-blob verification; transfer encoding excluded by scoping | Accepted |
| 007 | Two kv engines (sqlite + postgres) behind one trait; constructor-selected | Accepted |
| 008 | Trait size probe; fleet GC (DB-backed pins, advisory-locked sweeper); fs-tier engines |
Accepted |
Open Questions
Tracked in open-questions.md. The Phase 0 register
(OQ-BL-01..06) is promoted there with its resolutions; two questions
remain parked — OQ-07/OQ-08 externally-owned (alkgit seam mapping,
alkfs intake; carried for visibility, gating nothing here). OQ-09
(namespace-visibility default) resolved closed-by-default; OQ-10
(second kv engine) resolved by ADR-007. The pg-lo fs-engine question
resolved to sequenced work, not a parked question: REQ-2/ADR-008
named it the candidate fs-tier engine and POC #7
(docs/research/poc-pglo-spec.md) is its admission evidence — a task,
not a wait. Deferral
policy (the "Schrödinger's code" rule): a decision this crate needs
before shipping may not be deferred on a dependency that is itself
waiting for this crate to exist. Two parking kinds remain legitimate:
deferred(scope) on a deciding fact that exists independently of this
crate, and externally-owned questions (how a consumer maps onto this
crate) that gate no decision here — full definitions in the header of
open-questions.md. A corollary worth restating,
because it recurs: a fact this crate must create (its own first
deployment, its own first consumer) is never a deciding input —
decisions stand on evidence in hand, and future needs reopen via named
requirements, not via waiting. (Corollary applications so far: OQ-09
and OQ-10 both resolved on it.)
Lifecycle
Spec docs: draft → reviewed → stable → deprecated. A doc moves
reviewed when every crate-owned open question it references
resolves and an architecture review pass clears it — externally-owned
OQs (OQ-07/OQ-08) gate nothing here by definition and do not block the
lifecycle; their outcomes arrive through their owners' processes.
stable when implementation verifies against it; deprecated when
superseded (kept for reference). ADRs use a separate status set
(Accepted | Proposed | Deprecated | Superseded), defined per ADR file.
This tree is in draft pending the first architecture review cycle.