alknet/tasks/architecture/spec-configuration.md at 84f16d66e79e19dbdbddb9e25bbb3254ef0be760 - alknet - Gitea: Git with a cup of tea

alkdev/alknet

Files

glm-5.1 84f16d66e7 tasks: decompose Phase 0b spec documents and Phase 0c review

Add 15 new tasks under tasks/architecture/ for Phase 0b (spec writing)
and Phase 0c (review):

Phase 0b — New specs (6):
  - spec-configuration: promote from research, cleanup, align with ADRs
  - spec-identity: carry from auth.md + services.md, canonical Identity
  - spec-secret-service: from research/services.md SecretProtocol
  - spec-storage: from research/storage.md, contract-level
  - spec-flowgraph: from research/flow.md, pure computation crate
  - spec-interface: new Layer 2 spec (highest risk new spec)
  - spec-services: irpc service layer + OperationEnv (broadest scope)

Phase 0b — Spec updates (6):
  - spec-update-overview: add crate structure, Layer 3, services
  - spec-update-auth: IdentityProvider vs AuthService relationship
  - spec-update-call-protocol: OperationEnv dispatch paths
  - spec-update-server: DynamicConfig, ForwardingPolicy, IdentityProvider
  - spec-update-napi: reload API, call protocol references
  - spec-update-open-questions: resolve OQs per ADR decisions

Phase 0b — Assembly (1):
  - spec-update-readme: add new docs and ADRs to tables

Phase 0c — Review (1):
  - review-spec-foundation: validate consistency checklist

Generation structure (6 total):
  Gen 1: 6 independent ADRs (parallel)
  Gen 2: adr-027, adr-028 (depend on adr-029)
  Gen 3: adr-033 + 6 spec docs + open-questions update (parallel)
  Gen 4: adr review + interface/services specs + 4 spec updates
  Gen 5: call-protocol update + readme update
  Gen 6: spec review

2026-06-07 09:01:01 +00:00

3.2 KiB

Raw Blame History

id, name, status, depends_on, scope, risk, impact, level

id

name

status

depends_on

scope

risk

impact

level

architecture/spec-configuration

Promote configuration.md from research to architecture spec

pending

architecture/adr-030-static-dynamic-config-split

architecture/adr-031-forwarding-policy

architecture/adr-028-auth-irpc-service

moderate

medium

phase

implementation

Description

Promote docs/research/configuration.md to docs/architecture/configuration.md as a proper architecture spec document. The research doc is nearly spec-ready — this task is primarily cleanup, restructuring, and aligning with ADR decisions.

Source: docs/research/configuration.md (651 lines, well-analyzed)

Key cleanup items:

Remove duplicate "## Problem" heading (lines 20-21 both say ## Problem)
Resolve open questions per ADRs: OQ-12 (global rules + principal matching via IdentityProvider), OQ-13 (no file watching, confirmed), OQ-14 (ArcSwap, confirmed), OQ-16 (TransportKind match in ForwardingRule), OQ-18 (IdentityProvider owns scopes)
Remove inline decision rationale — reference ADR-030, ADR-031, ADR-028
Remove inline open questions — reference open-questions.md OQ numbers
Add YAML frontmatter: status: draft, last_updated: <date>
Restructure to follow established spec format (What, Why, Architecture, Constraints, Open Questions, Design Decisions)
Update terminology: head/worker (already done in research doc)
Reconcile ADR-011: TOML config file amends ADR-011 (convenience layer), doesn't supersede it
Remove research-only sections that are exploration/analysis — keep only the decisions and their architecture

What stays: StaticConfig/DynamicConfig split, ArcSwap model, ForwardingPolicy design, multi-transport listeners, ConfigService, NAPI reload API, TOML format, CLI vs programmatic behavior table

Acceptance Criteria

docs/architecture/configuration.md exists with YAML frontmatter (status: draft)
No duplicate "## Problem" heading
All inline decision rationale replaced with ADR references (030, 031, 028)
All inline open questions replaced with OQ references
OQ-12 resolved: global rules + principal matching, reference ADR-031
OQ-16 resolved: TransportKind match, reference ADR-031
OQ-18 resolved: IdentityProvider owns scopes, reference ADR-029
TOML config file positioned as amending ADR-011, not replacing programmatic API
Follows spec format: What, Why, Architecture, Constraints, Open Questions, Design Decisions
Consistent head/worker terminology throughout
docs/architecture/README.md updated to include configuration.md in architecture docs table
docs/research/configuration.md retains its content (not deleted — it's research source material)

References

docs/research/configuration.md — source material to promote
docs/architecture/decisions/030-static-dynamic-config-split.md — ADR to reference
docs/architecture/decisions/031-forwarding-policy.md — ADR to reference
docs/architecture/decisions/028-auth-irpc-service.md — ADR to reference
docs/architecture/decisions/011-no-ssh-config-programmatic-api.md — amended by TOML config

Notes

To be filled by implementation agent

Summary

To be filled on completion