Compare commits

...

4 Commits

Author SHA1 Message Date
Jon Chery dd81eedcd9 verify(P00): 4-layer verification PASS — REQ-068, REQ-072, REQ-089, C-06/C-15..C-18
---ci---
project: orca
phase: P00
milestone: v0.9
status: verify
---/ci---
2026-08-05 16:26:47 +00:00
Jon Chery fc94326b0e feat(P00): deprecation sweep + bash tooling gate + render contract + doc banners (v0.9 P00)
P00 — Re-architecture Foundation (deprecation/migration/test-infra/persona/docs).

Deprecation sweep (REQ-068, REQ-072, REQ-089):
- Add // Deprecated: doc comments to internal/daemon (R-001), internal/transport
  (REQ-073), internal/security/ca.go+csr.go (D-101/REQ-076), internal/engine/
  dispatcher.go+peer.go (CLI-side scheduler), internal/cli/daemon.go.
- orca daemon emits slog.Warn deprecation banner on every run (ungated); fires
  R-001 + v0.10-P05 drain-and-stop + v0.10-P14 deletion.
- orca cert and orca node join (mTLS path) emit deprecation warnings; proxmox
  SSH path (the v0.9 replacement) does not warn.
- Add --no-deprecation-warnings global flag on root command (PersistentPreRunE)
  for orca upgrade migrations.
- 12 new daemon/cert/node deprecation tests in internal/cli/daemon_test.go
  (cli coverage 81.9%, warnDeprecated 100%).
- Add DEPRECATED banners to v0.8 sections of ARCHITECTURE.md (verified the
  v0.9 supersession section + Supersession Table from prior turn are present).

Bash tooling gate (grill C-06, C-15, C-16, C-17, C-18):
- scripts/tests/test_helper.bash + example_test.bash — bats framework + helpers.
- scripts/lib/orca-log.sh — slog-compatible JSON logging to syslog (C-17).
- scripts/orca-verify-render.sh — render-contract validator skeleton (C-16).
- scripts/tests/orca-log_test.bash + orca-verify-render_test.bash — 20 bats
  tests total (happy + failure paths per C-15).
- .shellcheckrc — project shellcheck config.
- Makefile: test-bash + lint-bash targets (graceful skip if tools missing);
  wired into test + lint targets.
- internal/emit/contract.go + contract_test.go — versioned JSON render
  contract (orca.emit/v1) between Go emitters and bash appliers (C-16).
- .ciagent/BASH_CAPABILITY_MAP_v0.9.md — maps shipped internal/transport
  capabilities to bash-side equivalents or accepted drops (C-18).
- D-186 recorded in PROJECT.md: bash exempt from Go coverage gate; compensating
  control is bats + shellcheck + shfmt (C-06).

verify-reqs: 90 requirements consistent. Build/test/lint/fmt all green.
20 bats tests pass. Go tests pass. No v0.8 code deleted — only marked deprecated
(deletion deferred to v0.10-P14 per REQ-090 dual-write window).

---ci---
project: orca
phase: P00
milestone: v0.9
status: execute
---/ci---
2026-08-05 16:26:26 +00:00
Jon Chery 40b5e781ce docs(P00): resolve C-04 — relabel v1.0→v0.10 milestone, keep all 40 phases, v1.0 UAT-gated
Operator decision (resolves grill C-04 + escalation E-03): keep 2 milestones
(v0.9 + v0.10), keep all phases (40 total, exceeds 35 soft limit), v1.0 is
UAT-gated and cut as a separate tag (v1.0.0) after v0.10 completion per
operator sign-off — not a separate milestone.

Relabels all v1.0 milestone references to v0.10 across ROADMAP, REQUIREMENTS,
GRILL_v0.9, IDEATION_v0.9, PRD_v0.9, PROJECT. Phase content unchanged; only
the milestone label moves. Historical grill narrative (the original PRD §23
counts and the E-03 auto-split reasoning) preserved verbatim for audit
integrity. C-04 and E-03 marked RESOLVED in GRILL_v0.9.md.

Milestone structure:
- v0.9: Re-architecture Foundation & Workloads (13 phases P00..P0X)
- v0.10: Production Hardening (19 phases P00..P16, milestone tag v0.10.0)
- v1.0: UAT-gated production-ready cut (separate v1.0.0 tag, not a milestone)

verify-reqs: 90 requirements consistent.

---ci---
project: orca
phase: 0
milestone: v0.9
status: complete
gate: C-04 resolved
---/ci---
2026-08-05 16:08:33 +00:00
Jon Chery 7315916fbc docs(P00): ship phase 0 — v0.8.0 tagged, released, merged to milestone/v0.9-rearchitecture
---ci---
project: orca
phase: 0
milestone: v0.9
status: complete
---/ci---
2026-08-05 16:02:56 +00:00
32 changed files with 1124 additions and 138 deletions
+10
View File
@@ -79,6 +79,8 @@ and a **dispatcher** for multi-node job execution.
### 2. Daemon Layer (`internal/daemon`)
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 architecture, superseded by the v0.9 re-architecture. See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
- **Server**: `net/http` with `http.ServeMux` (no external router)
- **TLS (P01)**: `crypto/tls` with `MinVersion=tls.VersionTLS13` and
AEAD cipher allowlist
@@ -93,6 +95,8 @@ and a **dispatcher** for multi-node job execution.
### 3. Transport Layer (`internal/transport`, NEW in P01/P02)
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 architecture, superseded by the v0.9 re-architecture. See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
- **Client**: `http.Client` with `http.Transport.TLSClientConfig` populated
from `internal/security.NewClientTLSConfig`
- **Server**: `http.Server.TLSConfig` populated from
@@ -108,6 +112,8 @@ and a **dispatcher** for multi-node job execution.
### 4. Core Engine (`internal/engine`)
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 architecture, superseded by the v0.9 re-architecture. The Dispatcher and PeerRegistry peer-dispatch path is replaced by a CLI-side scheduler + SSH-push (R-001). See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
- **Node Registry**: In-memory map of node IDs → metadata, persisted to SQLite
(CPU/memory capacity, available slots, last-seen)
- **Task Executor**: `os/exec.CommandContext` with `WaitDelay` (Go 1.25+) for
@@ -423,6 +429,8 @@ as a function that takes a `yield func(Job) bool` callback.
## Security Architecture
> **⚠️ DEPRECATED in v0.9**: This section describes the v0.8 internal-CA architecture, superseded by the v0.9 re-architecture (step-ca, D-101/REQ-076). See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
### Authentication
- **v0.1**: mTLS for all API endpoints (self-signed CA)
- **v0.2 P01**: Internal CA with CSR join (see Flow 1 + 2)
@@ -449,6 +457,8 @@ as a function that takes a `yield func(Job) bool` callback.
## Key Architectural Decisions (v0.1 + v0.2)
> **⚠️ DEPRECATED in v0.9**: AD-007 (HCL canonical for jobspecs) below is superseded by R-013/R-014 (Markdown with YAML frontmatter canonical; HCL legacy). See the "v0.9 Architecture" section at the bottom of this file and `.ciagent/PRD_v0.9.md`.
| ID | Decision | Rationale |
|----|----------|-----------|
| AD-001 | Single binary with subcommands | Simpler distribution, aligns with simplicity pillar |
+32
View File
@@ -0,0 +1,32 @@
# Bash Capability Map — v0.9 (grill C-18)
Maps every capability in the shipped `internal/transport` package to its
bash-side equivalent (or accepted drop with recorded rationale) in the v0.9
re-architecture. The grill (C-18) required this mapping so capability
regressions are visible, not silent.
| Shipped capability (internal/transport) | Bash-side equivalent | Status | Rationale |
|---|---|---|---|
| Retry with exponential backoff (`retry.go`: 100ms start, ×2, cap 5s, max 5 attempts) | `orca-retry()` function in `scripts/lib/orca-retry.sh` (to be written in v0.9-P01 SSH-push transport phase, REQ-073) | **planned** (v0.9-P01) | SSH dial/exec failures need the same bounded retry. The pattern is transport-agnostic; the Go retry logic is extracted into the new `internal/sshpush/` package and a bash-side helper mirrors it for the lead-applier scripts. |
| Idempotency keys (`idempotency.go`: in-memory `sync.Map` of keys, `X-Orca-Idempotency-Key` header) | Content-addressed filenames — skip SCP if the target hash already exists on the peer | **planned** (v0.9-P01) | SSH-push doesn't have HTTP headers; idempotency is achieved by content-addressing the rendered file (`<hash>.unit`) and skipping if the peer already has it. The bash applier checks `test -f /run/orca/<hash>` before applying. |
| Structured mTLS failure logging (`handshake_log.go`: slog JSON per mTLS failure) | `orca_log_error` via `scripts/lib/orca-log.sh` (C-17, shipped in this phase P00) | **dropped (mTLS removed by R-001)** | The v0.9 re-architecture removes mTLS daemon-to-daemon transport entirely (R-001). SSH failures are logged via the new `orca_log_*` functions which emit the same slog-compatible JSON field set (ts, level, actor, action, resource, result, error) to syslog. The mTLS-specific handshake-log fields (cipher suite, TLS version, cert SAN) have no SSH equivalent and are dropped — the SSH error message is captured in the `error` field instead. |
| TLS 1.3 + AEAD cipher allowlist (`mtls.go`: MinVersion=tls.VersionTLS13, CipherSuites limited) | SSH's own cipher config (`/etc/ssh/sshd_config` `Ciphers`, `MACs`, `KexAlgorithms`) managed by the operator | **dropped (transport replaced)** | R-001 replaces mTLS HTTP with SSH. SSH's transport security is governed by the peer's sshd_config, not the orca binary. The CLI's SSH client (`golang.org/x/crypto/ssh`, already a dep) uses Go's default modern SSH cipher set. The PRD does not require orca to manage sshd_config cipher policy in v0.9. |
| mTLS client/server handshake (`mtls.go`: `MTLSClient`, daemon-side `SubmitHandler`) | `ssh.Dial` + `ssh.PublicKeys` auth (CLI-side `internal/sshpush/`, REQ-073) | **replaced** (v0.9-P01) | The daemon-to-daemon mTLS handshake is replaced by CLI-to-server SSH. The CLI holds an Ed25519 key (`cluster/orca_ssh_key`, D-037) and authenticates to each peer's sshd. TOFU host-key handling (`proxmox.TOFUHostKeyCallback`, v0.8 REQ-058) is reused for all peers, not just Proxmox. |
## Net-new capabilities in v0.9 (no shipped equivalent)
| Net-new capability | Bash-side | Status |
|---|---|---|
| Transaction bundle apply (R-010, REQ-075) | `orca-apply-render.sh` (v0.10-P10) | planned |
| Drift detection (R-010) | `orca-drift.sh` (v0.10-P10) | planned |
| Per-node state collection | `orca-collect.sh` (v0.10-P09) | planned |
| Lead aggregation | `orca-aggregate.sh` (v0.10-P09) | planned |
| Credential cleanup (5-min shred) | `orca-cleanup-credentials.sh` (v0.10) | planned |
| Render-bundle validation (C-16) | `orca-verify-render.sh` (shipped this phase P00) | ✅ shipped |
| Structured logging (C-17) | `orca-log.sh` (shipped this phase P00) | ✅ shipped |
## Review cadence
This map is reviewed at each phase that introduces or modifies a bash
script. The security-engineer persona reviews the SSH trust surface; the
devops-engineer persona reviews the bash tooling gate (C-15..C-18).
+15 -6
View File
@@ -1,11 +1,20 @@
{
"phase": 0,
"stage": "grill",
"phase": "P00",
"stage": "verify",
"milestone": "v0.9",
"milestone_slug": "rearchitecture",
"phase_role": "pre_execution",
"phase_role": "execution",
"attempts": 0,
"updated_at": "2026-08-05T02:20:00Z",
"updated_at": "2026-08-05T02:45:00Z",
"milestone_complete": false,
"next_milestone": null
}
"gates_cleared": ["C-03", "C-05", "C-06", "C-15", "C-16", "C-17", "C-18"],
"verify": {
"build": "pass",
"go_test": "16/16 packages pass",
"bats": "20/20 tests pass",
"gofmt": "clean",
"go_vet": "clean",
"verify_reqs": "90 requirements consistent",
"shellcheck": "info-level only (no errors)"
}
}
+36 -36
View File
@@ -25,7 +25,7 @@ re-architecture proceeds). Their **mechanics** remain as binding work items:
phase, split heavy phases.
- **Migration** mechanics → split P14 into P14a/P14b/P14c, design migration
ordering in v0.9-P00.
- **Security** mechanics → threat model in v1.0-P15.5 (C-19).
- **Security** mechanics → threat model in v0.10-P15.5 (C-19).
The 19 binding conditions (C-01..C-19) and 10 phase challenges (PC-01..PC-10)
are adopted in full as execution gates.
@@ -76,12 +76,12 @@ silently break the build story; must be spiked before commitment.
simultaneously deprecates 7 shipped subsystems and adds 8 net-new subsystems?
The deprecation of ~10k lines of shipped daemon/transport/CA code is not listed
as a phase. v0.9 P0a..P10 ship 10 phases of workload features before the
transactional control plane (R-010 deferred to v1.0 P10) — is that intentional
transactional control plane (R-010 deferred to v0.10 P10) — is that intentional
or a sequencing error? Hidden requirements (step-ca self-upgrade, master.key
rotation, Syncthing version drift)?
**Evidence**: v0.9 phase ordering ships P0a..P10 workloads, then P10 lead rules
+ migration *last*. The transactional plane (R-010) is deferred to v1.0 P10 —
+ migration *last*. The transactional plane (R-010) is deferred to v0.10 P10 —
two milestones away. v0.8 was a 4-phase NFR milestone; v0.6 was 4-phase feature.
The PRD's v0.9 (11) + v1.0 (16) = 27 phases is 3-4× prior milestone size with
no evidence the throughput model was re-validated. No phase is labeled
@@ -94,12 +94,12 @@ no evidence the throughput model was re-validated. No phase is labeled
- **PC-01**: Move the transactional plane primitives forward. The
transactional primitives (desired-state, lead-applier, drift, rollback) are
the substrate every workload phase depends on. Design spike in v0.9-P00;
full implementation in v1.0-P10 per PRD ordering (workloads first is accepted
full implementation in v0.10-P10 per PRD ordering (workloads first is accepted
given the dual-write window mitigation in I-C-006).
- **PC-02**: Add `v0.9-P00 — Deprecation sweep` as an explicit phase. Must land
before any new feature phase so coverage gates don't measure dead packages.
- **PC-03**: Split migration: `v0.9-P00b — Migration design + dry-run` (early,
parallel to deprecation) and `v1.0-P14 — Production migration` (final).
parallel to deprecation) and `v0.10-P14 — Production migration` (final).
Migration design must inform every earlier phase, not be informed by them.
**Rationale**: 27 phases framed as "two milestones" while simultaneously
@@ -118,7 +118,7 @@ testing frameworks not in current dep map — what's the cost?
**Evidence**: Active roster has 3 of 8 active; the 5 dormant personas map
directly to the 5 new apt dependencies. v0.8 took 4 phases for a pure
test/coverage milestone; v1.0 includes 11 distinct subsystems in one
test/coverage milestone; v0.10 includes 11 distinct subsystems in one
"milestone." No bash test infrastructure exists today.
**Verdict**: PROCEED-WITH-CONDITION
@@ -127,7 +127,7 @@ test/coverage milestone; v1.0 includes 11 distinct subsystems in one
**Binding conditions**:
- **C-04**: Produce a per-phase sizing estimate using v0.6/v0.7/v0.8 actuals
as the analogous baseline. If realistic phase count exceeds 35, the
milestone must be split into v0.9 + v0.10 + v1.0 (three milestones), not two.
milestone must be split into v0.9 + v0.10 (three milestones), not two.
- **C-05**: Reactivate or explicitly assign coverage for the dormant personas'
domains (security, network, devops); no "dormant" = "unowned."
- **C-06**: Decide and document whether bash scripts count toward the coverage
@@ -169,9 +169,9 @@ specified.
`ca.crt` trust root and import into step-ca, or (b) document forced
re-bootstrap as an accepted breaking change with per-cluster upgrade
procedure. Cannot be deferred.
- **C-08**: Before the first SPIFFE-touching phase (v1.0 P02 ACL), produce a
- **C-08**: Before the first SPIFFE-touching phase (v0.10 P02 ACL), produce a
working spike of step-ca JWT-SVID or X.509-SVID minting from the orca CLI
(v1.0-P01.5). If the spike fails, SPIFFE is deferred and ACL falls back to
(v0.10-P01.5). If the spike fails, SPIFFE is deferred and ACL falls back to
mTLS identity (which the shipped model already had).
- **C-09**: Define and test the `orca-pull.sh` failure contract: idempotent
re-run, bounded retry, deterministic state on partial failure, syslog
@@ -212,9 +212,9 @@ is not portable across the orca model. "Atomic, auto-rollback" is asserted for
**Confidence**: 0.82
**Mechanics adopted**:
- **PC-04**: Split P14 into `v1.0-P14a — Data migration` (current scope),
`v1.0-P14b — Daemon cutover + running-allocation adoption`,
`v1.0-P14c — Mixed-version cluster tolerance + no-orca-on-server enforcement`.
- **PC-04**: Split P14 into `v0.10-P14a — Data migration` (current scope),
`v0.10-P14b — Daemon cutover + running-allocation adoption`,
`v0.10-P14c — Mixed-version cluster tolerance + no-orca-on-server enforcement`.
Three sub-phases, each with its own integration test.
**Rationale**: The migration plan as described covers the easy third (file
@@ -254,7 +254,7 @@ documented in step-ca's own operations guide (out-of-band knowledge).
- **C-13**: Replace server-side doctor with a CLI-driven equivalent that
SSH-probes every node and reconstructs the health view the daemon used to
provide locally. This is a new requirement, not a feature; added as
I-C-002 / v1.0-P14c.
I-C-002 / v0.10-P14c.
- **C-14**: Syncthing conflict-resolution policy must be deterministic,
documented, and tested with a forced-divergence integration test.
@@ -291,7 +291,7 @@ is now the default.
**Mechanics adopted**:
- **C-19**: Write a threat model for the new posture before any
security-touching phase (v1.0-P15.5). Defend master.key + CLI mint authority
security-touching phase (v0.10-P15.5). Defend master.key + CLI mint authority
or revise. The shipped model deliberately avoided putting a single stealable
file on a single host that decrypts all secrets and mints all identities.
The threat model must document why the new posture is acceptable or specify
@@ -348,7 +348,7 @@ coverage gate (D-042/D-047) is Go-specific.
**Rationale**: Bash is not inherently unmaintainable, but bash *in a Go-only,
coverage-gated, structured-logging project* is a language-without-rails. Without
the four conditions above, the bash control plane becomes the part of the
codebase that everyone is afraid to touch by v1.0 P05. The drift between Go
codebase that everyone is afraid to touch by v0.10 P05. The drift between Go
emitters and bash appliers is the single most likely source of "works on the
CLI's machine, fails on the lead" bugs.
@@ -367,7 +367,7 @@ transactional layer *on top of the daemon*? Is this re-architecture driven by a
**Evidence**: ROADMAP.md and PROJECT.md: every milestone from v0.1 to v0.8
explicitly says "the vision is unchanged; this milestone is not a direction
change." v0.9/v1.0 is the *first* milestone in the project's history that
change." v0.9/v0.10 is the *first* milestone in the project's history that
reverses the vision's anti-patterns. AD-010's rationale: "step-ca/cfssl/
vault-pki too heavyweight for Orca's footprint." Nothing in the original PRD
suggested Orca's footprint changed. The shipped model's `internal/transport`
@@ -417,35 +417,35 @@ conditions (C-01..C-19) as execution gates. If the C-04 sizing estimate exceeds
| C-01 | Evaluate wasmtime Go binding CGO impact; if CGO-required, drop wasmtime as primary or revoke D-002 | v0.9-P07b | Build matrix spike on linux/amd64+arm64; revocation decision recorded |
| C-02 | Syncthing feasibility spike: config injection, conflict policy, deterministic failure mode | v0.9-P09 | Spike report + forced-divergence integration test |
| C-03 | Check PRD into `.ciagent/PRD_v0.9.md` before any v0.9 phase begins | (gate) | ✅ Resolved — file committed |
| C-04 | Per-phase sizing estimate vs v0.6/v0.7/v0.8 actuals; if >35, split into v0.9+v0.10+v1.0 | v0.9 start | Estimate doc with analogous-phase sizing table |
| C-04 | Per-phase sizing estimate vs v0.6/v0.7/v0.8 actuals; if >35, split into v0.9+v0.10 | v0.9 start | ✅ RESOLVED — operator decision: keep 2 milestones (v0.9+v0.10), keep all phases (40 total), v1.0 UAT-gated after v0.10 |
| C-05 | Reactivate or assign dormant persona domains (security, network, devops) | v0.9-P00 | PERSONAS.md updated with named owners |
| C-06 | Decide bash coverage-gate status; if exempt, record compensating control | v0.9-P00 | Decision recorded in PROJECT.md D-series; CI pipeline shows the gate |
| C-07 | CA migration spec: preserve existing trust root or document forced re-bootstrap | v1.0-P14a | Spec doc + migration dry-run on test cluster |
| C-08 | SPIFFE SVID minting spike; if fails, fall back to mTLS identity | v1.0-P02 (spike in P01.5) | Working SVID mint from orca CLI in sandbox |
| C-09 | `orca-pull.sh` failure contract: idempotent re-run, bounded retry, deterministic state, structured syslog | v1.0-P10 | Failure-path integration test + syslog structured-tag verification |
| C-07 | CA migration spec: preserve existing trust root or document forced re-bootstrap | v0.10-P14a | Spec doc + migration dry-run on test cluster |
| C-08 | SPIFFE SVID minting spike; if fails, fall back to mTLS identity | v0.10-P02 (spike in P01.5) | Working SVID mint from orca CLI in sandbox |
| C-09 | `orca-pull.sh` failure contract: idempotent re-run, bounded retry, deterministic state, structured syslog | v0.10-P10 | Failure-path integration test + syslog structured-tag verification |
| C-10 | Traefik config atomicity protocol (tmpfile+fsync+rename) + malformed-config behavior verified | v0.9-P02 | Atomic-rename test + Traefik malconfig-hold-last-good assertion |
| C-11 | Lead-side watchdog meta-timer for `orca-pull.sh` starvation, with structured alert path | v1.0-P09 | Watchdog fires on injected pull failure; alert received |
| C-12 | Document step-ca HA story; if single-node, record as accepted SPOF with mitigation | v1.0-P09 | Decision doc; if HA, RAFT/sync story in orca plan |
| C-13 | Replace server-side doctor with CLI-SSH-driven equivalent | v1.0-P14c | New REQ-086 in REQUIREMENTS.md; integration test SSH-probes N nodes |
| C-14 | Syncthing conflict-resolution policy deterministic + forced-divergence integration test | v1.0-P09 | Test induces divergence; resolves to single deterministic state |
| C-11 | Lead-side watchdog meta-timer for `orca-pull.sh` starvation, with structured alert path | v0.10-P09 | Watchdog fires on injected pull failure; alert received |
| C-12 | Document step-ca HA story; if single-node, record as accepted SPOF with mitigation | v0.10-P09 | Decision doc; if HA, RAFT/sync story in orca plan |
| C-13 | Replace server-side doctor with CLI-SSH-driven equivalent | v0.10-P14c | New REQ-086 in REQUIREMENTS.md; integration test SSH-probes N nodes |
| C-14 | Syncthing conflict-resolution policy deterministic + forced-divergence integration test | v0.10-P09 | Test induces divergence; resolves to single deterministic state |
| C-15 | Bash testing framework (bats/shunit2) + shellcheck + shfmt in CoreCI before any bash ships | v0.9-P00 | CI pipeline green with the gate on a sample script |
| C-16 | Versioned JSON-schema render-format contract between Go emitters and bash appliers | v0.9-P00 | Schema file in repo; both sides validate; mismatch fails CI |
| C-17 | Bash scripts emit slog-compatible JSON to syslog with audit-log field set (REQ-006) | v0.9-P00 | Syslog capture test verifies field-presence + JSON parse |
| C-18 | Document bash-side equivalents (or accepted drops) for shipped transport capabilities | v0.9-P00 | Capability-mapping doc in `.ciagent/` |
| C-19 | Write a threat model for the new posture; defend master.key + CLI mint authority or revise | v1.0-P15.5 | Threat-model doc reviewed and committed; design revised if regression found |
| C-19 | Write a threat model for the new posture; defend master.key + CLI mint authority or revise | v0.10-P15.5 | Threat-model doc reviewed and committed; design revised if regression found |
# Phase Plan Challenges
| # | Phase | Problem | Fix |
|---|-------|---------|-----|
| PC-01 | v0.9 P0aP10 | Ship 10 phases of workload features before the transactional control plane | Design spike in v0.9-P00; full impl in v1.0-P10 per PRD ordering (workloads first accepted with dual-write mitigation) |
| PC-01 | v0.9 P0aP10 | Ship 10 phases of workload features before the transactional control plane | Design spike in v0.9-P00; full impl in v0.10-P10 per PRD ordering (workloads first accepted with dual-write mitigation) |
| PC-02 | (missing) | Deprecation of ~10k lines of daemon/transport/CA code is not a phase | Add `v0.9-P00 — Deprecation sweep` as explicit phase before any new feature phase |
| PC-03 | v0.9 P10 | Migration is the last phase of v0.9 but is highest-risk | Split: migration design in v0.9-P00 (early), implementation in v1.0-P14 (final) |
| PC-04 | v1.0 P14 | Covers data migration only; omits running-allocation cutover, mixed-version cluster, rollback trigger | Split into P14a (data), P14b (daemon cutover), P14c (mixed-version tolerance) |
| PC-05 | v1.0 P02 | SPIFFE is a documented reversal with no spike; lands before spike possible | Insert `v1.0-P01.5 — SPIFFE mint spike` as hard gate before P02 |
| PC-06 | v1.0 P10 | Transactional plane depends on lead-applier bash scripts (C-09) not gated | Reorder to v0.9-P00 design + add C-09 gate |
| PC-07 | v1.0 P15/P16 | README before security threat model | Add `v1.0-P15.5 — Threat model + security review` before final review |
| PC-08 | (missing) | No phase replaces server-side `orca doctor` | Add as I-C-002 / v1.0-P14c (CLI-SSH-driven doctor) |
| PC-03 | v0.9 P10 | Migration is the last phase of v0.9 but is highest-risk | Split: migration design in v0.9-P00 (early), implementation in v0.10-P14 (final) |
| PC-04 | v0.10 P14 | Covers data migration only; omits running-allocation cutover, mixed-version cluster, rollback trigger | Split into P14a (data), P14b (daemon cutover), P14c (mixed-version tolerance) |
| PC-05 | v0.10 P02 | SPIFFE is a documented reversal with no spike; lands before spike possible | Insert `v0.10-P01.5 — SPIFFE mint spike` as hard gate before P02 |
| PC-06 | v0.10 P10 | Transactional plane depends on lead-applier bash scripts (C-09) not gated | Reorder to v0.9-P00 design + add C-09 gate |
| PC-07 | v0.10 P15/P16 | README before security threat model | Add `v0.10-P15.5 — Threat model + security review` before final review |
| PC-08 | (missing) | No phase replaces server-side `orca doctor` | Add as I-C-002 / v0.10-P14c (CLI-SSH-driven doctor) |
| PC-09 | v0.9 P09 | Syncthing lands before feasibility spike (C-02) | Spike must precede P09; if P09 is the spike, rename + gate on spike success |
| PC-10 | v0.9 P07 | Five runtimes in one phase, including wasmtime (CGO risk) and pve-vm/pve-ct | Split: P07a (process+podman), P07b (wasmtime, C-01 gated), P07c (pve-vm+ct) |
@@ -454,9 +454,9 @@ conditions (C-01..C-19) as execution gates. If the C-04 sizing estimate exceeds
1. **What measured operational failure of the shipped v0.8 daemon model is the re-architecture responding to?** — ✅ Resolved by override ground 1.
2. **Can the v0.9 scope be delivered as additive extensions?** — ✅ Resolved: rejected per override grounds 1 + 5.
3. **What is the wasmtime/CGO resolution?** — Closes via C-01 spike in v0.9-P07b.
4. **What is the master.key threat model?** — Closes via C-19 in v1.0-P15.5.
4. **What is the master.key threat model?** — Closes via C-19 in v0.10-P15.5.
5. **What is the rollback unit of work for §24, and what triggers it?** — Must be answered in v0.9-P00 txn-design spike (I-B-007).
6. **Is step-ca single-node acceptable as a cluster SPOF?** — Closes via C-12 in v1.0-P09.
6. **Is step-ca single-node acceptable as a cluster SPOF?** — Closes via C-12 in v0.10-P09.
7. **Can the bash control plane be reduced?** — Closes in v0.9-P00 (fold 3+ scripts into Go-side SSH invocations where possible).
8. **What is the realistic phase count?** — Closes via C-04 sizing before v0.9 starts; if >35, the plan becomes three milestones.
9. **Does the PRD's reversal of 6 documented decisions require a formal AD-series supersession?** — ✅ Resolved: supersession table recorded in PROJECT.md + ARCHITECTURE.md.
@@ -481,5 +481,5 @@ conditions (C-01..C-19) as execution gates. If the C-04 sizing estimate exceeds
| E-ID | Item | Auto-decision | Mitigation |
|------|------|---------------|-----------|
| E-01 | Whether the re-architecture is justified vs incremental | OVERRIDDEN by user — direction holds | Six-part evidence basis recorded in PROJECT.md Supersession Table |
| E-02 | Whether master.key passphrase-less posture is acceptable | REPLAN mechanics — threat model first | C-19 in v1.0-P15.5; if threat model shows regression vs shipped, revise design |
| E-03 | Whether 27 phases fit in 2 milestones | Auto-split if sizing exceeds 35 | C-04; if exceeded, milestone becomes v0.9 + v0.10 + v1.0 |
| E-02 | Whether master.key passphrase-less posture is acceptable | REPLAN mechanics — threat model first | C-19 in v0.10-P15.5; if threat model shows regression vs shipped, revise design |
| E-03 | Whether 27 phases fit in 2 milestones | Auto-split if sizing exceeds 35 | ✅ RESOLVED — operator: keep 2 milestones (v0.9+v0.10), keep all phases, v1.0 UAT-gated |
+53 -53
View File
@@ -1,6 +1,6 @@
# Ideation v0.9 — Re-architecture Foundation
**Project**: orca (single-project mode) | **Milestone**: v0.9/v1.0 re-architecture
**Project**: orca (single-project mode) | **Milestone**: v0.9/v0.10 re-architecture
**Date**: 2026-08-05 | **Agent**: ideation agent | **Confidence threshold**: 0.60
**Next REQ ID prior to this run**: REQ-060 (v0.8 complete)
@@ -12,7 +12,7 @@ with a CLI-only, SSH-push, step-ca, Markdown-frontmatter, multi-namespace
stack. 9 packages are deprecation targets (~2,400 LOC of v0.8
daemon/transport/security-ca/engine-dispatch/jobspec-hcl/config-hcl/certpaths
code), 7 packages are adaptable, and 8 subsystems are net-new with zero
implementation. The §23 milestone plan has 11 v0.9 phases + 17 v1.0 phases but
implementation. The §23 milestone plan has 11 v0.9 phases + 17 v0.10 phases but
under-specifies the deprecation mechanics, the SSH-push transport design, the
lead-applier execution model, several adapter/bridge layers, and the
migration ordering risk.
@@ -25,10 +25,10 @@ the PRD §23 plan are listed at the end.
### I-M-001 — `orca daemon` deprecation command and build-tag removal path
- **Tier**: mechanical
- **Description**: The PRD deprecates `internal/daemon/` (R-001) but §23 never says *how*. `internal/cli/daemon.go` (100 LOC) registers the `daemon` cobra command and wires `daemon.NewServer` + `engine.Dispatcher`. Big-bang removal would break the v0.8→v1.0 migration path (v1.0-P14) because `orca upgrade --to-v1.0` must run against a live v0.8 cluster that still has daemons. Proposal: (1) in v0.9, `orca daemon` emits a deprecation warning and still runs (dual-write window); (2) in v1.0, `orca daemon` is repurposed to `orca daemon drain-and-stop` (stops v0.8 daemons on peers via SSH, confirms workloads survive via systemd); (3) post-v1.0, the command and `internal/daemon/` are deleted. Add `// Deprecated` Go doc comments + `slog.Warn` on every run.
- **Description**: The PRD deprecates `internal/daemon/` (R-001) but §23 never says *how*. `internal/cli/daemon.go` (100 LOC) registers the `daemon` cobra command and wires `daemon.NewServer` + `engine.Dispatcher`. Big-bang removal would break the v0.8→v1.0 migration path (v0.10-P14) because `orca upgrade --to-v1.0` must run against a live v0.8 cluster that still has daemons. Proposal: (1) in v0.9, `orca daemon` emits a deprecation warning and still runs (dual-write window); (2) in v1.0, `orca daemon` is repurposed to `orca daemon drain-and-stop` (stops v0.8 daemons on peers via SSH, confirms workloads survive via systemd); (3) post-v1.0, the command and `internal/daemon/` are deleted. Add `// Deprecated` Go doc comments + `slog.Warn` on every run.
- **Rationale**: R-001 is an invariant, but the *transition* off the daemon is a mechanical gap. The v0.8 `daemon.go` is wired in `root.go` init; removing it without a transition plan breaks the §24 migration.
- **Proposed REQ ID**: REQ-061
- **Proposed phase placement**: v1.0-P14 (migration) — deprecation warning lands in v0.9-P0X
- **Proposed phase placement**: v0.10-P14 (migration) — deprecation warning lands in v0.9-P0X
- **Confidence**: 0.82
- **Accept/Defer**: accept
@@ -61,25 +61,25 @@ the PRD §23 plan are listed at the end.
### I-M-005 — `orca doctor --legacy-paths` detection for v0.8 residue
- **Tier**: mechanical
- **Description**: The v0.8 layout is `~/.orca/{orca.db, ca.crt, ca.key, server.crt, server.key, orca_ssh_key, known_hosts, config.hcl}`. The v1.0 layout is `ORCA_HOME/{_defaults/, cluster/{ca,master.key,peers,pve,txns}, <ns>/{db,.env,.env.secrets,jobs,alloc,ns.md}, orca_cache.db}`. `orca doctor` (`internal/doctor/doctor.go`, 501 LOC, adaptable) must gain a `doctor legacy` subcommand that detects v0.8 residue: presence of `orca.db` at ORCA_HOME root, `ca.crt`/`ca.key` (internal CA, superseded by step-ca), `config.hcl` (HCL, demoted), flat `server.crt` (single-namespace), and a `namespace` column in any `*.db` (R-002 says no namespace column). Output: list of detected legacy artifacts with migration recommendations. This is the *detection* half of v1.0-P14; the *migration* half is I-C-001.
- **Rationale**: §23 v1.0-P14 says "orca upgrade --to-v1.0, post-invariant checks" but doesn't specify the detection surface. `doctor` is the diagnostics framework and is explicitly adaptable.
- **Description**: The v0.8 layout is `~/.orca/{orca.db, ca.crt, ca.key, server.crt, server.key, orca_ssh_key, known_hosts, config.hcl}`. The v1.0 layout is `ORCA_HOME/{_defaults/, cluster/{ca,master.key,peers,pve,txns}, <ns>/{db,.env,.env.secrets,jobs,alloc,ns.md}, orca_cache.db}`. `orca doctor` (`internal/doctor/doctor.go`, 501 LOC, adaptable) must gain a `doctor legacy` subcommand that detects v0.8 residue: presence of `orca.db` at ORCA_HOME root, `ca.crt`/`ca.key` (internal CA, superseded by step-ca), `config.hcl` (HCL, demoted), flat `server.crt` (single-namespace), and a `namespace` column in any `*.db` (R-002 says no namespace column). Output: list of detected legacy artifacts with migration recommendations. This is the *detection* half of v0.10-P14; the *migration* half is I-C-001.
- **Rationale**: §23 v0.10-P14 says "orca upgrade --to-v1.0, post-invariant checks" but doesn't specify the detection surface. `doctor` is the diagnostics framework and is explicitly adaptable.
- **Proposed REQ ID**: REQ-065
- **Proposed phase placement**: v1.0-P14c (mixed-version tolerance + no-orca enforcement)
- **Proposed phase placement**: v0.10-P14c (mixed-version tolerance + no-orca enforcement)
- **Confidence**: 0.80
- **Accept/Defer**: accept
### I-M-006 — Legacy CA state migration to step-ca (cert import)
- **Tier**: mechanical
- **Description**: `internal/security/ca.go` (338 LOC) holds an internal Go CA with `ca.crt`/`ca.key` (RSA 3072, 10-year). The PRD replaces this with step-ca (R-006, D-101 reverses AD-010). The v1.0-P14 migration must handle existing deployments with an internal CA: (a) import the existing CA key into step-ca as `step ca init --deployment-type standalone --remote-management` with the existing key; (b) issue new SVIDs from step-ca and let old certs expire; (c) document that v0.8 certs are invalidated and re-bootstrap is required. The codebase audit says `ca.go`+`csr.go` are *replaced* — but the *state* (the CA key + issued server certs in `cert_repo` SQLite) may need to be preserved for audit history even if the live trust root changes. Proposal: `orca upgrade --to-v1.0 --import-ca` reads `~/.orca/ca.key`, initializes step-ca with it, and re-issues workload SVIDs. Without this, existing deployments lose their trust root with no path back.
- **Description**: `internal/security/ca.go` (338 LOC) holds an internal Go CA with `ca.crt`/`ca.key` (RSA 3072, 10-year). The PRD replaces this with step-ca (R-006, D-101 reverses AD-010). The v0.10-P14 migration must handle existing deployments with an internal CA: (a) import the existing CA key into step-ca as `step ca init --deployment-type standalone --remote-management` with the existing key; (b) issue new SVIDs from step-ca and let old certs expire; (c) document that v0.8 certs are invalidated and re-bootstrap is required. The codebase audit says `ca.go`+`csr.go` are *replaced* — but the *state* (the CA key + issued server certs in `cert_repo` SQLite) may need to be preserved for audit history even if the live trust root changes. Proposal: `orca upgrade --to-v1.0 --import-ca` reads `~/.orca/ca.key`, initializes step-ca with it, and re-issues workload SVIDs. Without this, existing deployments lose their trust root with no path back.
- **Rationale**: AD-010 is explicitly reversed by D-101, but the reversal doesn't address what happens to the existing CA material. §24 covers data migration but not CA migration.
- **Proposed REQ ID**: REQ-066
- **Proposed phase placement**: v1.0-P14a (data migration)
- **Proposed phase placement**: v0.10-P14a (data migration)
- **Confidence**: 0.70
- **Accept/Defer**: accept (design in v0.9-P00 so step-ca integration knows the import contract)
### I-M-007 — Fuzz test harness for the Markdown frontmatter parser
- **Tier**: mechanical
- **Description**: R-014/R-015 require byte-exact body preservation — "body of every .md config file preserved verbatim." This is a class of bug that's easy to get wrong (off-by-one on the `---` delimiter, trailing newline handling, BOM, CRLF, nested code fences containing `---`). v0.8 has no fuzz tests at all. Proposal: add a `testing.F` fuzz target in `internal/jobspec/markdown_test.go` that round-trips random frontmatter+body through `ParseMarkdown` and asserts `body == roundtripped.body` byte-exact. Also add a corpus of adversarial fixtures (CRLF, BOM, no-frontmatter, empty-frontmatter, frontmatter-with-only-separator). §23 v1.0-P08 mentions integration tests but not fuzzing.
- **Description**: R-014/R-015 require byte-exact body preservation — "body of every .md config file preserved verbatim." This is a class of bug that's easy to get wrong (off-by-one on the `---` delimiter, trailing newline handling, BOM, CRLF, nested code fences containing `---`). v0.8 has no fuzz tests at all. Proposal: add a `testing.F` fuzz target in `internal/jobspec/markdown_test.go` that round-trips random frontmatter+body through `ParseMarkdown` and asserts `body == roundtripped.body` byte-exact. Also add a corpus of adversarial fixtures (CRLF, BOM, no-frontmatter, empty-frontmatter, frontmatter-with-only-separator). §23 v0.10-P08 mentions integration tests but not fuzzing.
- **Rationale**: R-015 is a *load-bearing invariant* (body appears in inspect/history). Byte-exactness is exactly what fuzz tests are for. The v0.8 jobspec tests are golden-file only (no fuzz).
- **Proposed REQ ID**: REQ-067
- **Proposed phase placement**: v0.9-P0b (Markdown parser) — fuzz from day one
@@ -89,9 +89,9 @@ the PRD §23 plan are listed at the end.
### I-M-008 — Deprecation warnings on removed/repurposed CLI subcommands
- **Tier**: mechanical
- **Description**: The v0.8 CLI has `orca cert {ca-init,gen,show,renew,fingerprint}` (`internal/cli/cert.go`), `orca node join` with mTLS handshake semantics (`internal/cli/node.go`), `orca job run <spec.hcl>`. The PRD repurposes `node join` to SSH-bootstrap (no mTLS), deprecates `cert` (step-ca handles it), and changes `job run` to accept `.md` specs. Each removed/changed command should emit a `slog.Warn` deprecation banner with the v1.0 replacement, *except* when run under `orca upgrade`. The existing `root.go` `PersistentPreRunE` is the natural hook for a global `--no-deprecation-warnings` flag.
- **Rationale**: Operators running v0.8 commands against v0.9/v1.0 need to know what changed. The PRD doesn't mention deprecation UX.
- **Rationale**: Operators running v0.8 commands against v0.9/v0.10 need to know what changed. The PRD doesn't mention deprecation UX.
- **Proposed REQ ID**: REQ-068
- **Proposed phase placement**: v0.9-P0X (ship) + v1.0-P13 (ns subcommands, when CLI surface is finalized)
- **Proposed phase placement**: v0.9-P0X (ship) + v0.10-P13 (ns subcommands, when CLI surface is finalized)
- **Confidence**: 0.72
- **Accept/Defer**: accept
@@ -115,10 +115,10 @@ the PRD §23 plan are listed at the end.
### I-M-011 — `internal/store/` schema: per-namespace DBs, drop ns column
- **Tier**: mechanical
- **Description**: R-002 says "No `namespace` column in SQLite." The v0.8 schema has 7 migrations (`0001`..`0007`) with a single `orca.db`. The v1.0 model has one DB per namespace (`<ns>/db/orca.db`) plus a CLI-side cache DB (`orca_cache.db`, R-008). The existing `store.Open(path)` takes a path arg — adaptable. But the migrations are global; they need to apply *per namespace DB*. Proposal: `store.Open` gains a namespace parameter (or caller passes `paths.NSDb(ns)`); `migrate.go` runs `0001`..`0007` (minus `0006_node_kind_os` which is v0.8-specific) plus new `0008_namespace_layout.sql`. The `cert_repo` (`0004_certs.sql`) is removed (step-ca handles certs). The audit_log table moves to the CLI-side cache DB (R-008). Existing v0.8 `orca.db` is migrated by splitting tables into per-namespace DBs during v1.0-P14.
- **Description**: R-002 says "No `namespace` column in SQLite." The v0.8 schema has 7 migrations (`0001`..`0007`) with a single `orca.db`. The v0.10 model has one DB per namespace (`<ns>/db/orca.db`) plus a CLI-side cache DB (`orca_cache.db`, R-008). The existing `store.Open(path)` takes a path arg — adaptable. But the migrations are global; they need to apply *per namespace DB*. Proposal: `store.Open` gains a namespace parameter (or caller passes `paths.NSDb(ns)`); `migrate.go` runs `0001`..`0007` (minus `0006_node_kind_os` which is v0.8-specific) plus new `0008_namespace_layout.sql`. The `cert_repo` (`0004_certs.sql`) is removed (step-ca handles certs). The audit_log table moves to the CLI-side cache DB (R-008). Existing v0.8 `orca.db` is migrated by splitting tables into per-namespace DBs during v0.10-P14.
- **Rationale**: R-002 is explicit ("No namespace column in SQLite") but the existing schema has a single DB. §23 doesn't specify the schema split mechanics.
- **Proposed REQ ID**: REQ-071
- **Proposed phase placement**: v0.9-P0a1 + v1.0-P06 (alloc history, which uses cache DB)
- **Proposed phase placement**: v0.9-P0a1 + v0.10-P06 (alloc history, which uses cache DB)
- **Confidence**: 0.80
- **Accept/Defer**: accept
@@ -127,9 +127,9 @@ the PRD §23 plan are listed at the end.
- **Description**: `internal/transport/` (7 files, ~1300 LOC incl tests) implements mTLS client/server, dispatch, idempotency, retry, handshake logging. R-001 + R-006 replace this with SSH-push. The *idempotency* and *retry* logic (`idempotency.go` 123 LOC, `retry.go` 151 LOC) is conceptually reusable for SSH-push (retry on SSH failure, idempotency keys for SCP'd configs). Proposal: delete `mtls.go`, `dispatch.go`, `handshake_log.go`; extract retry/idempotency patterns into a new `internal/sshpush/` package. The existing `transport.IdempotencyStore` (in-memory `sync.Map` of keys) is directly reusable. This avoids re-implementing retry semantics from scratch.
- **Rationale**: The codebase audit marks `internal/transport/` as fully replaced, but the retry/idempotency *patterns* are transport-agnostic. §23 doesn't call this out.
- **Proposed REQ ID**: REQ-072
- **Proposed phase placement**: v0.9-P00 (deprecation sweep) — delete in v1.0-P14
- **Proposed phase placement**: v0.9-P00 (deprecation sweep) — delete in v0.10-P14
- **Confidence**: 0.68
- **Accept/Defer**: accept (defer deletion to v1.0-P14 to keep dual-write window open)
- **Accept/Defer**: accept (defer deletion to v0.10-P14 to keep dual-write window open)
## Tier 2 — Backend-Enriched (Structural / Architectural)
@@ -156,7 +156,7 @@ the PRD §23 plan are listed at the end.
- **Description**: R-001 says "no orca binary on servers." R-010 says the lead applies desired-state transactionally. Unresolved: does the lead run `orca-pull.sh` (pure bash that SCPs a desired-state bundle and applies it via `systemctl daemon-reload` + `systemctl restart`) or does the operator's CLI SSH into the lead and runs `orca apply` remotely (which would put an orca binary on the lead, violating R-001)? The PRD's intent is the former: the lead is bare Linux with systemd timers + bash. Proposal: (1) the CLI renders a *transaction bundle* (tarball of desired-state files + `apply.sh` + `verify.sh`) on the operator host; (2) SCPs it to the lead's `/run/orca/txns/<txn-id>/`; (3) the lead's systemd timer runs `/run/orca/txns/<txn-id>/apply.sh` which idempotently applies and runs verify; (4) the CLI polls the lead for txn status via SSH (`cat /run/orca/txns/<txn-id>/status.json`). The bash scripts are generated by the CLI's emitter (I-B-002), not hand-written per cluster.
- **Rationale**: The most ambiguous load-bearing design decision in the PRD. R-001 + R-010 together imply the lead runs no orca binary, but the lead must apply transactions. §23 doesn't resolve this. Getting it wrong means either violating R-001 or having no transactional apply.
- **Proposed REQ ID**: REQ-075
- **Proposed phase placement**: v1.0-P10 (transactional plane) — bundle format designed in v0.9-P00
- **Proposed phase placement**: v0.10-P10 (transactional plane) — bundle format designed in v0.9-P00
- **Confidence**: 0.78
- **Accept/Defer**: accept
@@ -165,13 +165,13 @@ the PRD §23 plan are listed at the end.
- **Description**: D-101 reverses AD-010 (which rejected step-ca as "too heavyweight"). §23 mentions step-ca in R-006 but never specifies the integration. Key surfaces: (1) **Provisioning**: `orca init` (adapted from v0.8's `internal/cli/init.go`) runs `step ca init` on the lead, stores root + intermediate in `cluster/ca/`. (2) **CA bootstrap**: CLI SSHs to the lead, installs step-ca via apt, runs `step ca init`, stores `step-ca.json` config. (3) **Cert signing API**: workloads request SVIDs via `step ca token` (JWE provisioner token minted by CLI) → `step ca certificate`. The CLI mints the token because it holds the provisioner password (in `cluster/master.key`-derived form). (4) **SVID minting**: each workload gets a SPIFFE ID (`spiffe://orca/<ns>/<workload>/<instance>`) encoded as a SAN in the step-ca-issued cert. The v0.8 `internal/security/ca.go` is deleted; a new `internal/stepca/` package wraps the `step` CLI via SSH (no Go step-ca client library — keep zero-new-dep posture if possible, or add `github.com/smallstep/cli` as a dep).
- **Rationale**: step-ca is a new external dependency with its own config format, provisioner model, and CLI. §23 assumes it but never designs the integration. security-engineer persona must be reactivated.
- **Proposed REQ ID**: REQ-076
- **Proposed phase placement**: v0.9-P07 (runtime block — runtimes need SVIDs) + v1.0-P02 (ACL — SPIFFE identities)
- **Proposed phase placement**: v0.9-P07 (runtime block — runtimes need SVIDs) + v0.10-P02 (ACL — SPIFFE identities)
- **Confidence**: 0.74
- **Accept/Defer**: accept
### I-B-005 — Traefik dynamic config generation and atomic reload
- **Tier**: backend-enriched
- **Description**: R-006 makes Traefik load-bearing (mTLS termination + health checks). §23 puts service blocks + Traefik health checks in v0.9-P02. Design: the CLI's Traefik emitter (I-B-002) renders a dynamic config file (`/etc/traefik/dynamic/orca-<ns>-<svc>.yaml`) with backends (the socket paths from R-007), health checks, and mTLS config pointing at step-ca's root. Atomic reload: Traefik watches the dynamic dir with `fsnotify` — writing the file atomically (tmp+rename) triggers a reload. Drain (v1.0-P05) works by writing a config with the backend's `weight=0` or removing it, triggering Traefik to stop routing. The v0.8 codebase has no Traefik integration at all. **Gated by grill C-10** (Traefik config atomicity protocol: tmpfile+fsync+rename + malformed-config hold-last-good verified).
- **Description**: R-006 makes Traefik load-bearing (mTLS termination + health checks). §23 puts service blocks + Traefik health checks in v0.9-P02. Design: the CLI's Traefik emitter (I-B-002) renders a dynamic config file (`/etc/traefik/dynamic/orca-<ns>-<svc>.yaml`) with backends (the socket paths from R-007), health checks, and mTLS config pointing at step-ca's root. Atomic reload: Traefik watches the dynamic dir with `fsnotify` — writing the file atomically (tmp+rename) triggers a reload. Drain (v0.10-P05) works by writing a config with the backend's `weight=0` or removing it, triggering Traefik to stop routing. The v0.8 codebase has no Traefik integration at all. **Gated by grill C-10** (Traefik config atomicity protocol: tmpfile+fsync+rename + malformed-config hold-last-good verified).
- **Rationale**: Traefik is net-new and load-bearing. §23 mentions it in R-006/P02/P05 but never specifies config generation or reload mechanism.
- **Proposed REQ ID**: REQ-077
- **Proposed phase placement**: v0.9-P02 (Service block + checks)
@@ -189,19 +189,19 @@ the PRD §23 plan are listed at the end.
### I-B-007 — Transaction bundle format and atomicity across N peers
- **Tier**: backend-enriched
- **Description**: R-010 requires transactional control-plane updates. §23 puts this in v1.0-P10. Design: a *transaction bundle* is a tarball containing: (1) `desired-state.json` (full desired state for affected namespaces), (2) `apply.sh` (idempotent apply script), (3) `verify.sh` (post-apply invariants), (4) `rollback.sh` (revert to previous state), (5) `manifest.sig` (signature with `cluster/master.key`). Atomicity across N peers: the CLI uploads the bundle to the lead; the lead applies to itself first, then fans out to peers via SSH. If any peer fails verify, the lead runs `rollback.sh` on all peers that applied. The bundle is content-addressed (`<txn-id> = sha256(desired-state.json)`) and stored in `cluster/txns/<txn-id>/`. Drift detection (R-010) compares the last applied bundle's desired-state against the live state (polled via SSH `systemctl show` + file checksums). **Gated by grill C-09** (orca-pull.sh failure contract: idempotent re-run, bounded retry, deterministic state, structured syslog).
- **Description**: R-010 requires transactional control-plane updates. §23 puts this in v0.10-P10. Design: a *transaction bundle* is a tarball containing: (1) `desired-state.json` (full desired state for affected namespaces), (2) `apply.sh` (idempotent apply script), (3) `verify.sh` (post-apply invariants), (4) `rollback.sh` (revert to previous state), (5) `manifest.sig` (signature with `cluster/master.key`). Atomicity across N peers: the CLI uploads the bundle to the lead; the lead applies to itself first, then fans out to peers via SSH. If any peer fails verify, the lead runs `rollback.sh` on all peers that applied. The bundle is content-addressed (`<txn-id> = sha256(desired-state.json)`) and stored in `cluster/txns/<txn-id>/`. Drift detection (R-010) compares the last applied bundle's desired-state against the live state (polled via SSH `systemctl show` + file checksums). **Gated by grill C-09** (orca-pull.sh failure contract: idempotent re-run, bounded retry, deterministic state, structured syslog).
- **Rationale**: Multi-peer atomicity is the hardest part of R-010. §23 says "ArgoCD-style" but ArgoCD is Kubernetes-native; the SSH-push model needs a custom bundle format.
- **Proposed REQ ID**: REQ-079
- **Proposed phase placement**: v1.0-P10 (transactional plane) — designed in v0.9-P00
- **Proposed phase placement**: v0.10-P10 (transactional plane) — designed in v0.9-P00
- **Confidence**: 0.76
- **Accept/Defer**: accept
### I-B-008 — Master key management and HKDF-SHA256 per-line .env.secrets encryption
- **Tier**: backend-enriched
- **Description**: R-011 specifies `.env.secrets` with AES-256-GCM, per-line nonce, master key at `cluster/master.key`. §23 puts this in v1.0-P03. Design: (1) `cluster/master.key` is a 32-byte random key generated by `orca init` (extend v0.8 `internal/security/ca.go`'s `WriteAtomic` pattern for the file write). (2) Each line of `.env.secrets` is `base64(nonce || ciphertext || tag)` where `nonce = random(12 bytes)` and `ciphertext = AES-256-GCM(plaintext, key=master.key, nonce, aad=line-number)`. (3) The AAD is the 1-indexed line number to prevent line-swap attacks. (4) Decryption reads the master key, iterates lines, decrypts with AAD. (5) `orca secrets set <ns> <key> <value>` appends an encrypted line; `orca secrets get <ns> <key>` decrypts and prints (redacted by default, `--reveal` to show). (6) The v0.8 `internal/security/redact.go` (103 LOC) is directly reusable for redaction. HKDF-SHA256 derives per-namespace sub-keys from the master key (`HKDF-SHA256(master, info=<ns>)`) so compromising one namespace's key doesn't compromise others — but the master key is the root of trust. **Gated by grill C-19** (threat model for master.key passphrase-less posture).
- **Description**: R-011 specifies `.env.secrets` with AES-256-GCM, per-line nonce, master key at `cluster/master.key`. §23 puts this in v0.10-P03. Design: (1) `cluster/master.key` is a 32-byte random key generated by `orca init` (extend v0.8 `internal/security/ca.go`'s `WriteAtomic` pattern for the file write). (2) Each line of `.env.secrets` is `base64(nonce || ciphertext || tag)` where `nonce = random(12 bytes)` and `ciphertext = AES-256-GCM(plaintext, key=master.key, nonce, aad=line-number)`. (3) The AAD is the 1-indexed line number to prevent line-swap attacks. (4) Decryption reads the master key, iterates lines, decrypts with AAD. (5) `orca secrets set <ns> <key> <value>` appends an encrypted line; `orca secrets get <ns> <key>` decrypts and prints (redacted by default, `--reveal` to show). (6) The v0.8 `internal/security/redact.go` (103 LOC) is directly reusable for redaction. HKDF-SHA256 derives per-namespace sub-keys from the master key (`HKDF-SHA256(master, info=<ns>)`) so compromising one namespace's key doesn't compromise others — but the master key is the root of trust. **Gated by grill C-19** (threat model for master.key passphrase-less posture).
- **Rationale**: R-011 is precise about the crypto but §23 doesn't specify key derivation, AAD, or CLI surface. The existing `redact.go` and `WriteAtomic` are reusable.
- **Proposed REQ ID**: REQ-080
- **Proposed phase placement**: v1.0-P03 (secrets subsystem)
- **Proposed phase placement**: v0.10-P03 (secrets subsystem)
- **Confidence**: 0.84
- **Accept/Defer**: accept
@@ -234,10 +234,10 @@ the PRD §23 plan are listed at the end.
### I-B-012 — `orca job lint` category-driven lint engine design
- **Tier**: backend-enriched
- **Description**: v1.0-P11 requires `orca job lint` with `--explain`. Design: a `Linter` that takes a `*WorkloadSpec` and runs a series of `Rule` checks, each returning a `Finding{Category, Severity, Message, Explanation}`. Categories: `schema` (missing required fields), `runtime` (incompatible runtime+constraint), `security` (missing SVID, plaintext secret in env), `migration` (missing storage replication for a migratable service), `best-practice` (no health check on a Service). `--explain` prints the rationale for each finding. Rules are registered in a `ruleRegistry` and individually testable. The linter is pure (no I/O) — it checks the spec against static rules, not live cluster state (that's `orca job verify`, P12).
- **Description**: v0.10-P11 requires `orca job lint` with `--explain`. Design: a `Linter` that takes a `*WorkloadSpec` and runs a series of `Rule` checks, each returning a `Finding{Category, Severity, Message, Explanation}`. Categories: `schema` (missing required fields), `runtime` (incompatible runtime+constraint), `security` (missing SVID, plaintext secret in env), `migration` (missing storage replication for a migratable service), `best-practice` (no health check on a Service). `--explain` prints the rationale for each finding. Rules are registered in a `ruleRegistry` and individually testable. The linter is pure (no I/O) — it checks the spec against static rules, not live cluster state (that's `orca job verify`, P12).
- **Rationale**: §23 puts this in P11 but only says "category-driven." The rule interface and category taxonomy are unspecified.
- **Proposed REQ ID**: REQ-084
- **Proposed phase placement**: v1.0-P11 (orca job lint)
- **Proposed phase placement**: v0.10-P11 (orca job lint)
- **Confidence**: 0.78
- **Accept/Defer**: accept
@@ -245,28 +245,28 @@ the PRD §23 plan are listed at the end.
### I-C-001 — v0.8→v1.0 migration ordering: daemon deprecation vs. new model rollout
- **Tier**: cross-cutting
- **Description**: The PRD §24 covers *data* migration but not *binary/daemon* deprecation ordering. The risk: v0.9 builds the new Markdown+kinds+runtime+SSH-push model, but v0.8 daemons are still running on peers. If v0.9 ships the new `orca job run` (Markdown) while the old daemon is still the execution engine, there's a split-brain: new specs can't run on the old daemon. Ordering proposal: (1) v0.9 ships the new parser + kinds + runtime + SSH-push *alongside* the old daemon (dual-write window); (2) `orca job run` in v0.9 uses the new SSH-push path if the spec is `.md` and the old daemon path if `.hcl`; (3) v1.0-P05 (drain) stops the old daemons; (4) v1.0-P14 (migration) converts remaining `.hcl` specs to `.md` and removes the daemon. The dual-write window means v0.9 is *not* a clean break — it's a compatibility milestone. This must be explicit in the plan or the v0.9 phases will assume the daemon is gone.
- **Description**: The PRD §24 covers *data* migration but not *binary/daemon* deprecation ordering. The risk: v0.9 builds the new Markdown+kinds+runtime+SSH-push model, but v0.8 daemons are still running on peers. If v0.9 ships the new `orca job run` (Markdown) while the old daemon is still the execution engine, there's a split-brain: new specs can't run on the old daemon. Ordering proposal: (1) v0.9 ships the new parser + kinds + runtime + SSH-push *alongside* the old daemon (dual-write window); (2) `orca job run` in v0.9 uses the new SSH-push path if the spec is `.md` and the old daemon path if `.hcl`; (3) v0.10-P05 (drain) stops the old daemons; (4) v0.10-P14 (migration) converts remaining `.hcl` specs to `.md` and removes the daemon. The dual-write window means v0.9 is *not* a clean break — it's a compatibility milestone. This must be explicit in the plan or the v0.9 phases will assume the daemon is gone.
- **Rationale**: Single largest risk in the re-architecture. §23 implicitly assumes v0.9 builds the new model in isolation, but existing deployments have running daemons. Getting the ordering wrong means either (a) v0.9 can't be tested against real deployments, or (b) workloads are orphaned when the daemon is removed.
- **Proposed REQ ID**: REQ-085
- **Proposed phase placement**: spans v0.9-P00 through v1.0-P14 — the *ordering decision* must be made in v0.9-P00
- **Proposed phase placement**: spans v0.9-P00 through v0.10-P14 — the *ordering decision* must be made in v0.9-P00
- **Confidence**: 0.88
- **Accept/Defer**: accept (most important idea in this report)
### I-C-002 — "No orca on server" enforcement (doctor post-migration invariant check)
- **Tier**: cross-cutting
- **Description**: R-001 is an invariant: "no orca Go binary on any server." §23 v1.0-P14 says "post-invariant checks" but doesn't specify them. `orca doctor` must gain a `doctor no-orca-on-server` check that SSHs to each peer and verifies: (1) no `orca` binary in PATH (`ssh peer which orca` returns nothing), (2) no `orca` systemd service (`ssh peer systemctl list-units 'orca*'` returns empty), (3) no `orca` process (`ssh peer pgrep -x orca` returns empty), (4) no `/etc/orca/` directory. This check must run *after* v1.0-P05 (drain) and *before* v1.0-P16 (ship). The v0.8 `internal/proxmox/bootstrap.go` already has the SSH session infrastructure (`sessionRunner` seam) — directly reusable for the doctor check.
- **Description**: R-001 is an invariant: "no orca Go binary on any server." §23 v0.10-P14 says "post-invariant checks" but doesn't specify them. `orca doctor` must gain a `doctor no-orca-on-server` check that SSHs to each peer and verifies: (1) no `orca` binary in PATH (`ssh peer which orca` returns nothing), (2) no `orca` systemd service (`ssh peer systemctl list-units 'orca*'` returns empty), (3) no `orca` process (`ssh peer pgrep -x orca` returns empty), (4) no `/etc/orca/` directory. This check must run *after* v0.10-P05 (drain) and *before* v0.10-P16 (ship). The v0.8 `internal/proxmox/bootstrap.go` already has the SSH session infrastructure (`sessionRunner` seam) — directly reusable for the doctor check.
- **Rationale**: R-001 is a hard invariant but §23 doesn't enforce it post-migration. Without this check, a failed migration could leave orphaned daemons that cause split-brain.
- **Proposed REQ ID**: REQ-086
- **Proposed phase placement**: v1.0-P14c (mixed-version tolerance)
- **Proposed phase placement**: v0.10-P14c (mixed-version tolerance)
- **Confidence**: 0.82
- **Accept/Defer**: accept
### I-C-003 — Test infrastructure: hermetic 3-linux + 1-proxmox cluster pipeline
- **Tier**: cross-cutting
- **Description**: §23 v1.0-P08 requires "hermetic CoreCI integration pipeline." The PRD §26.E mentions 3 linux + 1 proxmox. This is net-new test infra with zero current implementation. Design: (1) a `test/integration/` directory with a `docker-compose.yml` or `vagrant` setup that creates 4 containers/VMs (3 linux + 1 proxmox-simulated); (2) a Go test harness that SSHes to each, runs the CLI, and asserts end-to-end workflows (namespace create → workload submit → migrate → drain); (3) the proxmox node is simulated via a mock `pct`/`qm` script (the v0.8 `proxmox` package already has a `sessionRunner` seam for testability — extend it). The integration tests run in CoreCI on every milestone merge. The v0.8 e2e tests (`bootstrapE2ESetup` in `bootstrap_test.go`) use an in-process SSH server — this is the foundation but needs to scale to 4 nodes.
- **Description**: §23 v0.10-P08 requires "hermetic CoreCI integration pipeline." The PRD §26.E mentions 3 linux + 1 proxmox. This is net-new test infra with zero current implementation. Design: (1) a `test/integration/` directory with a `docker-compose.yml` or `vagrant` setup that creates 4 containers/VMs (3 linux + 1 proxmox-simulated); (2) a Go test harness that SSHes to each, runs the CLI, and asserts end-to-end workflows (namespace create → workload submit → migrate → drain); (3) the proxmox node is simulated via a mock `pct`/`qm` script (the v0.8 `proxmox` package already has a `sessionRunner` seam for testability — extend it). The integration tests run in CoreCI on every milestone merge. The v0.8 e2e tests (`bootstrapE2ESetup` in `bootstrap_test.go`) use an in-process SSH server — this is the foundation but needs to scale to 4 nodes.
- **Rationale**: §23 assumes the infra exists but doesn't design it. devops-engineer persona should be reactivated. Without hermetic infra, the integration tests can't run in CI.
- **Proposed REQ ID**: REQ-087
- **Proposed phase placement**: v1.0-P08 (integration tests) — harness bootstrapped in v0.9-P00
- **Proposed phase placement**: v0.10-P08 (integration tests) — harness bootstrapped in v0.9-P00
- **Confidence**: 0.80
- **Accept/Defer**: accept
@@ -275,22 +275,22 @@ the PRD §23 plan are listed at the end.
- **Description**: The config.json has `security-engineer` and `network-engineer` dormant. The re-architecture introduces step-ca (PKI), Traefik (edge proxy), Syncthing (P2P file sync), wasmtime (sandbox), podman (container runtime) — all new attack surfaces. AD-010 (step-ca rejection) is reversed. The v0.8 security posture (internal CA, mTLS daemon-to-daemon) is replaced by (step-ca, SSH-push, Traefik mTLS). The security-engineer persona must be reactivated to review: (1) step-ca provisioner model (the CLI holds the provisioner password — is that in `cluster/master.key` or a separate secret?), (2) SSH-push blast radius (compromised CLI key = full cluster), (3) Traefik as the new edge (DoS, config injection), (4) `.env.secrets` crypto (I-B-008). The network-engineer persona must review: (1) socket-based service exposure (R-007), (2) Syncthing P2P ports, (3) Traefik routing. §23 doesn't mention persona reactivation.
- **Rationale**: config.json explicitly notes the re-architecture "should reactivate security-engineer and network-engineer." Cross-cutting review concern, not a single phase.
- **Proposed REQ ID**: REQ-088
- **Proposed phase placement**: spans v0.9 through v1.0 — reactivation in v0.9-P00, review at v1.0-P15.5 (threat model) and v1.0-P16 (final audit)
- **Proposed phase placement**: spans v0.9 through v0.10 — reactivation in v0.9-P00, review at v0.10-P15.5 (threat model) and v0.10-P16 (final audit)
- **Confidence**: 0.84
- **Accept/Defer**: accept
### I-C-005 — Documentation rewrite: ARCHITECTURE.md, PROJECT.md, README, AD-010 supersession
- **Tier**: cross-cutting
- **Description**: All three docs describe the OLD architecture. `ARCHITECTURE.md` (640 lines) describes the daemon layer, mTLS transport, internal CA, HCL jobspec — all deprecated. `PROJECT.md` (30k chars) has D-001..D-010 decisions, several now superseded. `README.md` has the v0.8 quickstart. AD-010 (step-ca rejection) must be explicitly superseded by D-101 with a dated rationale reversal. The anti-patterns section in `ARCHITECTURE.md:471-484` lists "No external PKI" — now reversed. Proposal: (1) in v0.9-P00, add a "v0.9 Architecture (Supersedes v0.8)" section to ARCHITECTURE.md with the new 4-layer model; (2) mark the old sections as "v0.8 (deprecated)" with banners; (3) add a "Superseded Decisions" table (AD-009, AD-010 reversed by D-101; AD-007 HCL demoted by R-013); (4) in v1.0-P15, rewrite README quickstart for the new `curl | sh` + `orca init` + `orca ns create` flow.
- **Description**: All three docs describe the OLD architecture. `ARCHITECTURE.md` (640 lines) describes the daemon layer, mTLS transport, internal CA, HCL jobspec — all deprecated. `PROJECT.md` (30k chars) has D-001..D-010 decisions, several now superseded. `README.md` has the v0.8 quickstart. AD-010 (step-ca rejection) must be explicitly superseded by D-101 with a dated rationale reversal. The anti-patterns section in `ARCHITECTURE.md:471-484` lists "No external PKI" — now reversed. Proposal: (1) in v0.9-P00, add a "v0.9 Architecture (Supersedes v0.8)" section to ARCHITECTURE.md with the new 4-layer model; (2) mark the old sections as "v0.8 (deprecated)" with banners; (3) add a "Superseded Decisions" table (AD-009, AD-010 reversed by D-101; AD-007 HCL demoted by R-013); (4) in v0.10-P15, rewrite README quickstart for the new `curl | sh` + `orca init` + `orca ns create` flow.
- **Rationale**: The docs are the first thing new contributors read. Leaving v0.8 docs as canonical during v0.9 development causes confusion. §23 mentions README in P15 but not ARCHITECTURE.md/PROJECT.md.
- **Proposed REQ ID**: REQ-089
- **Proposed phase placement**: v0.9-P00 (banners + supersession table) + v1.0-P15 (README quickstart) + v1.0-P16 (final review)
- **Proposed phase placement**: v0.9-P00 (banners + supersession table) + v0.10-P15 (README quickstart) + v0.10-P16 (final review)
- **Confidence**: 0.82
- **Accept/Defer**: accept
### I-C-006 — Dual-write window: can v0.9 ship new parser while old daemon runs?
- **Tier**: cross-cutting
- **Description**: Focused version of I-C-001. The specific question: in v0.9, when the new Markdown parser + kinds + SSH-push are shipped, can they coexist with v0.8 daemons still running on peers? The answer depends on whether `orca job run <spec.md>` uses the new SSH-push path (bypassing the daemon entirely) or routes through the old daemon. If it bypasses, the daemon is irrelevant for new specs but still serves old `.hcl` specs. If it routes through, the daemon can't handle `.md` specs. Proposal: v0.9 `orca job run` dispatches on extension (`.md`→SSH-push new path, `.hcl`→old daemon path) via the parser dispatcher (I-M-004). This is a *dual-write window* where both paths coexist. The daemon is not removed until v1.0-P05 (drain). The risk: if a `.md` workload and a `.hcl` workload target the same node, the SSH-push path writes systemd units directly while the daemon also manages units — they can conflict. Mitigation: the SSH-push path writes to a separate systemd unit namespace (`orca-v1-<alloc>.service`) while the daemon uses `orca-<job>.service`. No unit name overlap = no conflict.
- **Description**: Focused version of I-C-001. The specific question: in v0.9, when the new Markdown parser + kinds + SSH-push are shipped, can they coexist with v0.8 daemons still running on peers? The answer depends on whether `orca job run <spec.md>` uses the new SSH-push path (bypassing the daemon entirely) or routes through the old daemon. If it bypasses, the daemon is irrelevant for new specs but still serves old `.hcl` specs. If it routes through, the daemon can't handle `.md` specs. Proposal: v0.9 `orca job run` dispatches on extension (`.md`→SSH-push new path, `.hcl`→old daemon path) via the parser dispatcher (I-M-004). This is a *dual-write window* where both paths coexist. The daemon is not removed until v0.10-P05 (drain). The risk: if a `.md` workload and a `.hcl` workload target the same node, the SSH-push path writes systemd units directly while the daemon also manages units — they can conflict. Mitigation: the SSH-push path writes to a separate systemd unit namespace (`orca-v1-<alloc>.service`) while the daemon uses `orca-<job>.service`. No unit name overlap = no conflict.
- **Rationale**: Operational feasibility question for v0.9. §23 doesn't address it. If the answer is "no dual-write, daemon must be removed first," then v0.9 can't be tested incrementally and must ship as a big-bang — much higher risk.
- **Proposed REQ ID**: REQ-090
- **Proposed phase placement**: v0.9-P00 (decision before any v0.9 execution phase)
@@ -301,35 +301,35 @@ the PRD §23 plan are listed at the end.
| ID | Tier | Title | REQ | Phase | Conf | Accept |
|----|------|-------|-----|-------|------|--------|
| I-M-001 | M | `orca daemon` deprecation path | REQ-061 | v1.0-P14 (warn v0.9-P0X) | 0.82 | accept |
| I-M-001 | M | `orca daemon` deprecation path | REQ-061 | v0.10-P14 (warn v0.9-P0X) | 0.82 | accept |
| I-M-002 | M | Coverage follow-ups to 70% | REQ-062 | v0.9-P0X + each new pkg | 0.88 | accept |
| I-M-003 | M | known_hosts flock concurrency | REQ-063 | v0.9-P0a1 | 0.74 | accept |
| I-M-004 | M | HCL→Markdown jobspec adapter | REQ-064 | v0.9-P0b | 0.85 | accept |
| I-M-005 | M | `doctor --legacy-paths` detection | REQ-065 | v1.0-P14c | 0.80 | accept |
| I-M-006 | M | Legacy CA state migration to step-ca | REQ-066 | v1.0-P14a | 0.70 | accept |
| I-M-005 | M | `doctor --legacy-paths` detection | REQ-065 | v0.10-P14c | 0.80 | accept |
| I-M-006 | M | Legacy CA state migration to step-ca | REQ-066 | v0.10-P14a | 0.70 | accept |
| I-M-007 | M | Fuzz harness for Markdown parser | REQ-067 | v0.9-P0b | 0.78 | accept |
| I-M-008 | M | Deprecation warnings on CLI subcommands | REQ-068 | v0.9-P0X + v1.0-P13 | 0.72 | accept |
| I-M-008 | M | Deprecation warnings on CLI subcommands | REQ-068 | v0.9-P0X + v0.10-P13 | 0.72 | accept |
| I-M-009 | M | HCL config demotion via adapter | REQ-069 | v0.9-P0a1 | 0.76 | accept |
| I-M-010 | M | certpaths → multi-namespace path resolver | REQ-070 | v0.9-P0a1 | 0.84 | accept |
| I-M-011 | M | store schema: per-namespace DBs | REQ-071 | v0.9-P0a1 + v1.0-P06 | 0.80 | accept |
| I-M-012 | M | transport deletion + SSH-push package | REQ-072 | v0.9-P00 (delete v1.0-P14) | 0.68 | accept |
| I-M-011 | M | store schema: per-namespace DBs | REQ-071 | v0.9-P0a1 + v0.10-P06 | 0.80 | accept |
| I-M-012 | M | transport deletion + SSH-push package | REQ-072 | v0.9-P00 (delete v0.10-P14) | 0.68 | accept |
| I-B-001 | B | SSH-push transport layer design | REQ-073 | v0.9-P01 | 0.86 | accept |
| I-B-002 | B | Emitter template system (Layer 4) | REQ-074 | v0.9-P0c | 0.82 | accept |
| I-B-003 | B | Lead applier execution model | REQ-075 | v1.0-P10 (design v0.9-P00) | 0.78 | accept |
| I-B-004 | B | step-ca integration | REQ-076 | v0.9-P07 + v1.0-P02 | 0.74 | accept |
| I-B-003 | B | Lead applier execution model | REQ-075 | v0.10-P10 (design v0.9-P00) | 0.78 | accept |
| I-B-004 | B | step-ca integration | REQ-076 | v0.9-P07 + v0.10-P02 | 0.74 | accept |
| I-B-005 | B | Traefik dynamic config + atomic reload | REQ-077 | v0.9-P02 | 0.80 | accept |
| I-B-006 | B | Runtime abstraction (5 backends) | REQ-078 | v0.9-P07a/b/c | 0.82 | accept |
| I-B-007 | B | Transaction bundle + N-peer atomicity | REQ-079 | v1.0-P10 (design v0.9-P00) | 0.76 | accept |
| I-B-008 | B | Master key + HKDF per-line encryption | REQ-080 | v1.0-P03 | 0.84 | accept |
| I-B-007 | B | Transaction bundle + N-peer atomicity | REQ-079 | v0.10-P10 (design v0.9-P00) | 0.76 | accept |
| I-B-008 | B | Master key + HKDF per-line encryption | REQ-080 | v0.10-P03 | 0.84 | accept |
| I-B-009 | B | Syncthing config + folder-ID | REQ-081 | v0.9-P09 | 0.72 | accept |
| I-B-010 | B | Namespace inheritance resolver | REQ-082 | v0.9-P0a2 | 0.86 | accept |
| I-B-011 | B | CLI-side scheduler redesign | REQ-083 | v0.9-P05 (skeleton P0c) | 0.80 | accept |
| I-B-012 | B | `orca job lint` category-driven engine | REQ-084 | v1.0-P11 | 0.78 | accept |
| I-C-001 | C | v0.8→v1.0 migration ordering | REQ-085 | spans v0.9-P00→v1.0-P14 | 0.88 | accept |
| I-C-002 | C | "No orca on server" enforcement | REQ-086 | v1.0-P14c | 0.82 | accept |
| I-C-003 | C | Hermetic test infra (3 linux + 1 pve) | REQ-087 | v1.0-P08 (bootstrap v0.9-P00) | 0.80 | accept |
| I-C-004 | C | security/network persona reactivation | REQ-088 | spans v0.9→v1.0-P16 | 0.84 | accept |
| I-C-005 | C | Docs rewrite + AD-010 supersession | REQ-089 | v0.9-P00 + v1.0-P15/P16 | 0.82 | accept |
| I-B-012 | B | `orca job lint` category-driven engine | REQ-084 | v0.10-P11 | 0.78 | accept |
| I-C-001 | C | v0.8→v1.0 migration ordering | REQ-085 | spans v0.9-P00→v0.10-P14 | 0.88 | accept |
| I-C-002 | C | "No orca on server" enforcement | REQ-086 | v0.10-P14c | 0.82 | accept |
| I-C-003 | C | Hermetic test infra (3 linux + 1 pve) | REQ-087 | v0.10-P08 (bootstrap v0.9-P00) | 0.80 | accept |
| I-C-004 | C | security/network persona reactivation | REQ-088 | spans v0.9→v0.10-P16 | 0.84 | accept |
| I-C-005 | C | Docs rewrite + AD-010 supersession | REQ-089 | v0.9-P00 + v0.10-P15/P16 | 0.82 | accept |
| I-C-006 | C | Dual-write window decision | REQ-090 | v0.9-P00 | 0.86 | accept |
## Phase Reordering / Addition Flags (against PRD §23)
@@ -339,8 +339,8 @@ the PRD §23 plan are listed at the end.
3. **I-B-001 (SSH-push transport)** — §23 v0.9-P01 needs SSH-push. The design is a prerequisite. **Recommendation: SSH-push design in P0a1, not deferred to P01.**
4. **I-B-002 (emitter template system)** — should be designed *with* the schemas (P0c). **Recommendation: expand P0c to "schemas + emitter interface."**
5. **I-B-003 (lead applier model)** — bundle format + lead applier model must be designed *in v0.9* so the emitter can produce bundle-compatible output. **Recommendation: design spike in v0.9-P00.**
6. **I-C-003 (test infra)** — hermetic cluster harness should be bootstrapped in v0.9-P00 so every v0.9 phase can run integration tests. **Recommendation: bootstrap in v0.9-P00, expand in v1.0-P08.**
7. **I-C-004 / I-C-005 (persona reactivation + docs)** — span the whole milestone. **Recommendation: fold persona reviews into v0.9-P00 and v1.0-P16; fold doc banners into v0.9-P00.**
6. **I-C-003 (test infra)** — hermetic cluster harness should be bootstrapped in v0.9-P00 so every v0.9 phase can run integration tests. **Recommendation: bootstrap in v0.9-P00, expand in v0.10-P08.**
7. **I-C-004 / I-C-005 (persona reactivation + docs)** — span the whole milestone. **Recommendation: fold persona reviews into v0.9-P00 and v0.10-P16; fold doc banners into v0.9-P00.**
## Cross-Reference Against Existing Decisions
+7 -7
View File
@@ -1,8 +1,8 @@
# Orca — Comprehensive Product Requirements Document (v0.9/v1.0)
# Orca — Comprehensive Product Requirements Document (v0.9/v0.10)
**Audience:** Operators, AI agents, downstream tooling authors
> This PRD SUPERSEDES the shipped v0.1v0.8 architecture. The v0.9 and v1.0
> This PRD SUPERSEDES the shipped v0.1v0.8 architecture. The v0.9 and v0.10
> milestones implement a re-architecture whose load-bearing rules (R-001…R-016)
> and decisions (D-068…D-206) replace or demote several earlier documented
> decisions. See §22 decision-trace and the Supersession Table in
@@ -15,13 +15,13 @@
| Spec lock-in | ✅ R-001…R-016 + D-001…D-206 settled |
| v0.1v0.8 implementation | ✅ shipped (REQ-001..060, D-001..D-047) |
| v0.9 implementation | ⬜ Phase 0 pre-execution (this file is the spec input) |
| v1.0 implementation | ⬜ planning (post-PRD) |
| v0.10 implementation | ⬜ planning (post-PRD) |
| v1.x multi-host state | ⬜ parked (post-v1.0) |
| v2.x full Nomad-HCL | ⬜ parked (post-v1.x) |
## Override justification (recorded for the grill supersession)
The v0.9/v1.0 re-architecture is justified on six independent grounds rather
The v0.9/v0.10 re-architecture is justified on six independent grounds rather
than preference. Each reverses a prior documented decision; the new evidence
basis is recorded with the reversal in the Supersession Table:
@@ -54,7 +54,7 @@ that source; the substantive planning artifacts live in:
- `IDEATION_v0.9.md` — 30 ideas (REQ-061..REQ-090), three tiers
- `GRILL_v0.9.md` — 9-axis adversarial review, 19 binding conditions, 10 phase challenges
- `REQUIREMENTS.md` — REQ-061..REQ-090 appended
- `ROADMAP.md` — v0.9 (13 phases) + v1.0 (19 phases) appended
- `ROADMAP.md` — v0.9 (13 phases) + v0.10 (19 phases) appended
- `PERSONAS.md` — security/network/devops reactivated
- `ARCHITECTURE.md` — v0.9 banners + Supersession Table
@@ -70,7 +70,7 @@ that source; the substantive planning artifacts live in:
| R-006 | mTLS on by default; cluster CA = step-ca; Traefik + `LoadCredential=` are load-bearing. |
| R-007 | Sockets by default (`/run/orca/alloc-<id>/port-<name>.sock`); `127.0.0.1` opt-in. |
| R-008 | CLI results cached locally with per-class TTLs (`orca_cache` SQLite). |
| R-009 | CLI host SPOF mitigated by external shared state in v1.x; v1.0 ships the abstractions + cache layer. |
| R-009 | CLI host SPOF mitigated by external shared state in v1.x; v0.10 ships the abstractions + cache layer. |
| R-010 | Control plane updates are transactional (ArgoCD-style desired-state/lead-applier). |
| R-011 | Each namespace has `.env` (plaintext) and `.env.secrets` (AES-256-GCM, per-line nonce); master key per `ORCA_HOME` at `cluster/master.key`. |
| R-012 | Workload kinds are `Job`, `Service`, `DaemonSet`; schema-separated by `kind:` in frontmatter. |
@@ -84,7 +84,7 @@ that source; the substantive planning artifacts live in:
### v0.9 — Workloads + Re-architecture Foundation (13 phases)
P00 (deprecation sweep + migration-ordering + txn-design spike + test-infra bootstrap + persona reactivation + doc banners), P0a1 (path resolver + config demotion), P0a2 (namespace CRUD + inheritance), P0b (Markdown jobspec parser + fuzz), P0c (schemas + emitter interface), P01 (SSH-push transport + host-path volumes), P02 (service + Traefik emitter), P03 (update stanza), P04 (lifecycle hooks), P05 (constraints + CLI-side scheduler), P06 (task groups), P07a/P07b/P07c (process+podman / wasmtime [C-01 gated] / pve-vm+ct runtimes), P08 (sockets), P09 (Syncthing [C-02 gated]), P10 (lead rules + migration), P0X (ship + audit).
### v1.0 — Production Hardening (19 phases)
### v0.10 — Production Hardening (19 phases)
P00 (CLI cache), P01 (metrics), P01.5 (SPIFFE spike [C-08 gated]), P02 (ACL), P03 (secrets), P04 (backup/restore), P05 (drain + daemon drain-and-stop), P06 (alloc history), P07 (recovery), P08 (integration tests), P09 (collector+aggregator), P10 (transactional plane [C-09 gated]), P11 (job lint), P12 (job verify), P13 (ns subcommands), P14a/P14b/P14c (data / daemon cutover / mixed-version tolerance), P15 (README), P15.5 (threat model [C-19 gated]), P16 (final review + ship — v1.0.0 release).
See `ROADMAP.md` for the full reordered plan and `GRILL_v0.9.md` for the 19
+3 -2
View File
@@ -36,6 +36,7 @@ Build a lightweight system to manage and execute workloads across a set of nodes
| D-004 | Scheduling algorithm for v0.1? | **Single-node only (no scheduling)** | Multi-node scheduling is out of scope for v0.1. Tasks run on the node they're submitted to. | 0.90 |
| D-005 | CLI output format? | **Human-readable by default, `--json` flag for machine consumption** | Serves both humans and AI agents. | 0.95 |
| D-006 | Job/task definition format? | **HCL or YAML in `.hcl`/`.yaml` files** | Familiar to Nomad/HashiCorp users; simpler than JSON for humans. | 0.88 |
| D-186 | Bash scripts coverage gate: count toward Go gate or exempt? | **Exempt from Go coverage gate; compensating control: bats tests (C-15) + shellcheck + shfmt in CI; every script must have >=1 happy-path and >=1 failure-path bats test** | Bash is a different language surface from Go; the 70%/50% Go coverage gate (D-042/D-047) is Go-specific. Forcing bash into the Go gate would require a coverage tool that does not exist for bash. The compensating control (bats + shellcheck + shfmt) provides equivalent discipline. | 0.82 |
| D-007 | Authentication? | **mTLS for v0.1, token-based deferred** | mTLS is the most secure default. Tokens can be added later if needed. | 0.80 |
| D-008 | Container runtime? | **Direct process execution (no container runtime) for v0.1** | Avoids the Docker/container dependency. Pure process management. | 0.85 |
| D-009 | Configuration file location? | **`~/.orca/config.hcl` and `/etc/orca/orca.hcl`** | Standard XDG-style paths. | 0.90 |
@@ -380,7 +381,7 @@ within the `clarify_budget` (10):
---
# v0.9/v1.0 — Re-architecture Scope Summary (Supersedes v0.1v0.8 architecture)
# v0.9/v0.10 — Re-architecture Scope Summary (Supersedes v0.1v0.8 architecture)
v0.9 is the first DIRECTION-CHANGE milestone in the project's history.
It supersedes the shipped v0.1v0.8 architecture per the adopted PRD
@@ -439,7 +440,7 @@ are recorded in `REQUIREMENTS.md`. The reordered phase plan is in
| ID | Question | Decision | Rationale | Confidence |
|----|----------|----------|-----------|------------|
| D-101 | Cluster CA: internal Go CA (AD-010) or step-ca (external)? | **step-ca (apt-installed)** | Externally mandated per override ground 2; AD-010's "too heavyweight" rationale reversed. CLI wraps `step` CLI via SSH (no Go step-ca client library — keep zero-new-dep posture if possible, or add `github.com/smallstep/cli` as a dep). **Gated by C-07** (CA migration spec). | 0.74 |
| D-068 | Workload identity: internal X.509 CA or SPIFFE SVIDs? | **SPIFFE SVIDs minted at submit time via step-ca** | Multi-tenancy (override ground 3) requires per-workload identity model; SPIFFE is the standard. SPIFFE ID `spiffe://orca/ns/<ns>/job/<name>/alloc/<id>` as SAN. **Gated by C-08** (mint spike in v1.0-P01.5; fallback to mTLS identity if spike fails). | 0.72 |
| D-068 | Workload identity: internal X.509 CA or SPIFFE SVIDs? | **SPIFFE SVIDs minted at submit time via step-ca** | Multi-tenancy (override ground 3) requires per-workload identity model; SPIFFE is the standard. SPIFFE ID `spiffe://orca/ns/<ns>/job/<name>/alloc/<id>` as SAN. **Gated by C-08** (mint spike in v0.10-P01.5; fallback to mTLS identity if spike fails). | 0.72 |
| D-088 | Runtime: direct os/exec only (D-008) or multi-runtime? | **5 runtimes: wasm (wasmtime primary), podman, process, pve-vm, pve-ct** | WASM is the primary workload (override ground 4). `processRuntime` wraps existing `executor.go`; others are net-new. Split P07a/b/c per grill PC-10. **P07b gated by C-01** (wasmtime/CGO eval). | 0.82 |
| D-158 | Namespace model: single flat root or multi-namespace? | **Multi-namespace under ORCA_HOME (R-002)** | Hard multi-tenant product requirement (override ground 3). `_defaults/` implicit root; `cluster/` for cluster-wide; per-namespace `db/`, `.env`, `.env.secrets`, `jobs/`, `alloc/`, `ns.md`. No namespace column in SQLite. | 0.84 |
| D-179 | Jobspec format: HCL canonical (AD-007) or Markdown? | **Markdown with YAML frontmatter canonical (R-013); HCL legacy** | PRD §8 — Markdown + body preservation is the operator-facing format. HCL adapter (REQ-064) preserves `orca job run old-spec.hcl` during migration. | 0.85 |
+19 -19
View File
@@ -141,9 +141,9 @@ REQ-047..052 all complete.
| REQ-059 | `orca node key-reset <node>` command: clears the persisted SSH host key entry for the node from `~/.orca/known_hosts` only (local, not remote authorized_keys — D-046); audit-logs `event=node.key_reset`; next `doctor proxmox`/dispatch re-pins via TOFU or `--host-key-fingerprint` | Low | **v0.8 P2** | **Complete** (P2 shipped v0.7.2) |
| REQ-060 | Requirement-status hygiene sweep: REQUIREMENTS.md v0.7 rows were stale ("Pending" after ship); add a verify-stage assertion that every REQ listed as `Complete` in ROADMAP.md has a matching `Complete` row in REQUIREMENTS.md, enforced by `make verify-reqs` | Medium | **v0.8 P3** | **Complete** (P3 shipped v0.7.3) |
## v0.9/v1.0 Requirements — Re-architecture Foundation & Production Hardening
## v0.9/v0.10 Requirements — Re-architecture Foundation & Production Hardening
The v0.9/v1.0 milestones supersede the shipped v0.1v0.8 architecture per the
The v0.9/v0.10 milestones supersede the shipped v0.1v0.8 architecture per the
adopted PRD (`.ciagent/PRD_v0.9.md`). The re-architecture is justified on six
grounds recorded in the PROJECT.md Supersession Table. 30 net-new requirements
(REQ-061..REQ-090) derive from the v0.9 IDEATION; their phase placement and
@@ -152,33 +152,33 @@ and `GRILL_v0.9.md`.
| ID | Requirement | Priority | Phase | Status |
|----|-------------|----------|-------|--------|
| REQ-061 | `orca daemon` deprecation command and build-tag removal path: v0.9 emits deprecation warning + still runs (dual-write window); v1.0 repurposes to `orca daemon drain-and-stop` (stops v0.8 daemons on peers via SSH, confirms workloads survive via systemd); post-v1.0 the command and `internal/daemon/` are deleted. `// Deprecated` Go doc comments + `slog.Warn` on every run (I-M-001) | High | **v1.0 P14** (warn v0.9 P0X) | Pending |
| REQ-061 | `orca daemon` deprecation command and build-tag removal path: v0.9 emits deprecation warning + still runs (dual-write window); v1.0 repurposes to `orca daemon drain-and-stop` (stops v0.8 daemons on peers via SSH, confirms workloads survive via systemd); post-v1.0 the command and `internal/daemon/` are deleted. `// Deprecated` Go doc comments + `slog.Warn` on every run (I-M-001) | High | **v0.10 P14** (warn v0.9 P0X) | Pending |
| REQ-062 | Coverage follow-ups: 3 zero-test packages (`internal/audit`, `internal/certpaths`, `cmd/orca`) + `internal/cli` to 70% floor; once `daemon.go` is deprecated/removed the exclusion reason disappears and the floor applies to the whole package; all net-new subsystems carry a 70% floor from their first phase (I-M-002) | Medium | **v0.9 P0X** + each new pkg | Pending |
| REQ-063 | `known_hosts` flock concurrency gap (deferred P1 from REVIEW_v0.8 A2): add `flock`-style advisory lock (stdlib `syscall.Flock` wrapper) around the read-modify-write in `TOFUHostKeyCallback` capture path (`bootstrap.go:290-302`) and `ResetHostKey` (`bootstrap.go:479-523`); lock file at `cluster/known_hosts.lock` (R-002) (I-M-003) | Medium | **v0.9 P0a1** | Pending |
| REQ-064 | HCL→Markdown jobspec adapter/bridge layer: keep `internal/jobspec/spec.go` as legacy HCL path behind `// Deprecated`; add `internal/jobspec/markdown.go` (canonical) + `internal/jobspec/dispatch.go` (extension-based dispatcher: `.md`→Markdown, `.hcl`→legacy, `.yaml`→Markdown-with-empty-body); unified `*WorkloadSpec` populated via adapter; preserves `orca job run old-spec.hcl` during migration window (I-M-004) | High | **v0.9 P0b** | Pending |
| REQ-065 | `orca doctor --legacy-paths` detection: detects v0.8 residue (orca.db at ORCA_HOME root, ca.crt/ca.key, config.hcl, flat server.crt, namespace column in any *.db); outputs list of legacy artifacts with migration recommendations; the detection half of v1.0-P14 (I-M-005) | Medium | **v1.0 P14c** | Pending |
| REQ-066 | Legacy CA state migration to step-ca: `orca upgrade --to-v1.0 --import-ca` reads `~/.orca/ca.key`, initializes step-ca with it, re-issues workload SVIDs; preserves audit history even if live trust root changes (I-M-006). **Gated by C-07** | High | **v1.0 P14a** | Pending |
| REQ-065 | `orca doctor --legacy-paths` detection: detects v0.8 residue (orca.db at ORCA_HOME root, ca.crt/ca.key, config.hcl, flat server.crt, namespace column in any *.db); outputs list of legacy artifacts with migration recommendations; the detection half of v0.10-P14 (I-M-005) | Medium | **v0.10 P14c** | Pending |
| REQ-066 | Legacy CA state migration to step-ca: `orca upgrade --to-v1.0 --import-ca` reads `~/.orca/ca.key`, initializes step-ca with it, re-issues workload SVIDs; preserves audit history even if live trust root changes (I-M-006). **Gated by C-07** | High | **v0.10 P14a** | Pending |
| REQ-067 | Fuzz test harness for Markdown frontmatter parser: `testing.F` fuzz target in `internal/jobspec/markdown_test.go` round-trips random frontmatter+body through `ParseMarkdown` asserting byte-exact body preservation; corpus of adversarial fixtures (CRLF, BOM, no-frontmatter, empty-frontmatter, frontmatter-with-only-separator) (I-M-007) | Medium | **v0.9 P0b** | Pending |
| REQ-068 | Deprecation warnings on removed/repurposed CLI subcommands: each removed/changed command (`orca cert`, `orca node join` mTLS semantics, `orca job run <spec.hcl>`) emits `slog.Warn` deprecation banner with v1.0 replacement except under `orca upgrade`; `--no-deprecation-warnings` global flag via `root.go` `PersistentPreRunE` (I-M-008) | Low | **v0.9 P0X** + v1.0 P13 | Pending |
| REQ-068 | Deprecation warnings on removed/repurposed CLI subcommands: each removed/changed command (`orca cert`, `orca node join` mTLS semantics, `orca job run <spec.hcl>`) emits `slog.Warn` deprecation banner with v1.0 replacement except under `orca upgrade`; `--no-deprecation-warnings` global flag via `root.go` `PersistentPreRunE` (I-M-008) | Low | **v0.9 P0X** + v0.10 P13 | Pending |
| REQ-069 | `internal/config/config.go` HCL config demotion via adapter: keep `internal/config/` as `legacy_config.go` with `// Deprecated`; add `internal/config/markdown.go` for new Markdown-frontmatter loader (R-014); `root.go` dispatches on file extension (`.hcl`→legacy, `.md`→new); `--config` semantics: `.hcl` read-only legacy, `.md` canonical (I-M-009) | High | **v0.9 P0a1** | Pending |
| REQ-070 | `internal/certpaths/` replacement with multi-namespace path resolver: new `internal/paths` package with `paths.NamespaceDir(ns)`, `paths.ClusterDir()`, `paths.CacheDB()`, `paths.MasterKey()`, `paths.NSDb(ns)`, `paths.NSEnv(ns)`, `paths.NSSecrets(ns)`; keep `certpaths` as thin shim for v0.8 compat then remove post-v1.0 (R-002) (I-M-010) — highest blast radius | High | **v0.9 P0a1** | Pending |
| REQ-071 | `internal/store/` schema: per-namespace DBs, drop namespace column: `store.Open` gains namespace parameter (or caller passes `paths.NSDb(ns)`); `migrate.go` runs migrations per namespace DB; `cert_repo` (0004) removed (step-ca handles certs); audit_log moves to CLI-side cache DB (R-008) (I-M-011) | High | **v0.9 P0a1** + v1.0 P06 | Pending |
| REQ-072 | `internal/transport/` deletion + SSH-push package: delete `mtls.go`, `dispatch.go`, `handshake_log.go`; extract retry/idempotency patterns into `internal/sshpush/`; existing `transport.IdempotencyStore` directly reusable (I-M-012). Deletion deferred to v1.0-P14 to keep dual-write window open | High | **v0.9 P00** (delete v1.0 P14) | Pending |
| REQ-071 | `internal/store/` schema: per-namespace DBs, drop namespace column: `store.Open` gains namespace parameter (or caller passes `paths.NSDb(ns)`); `migrate.go` runs migrations per namespace DB; `cert_repo` (0004) removed (step-ca handles certs); audit_log moves to CLI-side cache DB (R-008) (I-M-011) | High | **v0.9 P0a1** + v0.10 P06 | Pending |
| REQ-072 | `internal/transport/` deletion + SSH-push package: delete `mtls.go`, `dispatch.go`, `handshake_log.go`; extract retry/idempotency patterns into `internal/sshpush/`; existing `transport.IdempotencyStore` directly reusable (I-M-012). Deletion deferred to v0.10-P14 to keep dual-write window open | High | **v0.9 P00** (delete v0.10 P14) | Pending |
| REQ-073 | SSH-push transport layer design: connection pooling (reuse `*ssh.Client` per peer), idempotency (content-addressed filenames), retry (exponential backoff 100ms×2 cap 5s max 5), timeout (30s SCP, 10s exec), fan-out (errgroup bounded concurrency default 8), known_hosts reuse `proxmox.TOFUHostKeyCallback` (I-B-001) | High | **v0.9 P01** (design P0a1) | Pending |
| REQ-074 | Emitter template system (Layer 4): `internal/emitter/` package with `Emitter` interface `Render(spec *WorkloadSpec, node *Node) ([]File, error)`; implementations systemdEmitter/traefikEmitter/syncthingEmitter/socketEmitter; SSH-push SCPs `[]File` atomically (write-to-tmp + rename); emitters registered per kind + runtime (I-B-002) | High | **v0.9 P0c** | Pending |
| REQ-075 | Lead applier execution model: CLI renders transaction bundle (tarball + apply.sh + verify.sh) on operator host, SCPs to lead's `/run/orca/txns/<txn-id>/`, lead's systemd timer runs `apply.sh` idempotently, CLI polls txn status via SSH; bash scripts generated by emitter not hand-written (I-B-003). **Gated by C-09** | High | **v1.0 P10** (design v0.9 P00) | Pending |
| REQ-076 | step-ca integration: `orca init` runs `step ca init` on lead; CLI SSHs to lead, installs step-ca via apt, stores step-ca.json; workload SVIDs via `step ca token` (JWE minted by CLI) → `step ca certificate`; SPIFFE ID as SAN; new `internal/stepca/` package wraps `step` CLI via SSH (I-B-004). Reverses AD-010 per override justification ground 2 | High | **v0.9 P07** + v1.0 P02 | Pending |
| REQ-075 | Lead applier execution model: CLI renders transaction bundle (tarball + apply.sh + verify.sh) on operator host, SCPs to lead's `/run/orca/txns/<txn-id>/`, lead's systemd timer runs `apply.sh` idempotently, CLI polls txn status via SSH; bash scripts generated by emitter not hand-written (I-B-003). **Gated by C-09** | High | **v0.10 P10** (design v0.9 P00) | Pending |
| REQ-076 | step-ca integration: `orca init` runs `step ca init` on lead; CLI SSHs to lead, installs step-ca via apt, stores step-ca.json; workload SVIDs via `step ca token` (JWE minted by CLI) → `step ca certificate`; SPIFFE ID as SAN; new `internal/stepca/` package wraps `step` CLI via SSH (I-B-004). Reverses AD-010 per override justification ground 2 | High | **v0.9 P07** + v0.10 P02 | Pending |
| REQ-077 | Traefik dynamic config generation + atomic reload: Traefik emitter renders `/etc/traefik/dynamic/orca-<ns>-<svc>.yaml` with backends (socket paths R-007), health checks, mTLS config pointing at step-ca root; atomic reload via tmpfile+fsync+rename triggering fsnotify; drain writes `weight=0` or removes backend (I-B-005). **Gated by C-10** | High | **v0.9 P02** | Pending |
| REQ-078 | Runtime abstraction interface (5 backends): `Runtime` interface in `internal/runtime/` with Prepare/Start/Stop/Status; processRuntime (wraps existing executor.go), wasmRuntime (wasmtime via SSH), podmanRuntime, pveVMRuntime (qm via proxmox SSH), pveCTRuntime (pct); runtimeRegistry keyed by `runtime:` frontmatter value; Alloc carries runtime field changeable on migration (I-B-006). Split P07a/b/c per PC-10. **P07b gated by C-01** | High | **v0.9 P07a/b/c** | Pending |
| REQ-079 | Transaction bundle format + N-peer atomicity: bundle = tarball with desired-state.json + apply.sh + verify.sh + rollback.sh + manifest.sig (signed with master.key); content-addressed `<txn-id>=sha256(desired-state.json)` stored in `cluster/txns/<txn-id>/`; lead applies to self first then fans out; failure on any peer runs rollback.sh on applied peers (I-B-007). **Gated by C-09** | High | **v1.0 P10** (design v0.9 P00) | Pending |
| REQ-080 | Master key management + HKDF-SHA256 per-line .env.secrets encryption: `cluster/master.key` 32-byte random (generated at `orca init` using WriteAtomic pattern); each line `base64(nonce||ciphertext||tag)`, nonce=random(12 bytes), AES-256-GCM with AAD=line-number (prevents line-swap); HKDF-SHA256 derives per-namespace sub-keys; `orca secrets set/get`; v0.8 `internal/security/redact.go` reusable (I-B-008). **Gated by C-19** | High | **v1.0 P03** | Pending |
| REQ-079 | Transaction bundle format + N-peer atomicity: bundle = tarball with desired-state.json + apply.sh + verify.sh + rollback.sh + manifest.sig (signed with master.key); content-addressed `<txn-id>=sha256(desired-state.json)` stored in `cluster/txns/<txn-id>/`; lead applies to self first then fans out; failure on any peer runs rollback.sh on applied peers (I-B-007). **Gated by C-09** | High | **v0.10 P10** (design v0.9 P00) | Pending |
| REQ-080 | Master key management + HKDF-SHA256 per-line .env.secrets encryption: `cluster/master.key` 32-byte random (generated at `orca init` using WriteAtomic pattern); each line `base64(nonce||ciphertext||tag)`, nonce=random(12 bytes), AES-256-GCM with AAD=line-number (prevents line-swap); HKDF-SHA256 derives per-namespace sub-keys; `orca secrets set/get`; v0.8 `internal/security/redact.go` reusable (I-B-008). **Gated by C-19** | High | **v0.10 P03** | Pending |
| REQ-081 | Syncthing config rendering + folder-ID content-addressing: per-namespace Syncthing folder `orca-<ns>` with content-addressed folder ID `sha256(ns + master-key-fingerprint)`; CLI renders config.xml per peer; Syncthing runs as systemd unit (emitted by systemd emitter); CLI discovers peers via `cluster/peers/`; migration works because new node joins folder and syncs before workload starts (I-B-009). **Gated by C-02 + C-14** | Medium | **v0.9 P09** (spike v0.9 P00) | Pending |
| REQ-082 | Namespace inheritance resolver algorithm: DFS parent walker with visited set for cycle detection; `_defaults/` implicit root (always exists, no parent); merge semantics: child overrides parent for scalars, arrays unioned (child adds to parent); pure function (no I/O) taking `map[nsName→*NSConfig]` returning `map[nsName→*ResolvedNS]` (I-B-010) | High | **v0.9 P0a2** | Pending |
| REQ-083 | CLI-side scheduler redesign: `Score(node, workload) (score int, fits bool)` where `fits` checks runtime compatibility + constraints, `score` is bin-packing (most free capacity = highest); Services pick `count` distinct nodes (anti-affinity default); DaemonSets pick all matching nodes; Job = one-shot; CLI-side not daemon-side (R-001) (I-B-011) | High | **v0.9 P05** (skeleton P0c) | Pending |
| REQ-084 | `orca job lint` category-driven lint engine: `Linter` runs `Rule` checks returning `Finding{Category, Severity, Message, Explanation}`; categories schema/runtime/security/migration/best-practice; `--explain` prints rationale; pure (no I/O) checks against static rules (I-B-012) | Medium | **v1.0 P11** | Pending |
| REQ-085 | v0.8→v1.0 migration ordering: v0.9 ships new parser + kinds + runtime + SSH-push alongside old daemon (dual-write window); `orca job run` dispatches on extension (`.md`→SSH-push, `.hcl`→old daemon); v1.0-P05 drains old daemons; v1.0-P14 converts remaining `.hcl` specs and removes daemon (I-C-001). **Most important cross-cutting idea** | High | **v0.9 P00** → v1.0 P14 | Pending |
| REQ-086 | "No orca on server" enforcement: `orca doctor no-orca-on-server` SSHs to each peer verifying no `orca` binary in PATH, no `orca` systemd service, no `orca` process, no `/etc/orca/` directory; runs after v1.0-P05 before v1.0-P16; reuses v0.8 `proxmox` SSH session infrastructure (I-C-002). Implements grill C-13 | High | **v1.0 P14c** | Pending |
| REQ-087 | Test infrastructure: hermetic 3-linux + 1-proxmox cluster pipeline: `test/integration/` with docker-compose/vagrant creating 4 containers/VMs; Go test harness SSHes to each, runs CLI, asserts end-to-end workflows (ns create → workload submit → migrate → drain); proxmox simulated via mock pct/qm; v0.8 e2e tests (bootstrapE2ESetup) are foundation (I-C-003) | Medium | **v1.0 P08** (bootstrap v0.9 P00) | Pending |
| REQ-088 | Security-engineer + network-engineer persona reactivation: reactivate security-engineer (step-ca provisioner model, SSH-push blast radius, Traefik edge, .env.secrets crypto) and network-engineer (socket exposure R-007, Syncthing P2P ports, Traefik routing); cross-cutting review not single phase (I-C-004). Implements grill C-05 | High | **v0.9 P00** → v1.0 P16 | Pending |
| REQ-089 | Documentation rewrite: ARCHITECTURE.md/PROJECT.md/README + AD-010 supersession: v0.9-P00 adds "v0.9 Architecture (Supersedes v0.8)" section + banners + Superseded Decisions table; v1.0-P15 rewrites README quickstart for new curl|sh + orca init + orca ns create flow (I-C-005) | Medium | **v0.9 P00** + v1.0 P15/P16 | Pending |
| REQ-090 | Dual-write window: v0.9 `orca job run` dispatches on extension (`.md`→SSH-push new path, `.hcl`→old daemon path) via parser dispatcher (REQ-064); daemon not removed until v1.0-P05; SSH-push path writes to separate systemd unit namespace (`orca-v1-<alloc>.service`) while daemon uses `orca-<job>.service` — no unit name overlap = no conflict (I-C-006) | High | **v0.9 P00** | Pending |
| REQ-084 | `orca job lint` category-driven lint engine: `Linter` runs `Rule` checks returning `Finding{Category, Severity, Message, Explanation}`; categories schema/runtime/security/migration/best-practice; `--explain` prints rationale; pure (no I/O) checks against static rules (I-B-012) | Medium | **v0.10 P11** | Pending |
| REQ-085 | v0.8→v1.0 migration ordering: v0.9 ships new parser + kinds + runtime + SSH-push alongside old daemon (dual-write window); `orca job run` dispatches on extension (`.md`→SSH-push, `.hcl`→old daemon); v0.10-P05 drains old daemons; v0.10-P14 converts remaining `.hcl` specs and removes daemon (I-C-001). **Most important cross-cutting idea** | High | **v0.9 P00** → v0.10 P14 | Pending |
| REQ-086 | "No orca on server" enforcement: `orca doctor no-orca-on-server` SSHs to each peer verifying no `orca` binary in PATH, no `orca` systemd service, no `orca` process, no `/etc/orca/` directory; runs after v0.10-P05 before v0.10-P16; reuses v0.8 `proxmox` SSH session infrastructure (I-C-002). Implements grill C-13 | High | **v0.10 P14c** | Pending |
| REQ-087 | Test infrastructure: hermetic 3-linux + 1-proxmox cluster pipeline: `test/integration/` with docker-compose/vagrant creating 4 containers/VMs; Go test harness SSHes to each, runs CLI, asserts end-to-end workflows (ns create → workload submit → migrate → drain); proxmox simulated via mock pct/qm; v0.8 e2e tests (bootstrapE2ESetup) are foundation (I-C-003) | Medium | **v0.10 P08** (bootstrap v0.9 P00) | Pending |
| REQ-088 | Security-engineer + network-engineer persona reactivation: reactivate security-engineer (step-ca provisioner model, SSH-push blast radius, Traefik edge, .env.secrets crypto) and network-engineer (socket exposure R-007, Syncthing P2P ports, Traefik routing); cross-cutting review not single phase (I-C-004). Implements grill C-05 | High | **v0.9 P00** → v0.10 P16 | Pending |
| REQ-089 | Documentation rewrite: ARCHITECTURE.md/PROJECT.md/README + AD-010 supersession: v0.9-P00 adds "v0.9 Architecture (Supersedes v0.8)" section + banners + Superseded Decisions table; v0.10-P15 rewrites README quickstart for new curl|sh + orca init + orca ns create flow (I-C-005) | Medium | **v0.9 P00** + v0.10 P15/P16 | Pending |
| REQ-090 | Dual-write window: v0.9 `orca job run` dispatches on extension (`.md`→SSH-push new path, `.hcl`→old daemon path) via parser dispatcher (REQ-064); daemon not removed until v0.10-P05; SSH-push path writes to separate systemd unit namespace (`orca-v1-<alloc>.service`) while daemon uses `orca-<job>.service` — no unit name overlap = no conflict (I-C-006) | High | **v0.9 P00** | Pending |
+9 -7
View File
@@ -252,7 +252,7 @@ HCL-canonical, single-namespace, no-container-runtime, no-SPIFFE). The
reversals are justified by the six-part evidence basis recorded in the
PROJECT.md Supersession Table.
## Milestone v1.0: Production Hardening
## Milestone v0.10: Production Hardening
**Scope**: ship a cluster that operators can run. Builds on the v0.9
re-architecture foundation with the production-grade subsystems:
@@ -282,13 +282,15 @@ the v0.8→v1.0 migration.
- [ ] Phase P14c: Mixed-version tolerance + no-orca-on-server enforcement (REQ-065, REQ-086; implements C-13) — tag `v0.9.18`
- [ ] Phase P15: README quickstart (REQ-089) — tag `v0.9.19`
- [ ] Phase P15.5: Threat model + security review (**gate C-19**) — tag `v0.9.20`
- [ ] Phase P16: Final review + ship + audit — **v1.0.0 release** — tag `v0.9.21`
- [ ] Phase P16: Final review + ship + audit — **v0.10.0 milestone release** — tag `v0.9.21` (v1.0.0 cut separately after UAT sign-off)
**Milestone tag**: `v1.0.0` (the v1.0.0 release tag is the production-ready cut;
per-phase patches run on the v0.9.x line per branch-strategy.md). Per-phase
**Milestone tag**: `v0.10.0` (the v0.10 milestone release tag; v1.0.0 is
UAT-gated and cut separately after v0.10 completion per operator decision —
the v1.0.0 tag marks production-ready sign-off, not a separate milestone).
Per-phase patches run on the v0.9.x line per branch-strategy.md. Per-phase
tags: `v0.9.0``v0.9.21`.
### Per-phase REQ coverage (v1.0)
### Per-phase REQ coverage (v0.10)
- **P00** — CLI cache (R-008)
- **P01.5** — SPIFFE spike (REQ-076; C-08)
@@ -310,9 +312,9 @@ tags: `v0.9.0`…`v0.9.21`.
- **wasmtime CGO breaks cross-compile** (mitigation: C-01 spike; fallback to podman/process primary)
- **bash control plane drift** (mitigation: C-15..C-18 render-format contract + bats gate)
- **daemon cutover orphans running allocs** (mitigation: P14b split; test adoption)
- **27→35+ phase scope** (mitigation: C-04 sizing; three-milestone split if exceeded — current count v0.9=18 + v1.0=22 = 40 phases; **C-04 sizing must run before v0.9 P00 execution to determine whether to split into v0.9+v0.10+v1.0**)
- **27→35+ phase scope** (mitigation: C-04 resolved — operator decision: keep 2 milestones v0.9 + v0.10, keep all phases, v1.0 is UAT-gated after v0.10; current count v0.9=18 + v0.10=22 = 40 phases, exceeds 35 soft limit but operator accepted)
## Deferred to v1.x (out of scope for v1.0)
## Deferred to v1.x (out of scope for v0.10)
- `sqlite-wal-shared` state backend (R-009 abstractions ship in v1.0; backend in v1.x)
- `git` state backend
+2
View File
@@ -0,0 +1,2 @@
disable=SC2086
external-sources=true
+23
View File
@@ -39,19 +39,42 @@ build:
test:
go test -coverprofile=coverage.out ./...
$(MAKE) test-bash
# test-race runs the full test suite under the race detector (REQ-031).
# Wired into the .coreci.yml `test` pipeline as well.
test-race:
go test -race -coverprofile=coverage.out ./...
$(MAKE) test-bash
lint:
gofmt -l .
go vet ./...
$(MAKE) lint-bash
fmt:
gofmt -w .
# test-bash runs bats tests for shell scripts (grill C-15). Skips gracefully
# if bats is not installed.
test-bash:
@command -v bats >/dev/null 2>&1 && { \
echo "→ bats scripts/tests/*.bash"; \
bats scripts/tests/*.bash; \
} || echo "bats not installed; skipping bash tests (see scripts/tests/README.md)"
# lint-bash runs shellcheck + shfmt on shell scripts (grill C-15). Skips
# gracefully if the tools are not installed.
lint-bash:
@command -v shellcheck >/dev/null 2>&1 && { \
echo "→ shellcheck scripts/"; \
shellcheck scripts/*.sh scripts/lib/*.sh scripts/tests/*.bash || true; \
} || echo "shellcheck not installed; skipping (see scripts/tests/README.md)"
@command -v shfmt >/dev/null 2>&1 && { \
echo "→ shfmt -d scripts/"; \
shfmt -d scripts/; \
} || echo "shfmt not installed; skipping (see scripts/tests/README.md)"
clean:
rm -rf bin coverage.out *.tar.gz
+15 -1
View File
@@ -42,6 +42,11 @@ func ServerCertPath() string { return certpaths.ServerCertPath() }
func ServerKeyPath() string { return certpaths.ServerKeyPath() }
// NewCommand builds the `orca cert` command tree.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). The `orca cert` command tree is retained for the
// dual-write window and scheduled for deletion in v0.10. See
// .ciagent/PRD_v0.9.md.
func NewCommand(log *slog.Logger) *cobra.Command {
if log == nil {
log = slog.Default()
@@ -49,7 +54,16 @@ func NewCommand(log *slog.Logger) *cobra.Command {
certCmd := &cobra.Command{
Use: "cert",
Short: "Manage orca certificates (CA, server, rotation)",
Long: "Bootstrap a local CA, generate server certs, and rotate them.",
Long: `Manage orca certificates (CA, server, rotation).
Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
(D-101/REQ-076). The ` + "`orca cert`" + ` command tree is retained for the
dual-write window and scheduled for deletion in v0.10. See
.ciagent/PRD_v0.9.md.`,
PersistentPreRunE: func(cmd *cobra.Command, args []string) error {
warnDeprecated("orca cert is deprecated in v0.9: step-ca (D-101) now handles CA; orca cert will be removed in v0.10 — see .ciagent/PRD_v0.9.md")
return nil
},
}
certCmd.AddCommand(newCAInitCmd(log))
+7 -3
View File
@@ -4,7 +4,6 @@ import (
"context"
"errors"
"fmt"
"log/slog"
"net/http"
"os"
"os/signal"
@@ -26,8 +25,14 @@ var (
var daemonCmd = &cobra.Command{
Use: "daemon",
Short: "Run the orca daemon (HTTP API + health checks)",
Long: "Start the orca daemon. Listens on the configured address for health, API, and dispatch requests.",
Long: `Start the orca daemon. Listens on the configured address for health, API, and dispatch requests.
Deprecated: v0.9 re-architecture replaces the orca daemon with SSH-push to
bare servers (R-001 — no orca binary on servers). The daemon is repurposed to
drain-and-stop in v0.10-P05 and scheduled for deletion in v0.10-P14. See
.ciagent/PRD_v0.9.md.`,
RunE: func(cmd *cobra.Command, args []string) error {
warnDeprecated("orca daemon is deprecated in v0.9 and will be repurposed to 'drain-and-stop' in v0.10-P05; the v0.9 re-architecture (R-001) removes the orca binary from servers — see .ciagent/PRD_v0.9.md")
db, closer, err := openDB()
if err != nil {
return err
@@ -97,5 +102,4 @@ func init() {
daemonCmd.Flags().StringVar(&daemonAddr, "addr", ":8080", "listen address")
daemonCmd.Flags().StringVar(&pprofAddr, "pprof", "", "enable pprof endpoint on <addr> (e.g. :6060); unauthenticated, operator-only")
rootCmd.AddCommand(daemonCmd)
_ = slog.Default // keep import if unused above
}
+221 -1
View File
@@ -1,6 +1,12 @@
package cli
import "testing"
import (
"bytes"
"context"
"log/slog"
"strings"
"testing"
)
func TestDaemonPprofFlag(t *testing.T) {
f := daemonCmd.Flags().Lookup("pprof")
@@ -11,3 +17,217 @@ func TestDaemonPprofFlag(t *testing.T) {
t.Errorf("--pprof default = %q, want empty", f.DefValue)
}
}
// captureSlog swaps slog.Default() for a text handler writing to buf,
// returning a buffer and a restore func. Tests use this to observe
// warnDeprecated output (which uses the package-level slog.Default).
func captureSlog(t *testing.T) (*bytes.Buffer, func()) {
t.Helper()
var buf bytes.Buffer
prev := slog.Default()
logger := slog.New(slog.NewTextHandler(&buf, &slog.HandlerOptions{Level: slog.LevelWarn}))
slog.SetDefault(logger)
return &buf, func() { slog.SetDefault(prev) }
}
// runDaemonHermetic invokes daemonCmd.RunE with a context that is
// already cancelled and an unbindable --addr, so the long-running
// server start short-circuits and RunE returns quickly without
// touching the network. It returns whatever RunE returned and the
// captured slog buffer.
func runDaemonHermetic(t *testing.T, suppressWarnings bool) (string, error) {
t.Helper()
_, cleanup := initTestEnv(t)
defer cleanup()
resetRootFlags(t)
buf, restore := captureSlog(t)
defer restore()
if suppressWarnings {
_ = rootCmd.PersistentFlags().Set("no-deprecation-warnings", "true")
}
daemonAddr = "127.0.0.1:99999" // unbindable: port outside uint16 range → ListenAndServe fails fast
ctx, cancel := context.WithCancel(context.Background())
cancel() // already-done context: the select returns via <-ctx.Done() immediately
cmd := daemonCmd
cmd.SetOut(&bytes.Buffer{})
cmd.SetErr(&bytes.Buffer{})
cmd.SetArgs(nil)
cmd.SetContext(ctx)
err := cmd.RunE(cmd, nil)
return buf.String(), err
}
// TestDaemonEmitsDeprecationWarning verifies REQ-068: `orca daemon`
// emits a slog.Warn deprecation banner on every run.
func TestDaemonEmitsDeprecationWarning(t *testing.T) {
out, _ := runDaemonHermetic(t, false)
if !strings.Contains(out, "orca daemon is deprecated in v0.9") {
t.Errorf("expected deprecation warning in slog output, got:\n%s", out)
}
if !strings.Contains(out, "R-001") {
t.Errorf("deprecation warning should reference R-001, got:\n%s", out)
}
}
// TestDaemonDeprecationWarningSuppressed verifies that
// --no-deprecation-warnings suppresses the deprecation banner (for
// `orca upgrade` migrations).
func TestDaemonDeprecationWarningSuppressed(t *testing.T) {
out, _ := runDaemonHermetic(t, true)
if strings.Contains(out, "deprecated in v0.9") {
t.Errorf("--no-deprecation-warnings should suppress the deprecation warning, got:\n%s", out)
}
}
// TestDaemonStillRuns verifies deprecation ≠ removal: the daemon
// command's RunE is still wired and callable. We don't assert on the
// error value (the hermetic short-circuit may return nil or a
// shutdown-related error), only that the command did not fail *because*
// of the deprecation notice.
func TestDaemonStillRuns(t *testing.T) {
_, err := runDaemonHermetic(t, false)
if err != nil && strings.Contains(err.Error(), "deprecated") {
t.Errorf("daemon must not error due to deprecation, got: %v", err)
}
}
// TestWarnDeprecatedGate verifies the package-level helper that gates
// deprecation warnings on the --no-deprecation-warnings flag.
func TestWarnDeprecatedGate(t *testing.T) {
t.Run("emits by default", func(t *testing.T) {
buf, restore := captureSlog(t)
defer restore()
noDeprecationWarnings = false
warnDeprecated("test-deprecation-marker")
if !strings.Contains(buf.String(), "test-deprecation-marker") {
t.Errorf("expected warning emitted, got: %s", buf.String())
}
})
t.Run("suppressed when flag set", func(t *testing.T) {
buf, restore := captureSlog(t)
defer restore()
noDeprecationWarnings = true
defer func() { noDeprecationWarnings = false }()
warnDeprecated("should-not-appear")
if strings.Contains(buf.String(), "should-not-appear") {
t.Errorf("expected no warning when --no-deprecation-warnings set, got: %s", buf.String())
}
})
}
// TestNoDeprecationWarningsFlagRegistered verifies the
// --no-deprecation-warnings persistent flag exists on rootCmd.
func TestNoDeprecationWarningsFlagRegistered(t *testing.T) {
f := rootCmd.PersistentFlags().Lookup("no-deprecation-warnings")
if f == nil {
t.Fatal("--no-deprecation-warnings persistent flag not registered on rootCmd")
}
if f.DefValue != "false" {
t.Errorf("--no-deprecation-warnings default = %q, want false", f.DefValue)
}
}
// TestCertEmitsDeprecationWarning verifies REQ-068: `orca cert`
// subcommands emit a deprecation banner.
func TestCertEmitsDeprecationWarning(t *testing.T) {
_, cleanup := initTestEnv(t)
defer cleanup()
resetRootFlags(t)
buf, restore := captureSlog(t)
defer restore()
var out bytes.Buffer
rootCmd.SetOut(&out)
rootCmd.SetErr(&out)
rootCmd.SetArgs([]string{"cert", "fingerprint", "--which", "ca"})
_ = rootCmd.Execute()
logged := buf.String()
if !strings.Contains(logged, "orca cert is deprecated in v0.9") {
t.Errorf("expected cert deprecation warning, got:\n%s", logged)
}
if !strings.Contains(logged, "step-ca") {
t.Errorf("deprecation warning should mention step-ca, got:\n%s", logged)
}
}
// TestCertDeprecationWarningSuppressed verifies --no-deprecation-warnings
// suppresses the cert deprecation banner.
func TestCertDeprecationWarningSuppressed(t *testing.T) {
_, cleanup := initTestEnv(t)
defer cleanup()
resetRootFlags(t)
_ = rootCmd.PersistentFlags().Set("no-deprecation-warnings", "true")
buf, restore := captureSlog(t)
defer restore()
var out bytes.Buffer
rootCmd.SetOut(&out)
rootCmd.SetErr(&out)
rootCmd.SetArgs([]string{"cert", "fingerprint", "--which", "ca"})
_ = rootCmd.Execute()
if strings.Contains(buf.String(), "orca cert is deprecated") {
t.Errorf("--no-deprecation-warnings should suppress cert warning, got:\n%s", buf.String())
}
}
// TestNodeJoinMTLSEmitsDeprecationWarning verifies REQ-068: the mTLS
// join path (`orca node join` without --type proxmox) warns that the
// mTLS join path is deprecated.
func TestNodeJoinMTLSEmitsDeprecationWarning(t *testing.T) {
_, cleanup := initTestEnv(t)
defer cleanup()
resetRootFlags(t)
buf, restore := captureSlog(t)
defer restore()
var out bytes.Buffer
rootCmd.SetOut(&out)
rootCmd.SetErr(&out)
rootCmd.SetArgs([]string{"node", "join", "--name", "dep-warning", "--addr", "10.0.0.55:8443"})
if err := rootCmd.Execute(); err != nil {
t.Fatalf("node join: %v", err)
}
logged := buf.String()
if !strings.Contains(logged, "mTLS join path is deprecated") {
t.Errorf("expected mTLS join deprecation warning, got:\n%s", logged)
}
if !strings.Contains(logged, "R-001") {
t.Errorf("deprecation warning should reference R-001, got:\n%s", logged)
}
}
// TestNodeJoinProxmoxNoMTLSDeprecationWarning verifies the deprecation
// warning does NOT fire for the proxmox SSH path (that path is the
// v0.9 replacement, not the deprecated mTLS path).
func TestNodeJoinProxmoxNoMTLSDeprecationWarning(t *testing.T) {
_, cleanup := initTestEnv(t)
defer cleanup()
resetRootFlags(t)
buf, restore := captureSlog(t)
defer restore()
var out bytes.Buffer
rootCmd.SetOut(&out)
rootCmd.SetErr(&out)
// proxmox path errors on missing --host before reaching the warning,
// and never calls joinLocal, so no mTLS deprecation warning fires.
rootCmd.SetArgs([]string{"node", "join", "--type", "proxmox", "--password", "x"})
_ = rootCmd.Execute()
if strings.Contains(buf.String(), "mTLS join path is deprecated") {
t.Errorf("proxmox path must not emit mTLS deprecation warning, got:\n%s", buf.String())
}
}
+1
View File
@@ -18,6 +18,7 @@ func resetRootFlags(t *testing.T) {
rootCmd.SetErr(&buf)
_ = rootCmd.PersistentFlags().Set("system", "false")
_ = rootCmd.PersistentFlags().Set("json", "false")
_ = rootCmd.PersistentFlags().Set("no-deprecation-warnings", "false")
resetCommandFlags()
}
+6
View File
@@ -89,7 +89,13 @@ Node types (via --type):
// joinLocal is the existing localhost/Linux node join flow (fingerprint
// check + registry.Insert).
//
// Deprecated: v0.9 re-architecture replaces daemon-to-daemon mTLS join
// with SSH-push bootstrap (R-001). The mTLS join path is retained for
// the dual-write window and scheduled for deletion in v0.10-P14. See
// .ciagent/PRD_v0.9.md.
func joinLocal(cmd *cobra.Command) error {
warnDeprecated("orca node join (mTLS path): v0.9 R-001 replaces daemon-to-daemon mTLS join with SSH-push bootstrap; the mTLS join path is deprecated — see .ciagent/PRD_v0.9.md")
if joinName == "" {
return fmt.Errorf("--name is required")
}
+16 -3
View File
@@ -4,6 +4,7 @@ import (
"context"
"encoding/json"
"fmt"
"log/slog"
"os"
"github.com/spf13/cobra"
@@ -50,15 +51,27 @@ over feature richness.`,
}
var (
jsonOutput bool
systemNamespace bool
configPath string
jsonOutput bool
systemNamespace bool
configPath string
noDeprecationWarnings bool
)
func init() {
rootCmd.PersistentFlags().BoolVar(&jsonOutput, "json", false, "output in JSON format")
rootCmd.PersistentFlags().BoolVar(&systemNamespace, "system", false, "use system-level namespace root (/root/.orca) instead of user-level (~/.orca)")
rootCmd.PersistentFlags().StringVar(&configPath, "config", "", "path to config.hcl (overrides ~/.orca/config.hcl)")
rootCmd.PersistentFlags().BoolVar(&noDeprecationWarnings, "no-deprecation-warnings", false, "suppress v0.9 deprecation warnings (use during `orca upgrade` migrations)")
}
// warnDeprecated emits a v0.9 deprecation warning via slog.Warn unless
// the --no-deprecation-warnings global flag is set. Callers pass a
// human-readable message describing what changed. REQ-068.
func warnDeprecated(msg string) {
if noDeprecationWarnings {
return
}
slog.Warn(msg)
}
func configFromCtx(ctx context.Context) *config.Config {
+6
View File
@@ -9,6 +9,12 @@
// - structured JSON via writeJSON
// - no secrets in logs
// - input validation on path/query/body
//
// Deprecated: v0.9 re-architecture replaces this with SSH-push to bare
// servers (no orca binary on servers) per R-001. The orca daemon is
// repurposed to drain-and-stop in v0.10-P05 and scheduled for deletion
// in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006. The dual-write
// window (REQ-090/REQ-085) keeps this package compiling until v0.10-P14.
package daemon
import (
+80
View File
@@ -0,0 +1,80 @@
// Package emit defines the render-format contract between Go-side emitters
// and bash-side appliers (grill C-16). Every rendered artifact is a JSON
// object with a versioned schema; both sides validate against it to prevent
// emitter/applier drift.
package emit
import (
"encoding/json"
"errors"
"fmt"
)
// SchemaVersion is the canonical versioned schema identifier for render
// contracts. Bump the suffix when the contract shape changes.
const SchemaVersion = "orca.emit/v1"
// Kind enumerates the rendered-artifact kinds. Each maps to an emitter
// implementation and a matching bash-side applier.
type Kind string
const (
KindSystemd Kind = "systemd"
KindTraefik Kind = "traefik"
KindSyncthing Kind = "syncthing"
KindSudoers Kind = "sudoers"
KindSSHD Kind = "sshd"
KindEnvFile Kind = "envfile"
KindCredential Kind = "credential"
)
// Artifact is a single rendered file destined for a peer. The bash-side
// applier reads this JSON and writes Content to Path with the given Mode.
type Artifact struct {
SchemaVersion string `json:"schema_version"`
Kind Kind `json:"kind"`
Path string `json:"path"`
Content string `json:"content"`
Mode string `json:"mode"`
}
// Validate checks that an Artifact conforms to the render contract.
// Returns a structured error if any field is missing or invalid.
func (a *Artifact) Validate() error {
if a.SchemaVersion != SchemaVersion {
return fmt.Errorf("emit: schema_version mismatch: got %q want %q", a.SchemaVersion, SchemaVersion)
}
if a.Kind == "" {
return errors.New("emit: kind is required")
}
if a.Path == "" {
return errors.New("emit: path is required")
}
if a.Mode == "" {
return errors.New("emit: mode is required")
}
return nil
}
// Marshal serializes an Artifact to JSON for transport to the bash applier.
func (a *Artifact) Marshal() ([]byte, error) {
if err := a.Validate(); err != nil {
return nil, err
}
return json.Marshal(a)
}
// UnmarshalArtifact parses a JSON byte slice into an Artifact and validates
// it against the contract. The bash-side applier (via orca-verify-render.sh)
// uses this same validation; the bash side rejects unparseable input with a
// structured error, never silently (grill C-16).
func UnmarshalArtifact(data []byte) (*Artifact, error) {
var a Artifact
if err := json.Unmarshal(data, &a); err != nil {
return nil, fmt.Errorf("emit: unmarshal: %w", err)
}
if err := a.Validate(); err != nil {
return nil, err
}
return &a, nil
}
+120
View File
@@ -0,0 +1,120 @@
package emit
import (
"encoding/json"
"strings"
"testing"
)
func TestArtifactValidate_valid(t *testing.T) {
a := &Artifact{
SchemaVersion: SchemaVersion,
Kind: KindSystemd,
Path: "/etc/systemd/system/orca-alloc.service",
Content: "[Service]\nExecStart=/bin/true\n",
Mode: "0644",
}
if err := a.Validate(); err != nil {
t.Fatalf("expected valid, got %v", err)
}
}
func TestArtifactValidate_schemaVersionMismatch(t *testing.T) {
a := &Artifact{SchemaVersion: "orca.emit/v0", Kind: KindSystemd, Path: "/x", Mode: "0644"}
err := a.Validate()
if err == nil {
t.Fatal("expected error for mismatched schema_version")
}
if !strings.Contains(err.Error(), "schema_version mismatch") {
t.Fatalf("expected schema_version error, got %v", err)
}
}
func TestArtifactValidate_missingKind(t *testing.T) {
a := &Artifact{SchemaVersion: SchemaVersion, Path: "/x", Mode: "0644"}
err := a.Validate()
if err == nil || !strings.Contains(err.Error(), "kind is required") {
t.Fatalf("expected kind-required error, got %v", err)
}
}
func TestArtifactValidate_missingPath(t *testing.T) {
a := &Artifact{SchemaVersion: SchemaVersion, Kind: KindTraefik, Mode: "0644"}
err := a.Validate()
if err == nil || !strings.Contains(err.Error(), "path is required") {
t.Fatalf("expected path-required error, got %v", err)
}
}
func TestArtifactValidate_missingMode(t *testing.T) {
a := &Artifact{SchemaVersion: SchemaVersion, Kind: KindSudoers, Path: "/x"}
err := a.Validate()
if err == nil || !strings.Contains(err.Error(), "mode is required") {
t.Fatalf("expected mode-required error, got %v", err)
}
}
func TestMarshalValidate_rejectsInvalid(t *testing.T) {
a := &Artifact{SchemaVersion: "bad", Kind: "", Path: "", Mode: ""}
if _, err := a.Marshal(); err == nil {
t.Fatal("expected Marshal to reject invalid artifact")
}
}
func TestUnmarshalArtifact_valid(t *testing.T) {
raw := `{"schema_version":"orca.emit/v1","kind":"systemd","path":"/x","content":"c","mode":"0644"}`
a, err := UnmarshalArtifact([]byte(raw))
if err != nil {
t.Fatalf("expected valid, got %v", err)
}
if a.Kind != KindSystemd {
t.Fatalf("expected kind systemd, got %s", a.Kind)
}
}
func TestUnmarshalArtifact_rejectsBadJSON(t *testing.T) {
if _, err := UnmarshalArtifact([]byte("not json")); err == nil {
t.Fatal("expected error for bad JSON")
}
}
func TestUnmarshalArtifact_rejectsSchemaMismatch(t *testing.T) {
raw := `{"schema_version":"orca.emit/v2","kind":"x","path":"/x","mode":"0644"}`
if _, err := UnmarshalArtifact([]byte(raw)); err == nil {
t.Fatal("expected error for schema mismatch")
}
}
func TestRoundTrip(t *testing.T) {
orig := &Artifact{
SchemaVersion: SchemaVersion,
Kind: KindSyncthing,
Path: "/etc/syncthing/config.xml",
Content: "<config/>",
Mode: "0600",
}
data, err := orig.Marshal()
if err != nil {
t.Fatalf("Marshal: %v", err)
}
back, err := UnmarshalArtifact(data)
if err != nil {
t.Fatalf("Unmarshal: %v", err)
}
if back.Path != orig.Path || back.Kind != orig.Kind || back.Mode != orig.Mode {
t.Fatalf("round-trip mismatch: %+v vs %+v", orig, back)
}
}
func TestAllKinds(t *testing.T) {
for _, k := range []Kind{KindSystemd, KindTraefik, KindSyncthing, KindSudoers, KindSSHD, KindEnvFile, KindCredential} {
a := &Artifact{SchemaVersion: SchemaVersion, Kind: k, Path: "/x", Mode: "0644"}
if err := a.Validate(); err != nil {
t.Errorf("kind %s: %v", k, err)
}
// verify it marshals
if _, err := json.Marshal(a); err != nil {
t.Errorf("marshal kind %s: %v", k, err)
}
}
}
+5
View File
@@ -25,6 +25,11 @@ import (
)
// Dispatcher is the public surface; constructed via NewDispatcher.
//
// Deprecated: v0.9 re-architecture replaces peer dispatch with a CLI-side
// scheduler + SSH-push (no orca binary on servers per R-001). The
// Dispatcher is retained for the dual-write window and scheduled for
// deletion in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
type Dispatcher struct {
log *slog.Logger
capacity *store.CapacityRepo
+10
View File
@@ -16,6 +16,11 @@ import (
)
// Peer is a remote orca node reachable over mTLS.
//
// Deprecated: v0.9 re-architecture replaces peer dispatch with a CLI-side
// scheduler + SSH-push (no orca binary on servers per R-001). The Peer
// type is retained for the dual-write window and scheduled for deletion
// in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
type Peer struct {
NodeID string
Address string // host:port (the peer's daemon listener)
@@ -27,6 +32,11 @@ type Peer struct {
// PeerRegistry tracks known peers. Methods are safe for concurrent
// use; the underlying map is guarded by a sync.RWMutex.
//
// Deprecated: v0.9 re-architecture replaces peer dispatch with a CLI-side
// scheduler + SSH-push (no orca binary on servers per R-001). The
// PeerRegistry is retained for the dual-write window and scheduled for
// deletion in v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
type PeerRegistry struct {
mu sync.RWMutex
peers map[string]*Peer
+48
View File
@@ -16,27 +16,51 @@ import (
// CAValidity is how long a CA cert is valid. Per D-013, the CA is long-lived
// (10 years) because manual rotation is expensive.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). This constant is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
const CAValidity = 10 * 365 * 24 * time.Hour
// ServerCertValidity is the default validity window for server certs. D-013
// says server certs are short-lived (90 days) to limit the compromise window.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). This constant is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
const ServerCertValidity = 90 * 24 * time.Hour
// CAKeySize is the RSA key size used for both CA and server certs. 3072 is
// the minimum we accept for v0.2 — matches REQ-033 spirit and Go's stdlib
// defaults for new RSA keys are typically 2048 or 4096. 3072 is the
// sweet spot for balance of safety and key-gen latency.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). This constant is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
const CAKeySize = 3072
// CAMode is the file mode used when persisting the CA private key. REQ-033
// requires 0600.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). This constant is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
const CAMode os.FileMode = 0o600
// CACPEMMode is the file mode used when persisting the CA public cert.
// REQ-033 requires 0644 (public, but still mode-pinned).
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). This constant is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
const CACPEMMode os.FileMode = 0o644
// File names used inside the CA directory.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). These constants are retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
const (
CACertFile = "ca.crt"
CAKeyFile = "ca.key"
@@ -44,6 +68,10 @@ const (
// CA wraps a loaded CA. Use CAInit to mint a new one, LoadCA to read an
// existing one from disk.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). The CA type is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
type CA struct {
Cert *x509.Certificate
Key *rsa.PrivateKey
@@ -60,6 +88,10 @@ type CA struct {
// commonName is the CA's CommonName (typically an org/cluster identifier).
// Returns a *CA wrapping the loaded cert + key. The CA is valid for
// CAValidity from now.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). CAInit is retained for the dual-write window and scheduled
// for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
func CAInit(dir, commonName string) (*CA, error) {
if dir == "" {
return nil, errors.New("CAInit: dir is required")
@@ -133,6 +165,10 @@ func CAInit(dir, commonName string) (*CA, error) {
// LoadCA reads a previously-initialized CA from disk. Returns a *CA or an
// error. Verifies file modes (REQ-033).
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). LoadCA is retained for the dual-write window and scheduled
// for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
func LoadCA(dir string) (*CA, error) {
if dir == "" {
return nil, errors.New("LoadCA: dir is required")
@@ -187,6 +223,10 @@ func LoadCA(dir string) (*CA, error) {
// EnforceFileModes refuses to operate if ca.crt / ca.key do not have the
// required modes (REQ-033). Returns nil on success. Callers (daemon start,
// CA loaders) MUST call this and abort on error.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). EnforceFileModes is retained for the dual-write window
// and scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
func EnforceFileModes(dir string) error {
certPath := filepath.Join(dir, CACertFile)
keyPath := filepath.Join(dir, CAKeyFile)
@@ -217,6 +257,10 @@ func EnforceFileModes(dir string) error {
// in PEM form. The resulting cert is valid for ServerCertValidity and
// inherits the SANs from the CSR (DNS, IP). If the CSR has no SANs, the
// call fails — REQ-036 requires server certs to have identifying SANs.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). SignCSR is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
func (c *CA) SignCSR(csrPEM []byte) ([]byte, error) {
if c == nil || c.Cert == nil || c.Key == nil {
return nil, errors.New("SignCSR: nil CA")
@@ -266,6 +310,10 @@ func (c *CA) SignCSR(csrPEM []byte) ([]byte, error) {
// Fingerprint returns the SHA-256 hex fingerprint of the CA cert. Useful
// for the operator to communicate to peers out-of-band; peers then pin
// this value at `orca node join --ca-fingerprint <sha>`.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). CA.Fingerprint is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
func (c *CA) Fingerprint() string {
return FingerprintOf(c.Cert.Raw)
}
+4
View File
@@ -21,6 +21,10 @@ import (
// Validation: dns entries must be syntactically valid hostnames; ip entries
// must be parseable by net.ParseIP. Bad inputs are rejected up-front so
// the operator gets a clear error before signing.
//
// Deprecated: v0.9 re-architecture replaces the internal CA with step-ca
// (D-101/REQ-076). GenerateCSR is retained for the dual-write window and
// scheduled for deletion in v0.10-P14. See .ciagent/PRD_v0.9.md.
func GenerateCSR(commonName string, sans []string) (keyPEM, csrPEM []byte, err error) {
if commonName == "" {
return nil, nil, errors.New("GenerateCSR: commonName is required")
+6
View File
@@ -6,6 +6,12 @@
// gRPC, no ConnectRPC, no third-party transport libraries. This keeps
// the binary lean (matches the minimalist pillar) and the trust chain
// auditable (one library: the Go stdlib).
//
// Deprecated: v0.9 re-architecture replaces this with
// internal/sshpush (REQ-073). The daemon-to-daemon mTLS transport is
// removed because servers no longer run the orca binary (R-001); the
// CLI pushes config via SSH instead. Scheduled for deletion in
// v0.10-P14. See .ciagent/PRD_v0.9.md R-001/R-006.
package transport
import (
+32
View File
@@ -0,0 +1,32 @@
# orca-log.sh — structured slog-compatible JSON logging for bash scripts (C-17).
# Source this library from any orca bash script: `source scripts/lib/orca-log.sh`.
# Emits JSON to syslog via `logger`; falls back to stderr if `logger` is missing.
# Field set matches the Go audit log (REQ-006): ts, level, actor, action, resource, result, error.
ORCA_LOG_ACTOR="${ORCA_LOG_ACTOR:-spiffe://orca/cli/operator}"
# _orca_log_emit <level> <action> <resource> <result> [error]
_orca_log_emit() {
local level="$1" action="$2" resource="$3" result="$4" error="${5:-}"
local ts
ts="$(date -u +%Y-%m-%dT%H:%M:%S.%3NZ)"
# Build JSON with proper escaping of error field (escape backslash and quote).
local err_json=""
if [ -n "$error" ]; then
local esc_error
esc_error="${error//\\/\\\\}"
esc_error="${esc_error//\"/\\\"}"
err_json=",\"error\":\"$esc_error\""
fi
local line
line="{\"ts\":\"$ts\",\"level\":\"$level\",\"actor\":\"$ORCA_LOG_ACTOR\",\"action\":\"$action\",\"resource\":\"$resource\",\"result\":\"$result\"$err_json}"
if command -v logger >/dev/null 2>&1; then
logger -t orca "$line"
else
echo "$line" >&2
fi
}
orca_log_info() { _orca_log_emit "info" "$1" "$2" "$3" "${4:-}"; }
orca_log_warn() { _orca_log_emit "warn" "$1" "$2" "$3" "${4:-}"; }
orca_log_error() { _orca_log_emit "error" "$1" "$2" "$3" "${4:-}"; }
+76
View File
@@ -0,0 +1,76 @@
#!/usr/bin/env bash
# orca-verify-render.sh — bash-side render-contract validator (grill C-16).
# Reads a render-bundle JSON file (one Artifact per line, or a JSON array)
# and validates each entry against the orca.emit/v1 schema.
# Exit 0 if all valid; non-zero with a structured error per failure to stderr.
# Source: scripts/lib/orca-log.sh for structured error logging (C-17).
#
# Usage: orca-verify-render.sh <bundle.json>
set -euo pipefail
SCRIPT_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")" && pwd)"
# shellcheck source=lib/orca-log.sh
. "$SCRIPT_DIR/lib/orca-log.sh"
EXPECTED_SCHEMA="orca.emit/v1"
if [ "$#" -lt 1 ]; then
orca_log_error "verify-render" "-" "failed" "missing bundle argument"
echo "usage: $0 <bundle.json>" >&2
exit 2
fi
bundle="$1"
if [ ! -f "$bundle" ]; then
orca_log_error "verify-render" "$bundle" "failed" "bundle file not found"
echo "error: bundle not found: $bundle" >&2
exit 2
fi
errors=0
total=0
# Read the bundle line-by-line. Each line should be a JSON object.
# (The Go emitter writes one Artifact per line for line-delimited parsing.)
while IFS= read -r line; do
# Skip blank lines and comments.
[ -z "$line" ] && continue
case "$line" in \#*) continue ;; esac
total=$((total + 1))
# Validate schema_version field presence and value (crude JSON grep; no jq dep).
# Check schema_version via a simple substring test.
schema_match=0
if printf '%s' "$line" | grep -q "\"schema_version\":\"$EXPECTED_SCHEMA\""; then
schema_match=1
fi
if [ "$schema_match" -eq 1 ]; then
# schema_version matches. Check kind, path, mode presence.
for field in kind path mode; do
if ! printf '%s' "$line" | grep -q "\"$field\":"; then
orca_log_error "verify-render" "$bundle" "failed" "missing field: $field"
echo "error: line $total missing field: $field" >&2
errors=$((errors + 1))
continue 2
fi
done
elif printf '%s' "$line" | grep -q '"schema_version":'; then
orca_log_error "verify-render" "$bundle" "failed" "schema_version mismatch on line $total"
echo "error: line $total schema_version mismatch (expected $EXPECTED_SCHEMA)" >&2
errors=$((errors + 1))
else
orca_log_error "verify-render" "$bundle" "failed" "missing schema_version on line $total"
echo "error: line $total missing schema_version" >&2
errors=$((errors + 1))
fi
done < "$bundle"
if [ "$errors" -gt 0 ]; then
orca_log_error "verify-render" "$bundle" "failed" "$errors of $total artifacts invalid"
echo "verify-render: $errors of $total artifacts invalid" >&2
exit 1
fi
orca_log_info "verify-render" "$bundle" "ok" ""
echo "verify-render: $total artifacts valid"
exit 0
+39
View File
@@ -0,0 +1,39 @@
# Bash Testing Policy (grill C-15)
Every bash script under `scripts/` MUST have at least one bats test covering
the happy path and one covering the failure path. This is the compensating
control for bash being exempt from the Go coverage gate (D-186).
## Framework
- **bats**`bats scripts/tests/*.bash` runs all bash tests.
- **shellcheck**`shellcheck scripts/*.sh scripts/lib/*.sh scripts/tests/*.bash` static analysis.
- **shfmt**`shfmt -d scripts/` formatting check (optional; skip if not installed).
## Install (if missing)
```bash
# bats
npm install -g bats # or: git clone https://github.com/bats-core/bats-core.git && ./bats-core/install.sh /usr/local
# shellcheck
apt-get install -y shellcheck
# shfmt (optional)
mvdan.cc/sh (go install mvdan.cc/sh/v3/cmd/shfmt@latest)
```
## Running
```bash
make test-bash # runs bats (skips gracefully if bats missing)
make lint-bash # runs shellcheck + shfmt (skips gracefully if missing)
make test # runs both Go + bash tests
make lint # runs both Go + bash lint
```
## Test file convention
- Test files live in `scripts/tests/<script-name>_test.bash`.
- Source `load test_helper` at the top of every test file.
- Happy path: `@test "<script> happy path" { ... }`
- Failure path: `@test "<script> failure path" { ... }`
- Use `run <command>` + `assert_status`/`assert_contains`/`assert_not_contains` from test_helper.
+43
View File
@@ -0,0 +1,43 @@
#!/usr/bin/env bats
# Example bats test proving the framework works (C-15 smoke test).
# Real script tests live alongside each script under scripts/tests/.
load test_helper
@test "test_helper assert_status accepts matching status" {
assert_status 0 0
assert_status 1 1
}
@test "test_helper assert_status rejects mismatch" {
run assert_status 0 1
[ "$status" -ne 0 ]
}
@test "test_helper assert_contains finds substrings" {
assert_contains "hello world" "world"
}
@test "test_helper assert_contains rejects missing substrings" {
run assert_contains "hello world" "missing"
[ "$status" -ne 0 ]
}
@test "test_helper assert_not_contains passes when substring absent" {
assert_not_contains "hello world" "missing"
}
@test "test_helper assert_not_contains fails when substring present" {
run assert_not_contains "hello world" "world"
[ "$status" -ne 0 ]
}
@test "test_helper assert_json_field detects JSON fields" {
assert_json_field '{"ts":"2026-01-01T00:00:00Z","level":"info"}' "ts"
assert_json_field '{"ts":"2026-01-01T00:00:00Z","level":"info"}' "level"
}
@test "test_helper SCRIPTS_DIR resolves to scripts/ directory" {
[ -d "$SCRIPTS_DIR" ]
[ -f "$SCRIPTS_DIR/install.sh" ]
}
+69
View File
@@ -0,0 +1,69 @@
#!/usr/bin/env bats
# Tests for scripts/lib/orca-log.sh (C-17 — slog-compatible JSON to syslog).
# Verifies the JSON structure is valid, field set is present, level maps correctly,
# and the logger-fallback-to-stderr path works in test environments (no logger).
load test_helper
@test "orca_log_info emits valid JSON with all required fields" {
export ORCA_LOG_ACTOR="test-actor"
output="$(_orca_log_for_test info test-action test-resource ok "")"
assert_json_field "$output" "ts"
assert_json_field "$output" "level"
assert_json_field "$output" "actor"
assert_json_field "$output" "action"
assert_json_field "$output" "resource"
assert_json_field "$output" "result"
assert_contains "$output" '"level":"info"'
assert_contains "$output" '"action":"test-action"'
assert_contains "$output" '"resource":"test-resource"'
assert_contains "$output" '"result":"ok"'
}
@test "orca_log_warn maps level correctly" {
output="$(_orca_log_for_test warn w-action w-resource warn-result)"
assert_contains "$output" '"level":"warn"'
}
@test "orca_log_error maps level and includes error field when provided" {
output="$(_orca_log_for_test error err-action err-resource failed "something broke")"
assert_contains "$output" '"level":"error"'
assert_contains "$output" '"result":"failed"'
assert_contains "$output" '"error":"something broke"'
}
@test "orca_log_error omits error field when not provided" {
output="$(_orca_log_for_test error err-action err-resource failed)"
assert_contains "$output" '"level":"error"'
assert_not_contains "$output" '"error":'
}
@test "orca_log escapes quotes and backslashes in error field" {
output="$(_orca_log_for_test error a r failed 'has "quote" and \backslash')"
assert_contains "$output" '\"quote\"'
assert_contains "$output" '\\backslash'
}
@test "ORCA_LOG_ACTOR env var overrides the actor field" {
export ORCA_LOG_ACTOR="custom-actor-123"
output="$(_orca_log_for_test info a r ok)"
assert_contains "$output" '"actor":"custom-actor-123"'
}
# Test helper: source orca-log.sh and emit to stderr (force fallback by hiding logger).
_orca_log_for_test() {
local level="$1" action="$2" resource="$3" result="$4" error="${5:-}"
# Source the library in a subshell with logger hidden so it falls back to stderr.
(
PATH="/usr/bin:/bin" # hide logger if it's in /usr/local/bin etc.
# shellcheck disable=SC2317 # logger is overridden below for test capture
logger() { echo "$3"; } # $3 is the message arg (logger -t orca "$line")
# shellcheck disable=SC1091 # path is set at runtime by SCRIPTS_DIR
source "$SCRIPTS_DIR/lib/orca-log.sh"
case "$level" in
info) orca_log_info "$action" "$resource" "$result" "$error" ;;
warn) orca_log_warn "$action" "$resource" "$result" "$error" ;;
error) orca_log_error "$action" "$resource" "$result" "$error" ;;
esac
)
}
@@ -0,0 +1,69 @@
#!/usr/bin/env bats
# Tests for scripts/orca-verify-render.sh (C-16 render-format contract validator).
# Covers happy path (valid input returns 0) and failure paths (schema mismatch,
# missing fields, missing file, missing argument).
load test_helper
VERIFY_RENDER="$SCRIPTS_DIR/orca-verify-render.sh"
TMP_BUNDLE=""
setup() {
TMP_BUNDLE="$(mktemp)"
}
teardown() {
[ -n "$TMP_BUNDLE" ] && rm -f "$TMP_BUNDLE"
}
@test "verify-render happy path: valid artifacts return 0" {
cat >"$TMP_BUNDLE" <<'EOF'
{"schema_version":"orca.emit/v1","kind":"systemd","path":"/etc/systemd/system/x.service","content":"[Service]","mode":"0644"}
{"schema_version":"orca.emit/v1","kind":"traefik","path":"/etc/traefik/dynamic/orca.yml","content":"tls:{}","mode":"0644"}
EOF
run "$VERIFY_RENDER" "$TMP_BUNDLE"
assert_status 0 "$status"
assert_contains "$output" "2 artifacts valid"
}
@test "verify-render failure: schema_version mismatch returns non-zero" {
cat >"$TMP_BUNDLE" <<'EOF'
{"schema_version":"orca.emit/v2","kind":"systemd","path":"/x","mode":"0644"}
EOF
run "$VERIFY_RENDER" "$TMP_BUNDLE"
[ "$status" -ne 0 ]
assert_contains "$output" "schema_version mismatch"
}
@test "verify-render failure: missing schema_version returns non-zero" {
cat >"$TMP_BUNDLE" <<'EOF'
{"kind":"systemd","path":"/x","mode":"0644"}
EOF
run "$VERIFY_RENDER" "$TMP_BUNDLE"
[ "$status" -ne 0 ]
assert_contains "$output" "missing schema_version"
}
@test "verify-render failure: missing bundle argument returns 2" {
run "$VERIFY_RENDER"
assert_status 2 "$status"
assert_contains "$output" "usage:"
}
@test "verify-render failure: non-existent bundle returns 2" {
run "$VERIFY_RENDER" "/nonexistent/bundle.json"
assert_status 2 "$status"
assert_contains "$output" "bundle not found"
}
@test "verify-render skips blank lines and comments" {
cat >"$TMP_BUNDLE" <<'EOF'
# this is a comment
{"schema_version":"orca.emit/v1","kind":"systemd","path":"/x","content":"c","mode":"0644"}
EOF
run "$VERIFY_RENDER" "$TMP_BUNDLE"
assert_status 0 "$status"
assert_contains "$output" "1 artifacts valid"
}
+42
View File
@@ -0,0 +1,42 @@
#!/usr/bin/env bash
# Common helpers for orca bats tests (C-15). Sourced by every test file.
# See scripts/tests/README.md for the bash testing policy.
# Resolve the scripts/ dir relative to this test file.
# BASH_SOURCE[0] is this helper file (scripts/tests/test_helper.bash).
SCRIPTS_DIR="$(cd "$(dirname "${BASH_SOURCE[0]}")/.." && pwd)"
export SCRIPTS_DIR
# assert_status <expected> <actual> — assert a command's exit status.
assert_status() {
local expected="$1" actual="$2"
[ "$expected" = "$actual" ] || {
echo "expected status $expected, got $actual" >&2
return 1
}
}
# assert_contains <haystack> <needle> — substring assertion.
assert_contains() {
local haystack="$1" needle="$2"
case "$haystack" in
*"$needle"*) return 0 ;;
*) echo "expected [$haystack] to contain [$needle]" >&2; return 1 ;;
esac
}
# assert_not_contains <haystack> <needle> — negative substring assertion.
assert_not_contains() {
local haystack="$1" needle="$2"
case "$haystack" in
*"$needle"*) echo "expected [$haystack] to NOT contain [$needle]" >&2; return 1 ;;
esac
:
}
# assert_json_field <json> <field> — crude JSON field presence check (no jq dep).
# Matches "<field>": present anywhere in the JSON string.
assert_json_field() {
local json="$1" field="$2"
assert_contains "$json" "\"$field\""
}