alkdev/alkssh

0 Fork 0

Files

T

glm-5.3-flash 644269b258 docs(architecture): scaffolding + ADR-001 (alk/ssh ALPN pin, Proposed)

- decisions/001: pins alk/ssh to one contract — raw vanilla-SSH byte
  stream, endpoint = SshAdapter::handle; payload-blind relay restated
  per alkcall ADR-042; phase 1 serves edge termination only; relay/
  browser legs stay compatible by construction (consumers deferred,
  OQ-01). Status Proposed — ledger-rule-1 acceptance pending review.
- open-questions.md: 13 OQs seeded from POC findings (3 resolved by
  evidence: username disposition, vault role split, reconnect policy;
  4 deferred with blockers: relay consumer, cert auth, env allowlist,
  sftp/alkfs); deferred/failed trackers filed under tasks/architecture/
  for each deferred(scope) OQ (taskgraph validate: 4/4 valid)
- README.md index: current state, doc table, planned docs, lifecycle

2026-10-26 06:11:42 +00:00

2.5 KiB

Raw Blame History

status, last_updated

status	last_updated
draft	2026-10-26

Architecture index

Current State

Phase 1 (architecture) — in progress. Phase 0 is closed: all three POCs passed (121 checks; docs/research/poc-{1,2,3}-*.md) and the research docs record their corrections. This directory is being populated: ADR-001 (the alk/ssh ALPN pin) is drafted for review, the OQ tracker is seeded from the POC findings, and the spec documents below are being written. No implementation until specs reach reviewed (per docs/sdd_process.md).

Architecture Documents

Document	Status	Scope
open-questions.md	draft	Centralized OQ tracker (seeded from phase 0 findings)
decisions/001	Proposed	The `alk/ssh` ALPN pin (ledger rule 1)

Planned documents (not yet written)

Planned doc	Scope
`overview.md`	Crate purpose, exports, dependency posture, bounded-resources policy
`mapping.md`	The spine — server-direction channel-type/request→family-seam rows (absorbs the validated `mapping-table.md`)
`client.md`	Client-direction surface: dial rows, the forwarded-channel acceptor, reverse-runner shape
`auth.md`	Server auth bridge + client-side vault key custody

ADR Table

ADR	Title	Status
ADR-001	The `alk/ssh` ALPN pin — edge-termination contract for `SshAdapter`	Proposed

Open Questions

Tracked in open-questions.md — OQ-01 … OQ-13, seeded from the phase 0 POC findings and research docs.

Document Lifecycle

Status	Meaning	Transitions
`draft`	Under active development; may change significantly	→ `reviewed` when its open questions are resolved
`reviewed`	Final; implementation may begin; changes require review	→ `stable` when implementation is complete and verified
`stable`	Locked; changes require review and may warrant an ADR	→ `deprecated` when superseded
`deprecated`	Superseded; kept for reference	Removed when unreferenced

References

docs/sdd_process.md — the SDD process
docs/research/ — phase 0 (vision, POC plans + findings, russh inventory, auth bridge, mapping table, reverse-runner extraction)
Family: /workspace/@alkdev/alkfamily/docs/architecture/decisions/001..003 (ADR-003 is the alkssh structural decision)
Sibling: alkcall ADRs 002/004/009/034/042/051, alkhttp ADR-014/016/073-analogs

2.5 KiB Raw Blame History