3.6 KiB
id, name, status, depends_on, scope, risk, impact, level
| id | name | status | depends_on | scope | risk | impact | level | ||||
|---|---|---|---|---|---|---|---|---|---|---|---|
| architecture/spec-update-overview | Update overview.md — add crate structure, Layer 3, services, identity | completed |
|
moderate | low | project | implementation |
Description
Update docs/architecture/overview.md to reflect the expanded scope from the integration plan. The current overview documents the alpha scope (SSH tunneling). It needs additions for:
- Crate structure — alknet-core, alknet-secret, alknet-storage, alknet-flowgraph, alknet-napi, alknet (CLI). Per ADR-027. Note which crates exist now (core, napi) vs which are contracted for later phases (secret, storage, flowgraph).
- Three-layer model — Transport (Layer 1), Interface (Layer 2), Protocol (Layer 3). SSH is an interface, not a transport. Per ADR-026.
- Service layer concept — irpc services for in-cluster communication, OperationEnv for composition. Per ADR-033. Note this is Phase 2+ for the service implementations; Phase 1 uses ConfigIdentityProvider and ConfigServiceImpl directly.
- Identity as core type — Identity struct and IdentityProvider trait in alknet-core. Per ADR-029. Phase 1 ships ConfigIdentityProvider only; StorageIdentityProvider is contracted for when alknet-storage is built.
- Updated dependency table — new dependencies (irpc feature-gated, bip39, rusqlite, honker, petgraph, jsonschema)
- Updated ADR table — add ADRs 026-034
- Updated architecture constraints — add: Interface as Layer 2, OperationEnv as universal composition, event boundary discipline, static/dynamic config split
The existing content (purpose, SSH tunneling, transport pluggability, etc.) stays. We're adding, not replacing.
Acceptance Criteria
- Crate structure section added with phase notes: core and napi exist now; secret, storage, flowgraph are Phase 2+ contracts
- Phase boundary noted: service implementations (irpc) are Phase 2+; Phase 1 uses ConfigIdentityProvider and ArcSwap directly
- Three-layer model mentioned in architecture constraints per ADR-026
- Service layer concept mentioned: irpc + OperationEnv per ADR-033
- Identity and IdentityProvider mentioned as core types per ADR-029
- Updated dependency table with new crate dependencies
- ADR table updated: ADRs 026-034 added with correct titles and status
- Architecture constraints updated: add Layer 2 interface concept, OperationEnv, event boundary, static/dynamic config
- All new references to architecture specs link correctly (identity.md, services.md, interface.md, configuration.md, etc. — even if those specs are still being written)
last_updatedin YAML frontmatter updated- No hub/spoke terminology remains
References
- docs/research/integration-plan.md — expanded scope, dependency graph
- docs/architecture/overview.md — current content to update
Notes
Added crate structure table (6 crates, phase notes), three-layer model section, service layer section with Phase boundary note, Identity section with struct definition, expanded exports list, rebuilt dependency table per-crate, added 8 new architecture constraints (three-layer model, event boundary, OperationEnv, forwarding policy, static/dynamic config, unified auth, config split), expanded ADR table from 19 to 31 entries, updated references to include all new specs + irpc.
Summary
Overview spec updated from alpha scope to full Phase 0 scope. All acceptance criteria met.