Jon Chery
d3aa960eb8
---ci--- project: acdl phase: 10 milestone: v1.1 status: shipped requirements: complete: [REQ-25, REQ-27, REQ-28] release: tag: v1.1.5 ---/ci--- ROADMAP Phase 10 -> complete (v1.1.5). REQUIREMENTS REQ-25/27/28 -> complete. The end-to-end spike pipeline succeeds: contract -> IR -> terraform plan (real AWS) -> Checkov -> confidence (pass) -> outbox. REQ-28 verified: the adapter is the only substrate-specific code (the IR commitments hold).
129 lines
9.0 KiB
Markdown
129 lines
9.0 KiB
Markdown
# ACDL — Requirements
|
||
|
||
## v1
|
||
|
||
### Category: Repos & Org
|
||
- **REQ-01:** All demo code lives under the `continuous-intelligence` Gitea org at `https://git.cloudinit.dev`.
|
||
- **REQ-09:** Three repos exist: `acdl` (platform + stubs + reusable workflows), `acdl-contracts` (developer surface), `acdl-evidence` (Pages audit timeline).
|
||
|
||
### Category: L1 Modules
|
||
- **REQ-02:** 8 L1 module folders exist under `acdl/modules/l1/`: `l1-eks-fargate`, `l1-iam-role`, `l1-lambda`, `l1-api-gateway`, `l1-eventbridge`, `l1-sqs`, `l1-s3`, `l1-cloudwatch`.
|
||
- **REQ-03:** Each L1 module has a `manifest.yaml` (declaring inputs) and a `mock_apply.sh` that echoes success, sleeps 1s, and exits 0.
|
||
|
||
### Category: L2 Modules
|
||
- **REQ-04:** 4 L2 modules exist under `acdl/modules/l2/`: `l2-invoice-service`, `l2-commodity-price-feed`, `l2-energy-analytics-api`, `l2-regulatory-reporting`, each composing the specified L1s.
|
||
- **REQ-05:** L2 modules compose L1 primitives into deployable shapes with a maximum depth of 5.
|
||
|
||
### Category: Core Scripts
|
||
- **REQ-06:** `mock_executor.sh` reads an L2 composition, invokes each L1 `mock_apply.sh`, and writes `state.json`.
|
||
- **REQ-07:** `policy_checker.py` reads `contract.yaml` and fails with `POLICY_VIOLATION:PUBLIC_INGRESS` on `public-ingress: true`; otherwise passes.
|
||
- **REQ-08:** `confidence_signal.py` returns a base score of 0.90 and drops to 0.40 (with reason code) when policy fails; gate threshold is ≥ 0.50.
|
||
|
||
### Category: Evidence Stream
|
||
- **REQ-11:** `evidence_writer.py` appends events to `audit.json` and links each event to the previous via a SHA-256 hash chain (`prev_hash` + own `hash`).
|
||
- **REQ-13:** `acdl-evidence` is Pages-enabled and serves `audit.json` plus `index.html`.
|
||
|
||
### Category: Pipeline
|
||
- **REQ-10:** The reusable pipeline runs Dev (autonomous), pauses at QA (manual approval), pauses at Prod (manual approval), then finalizes by committing `audit.json` to `acdl-evidence`.
|
||
- **REQ-12:** Opening an Issue in `acdl-contracts` runs `l3b_agent_stub.py`, commits a generated `contract.yaml` to a new branch, closes the Issue, and triggers the main pipeline.
|
||
|
||
### Category: Demo Acts
|
||
- **REQ-14:** `index.html` uses vanilla JS to fetch `audit.json` from the Pages URL and render events as a timeline.
|
||
- **REQ-15:** All four demo acts (Friction, Developer Self-Service, Citizen Developer, Safety Net) reproduce deterministically in a dry run.
|
||
|
||
## v2
|
||
|
||
(None — v1 covers the complete demo.)
|
||
|
||
## v1.1 (Active milestone — architecture finalization + v1 spike)
|
||
|
||
### Category: Architecture Finalization
|
||
- **REQ-16:** Architecture reaches v1.0 — all 11 open decisions in `docs/architecture.md` §13 are resolved and recorded in `PROJECT.md` (W1.A, W1.B, W2.A, W3.D, W3.E, BA.A–F, OpenTofu timing).
|
||
- **REQ-17:** Target Stack IR is defined as a JSON Schema under `schemas/ir.schema.json`; substrate-agnostic (resources, relationships, composition max-depth-5, policy hooks).
|
||
- **REQ-18:** `PolicyCheckResult` normalized schema is defined under `schemas/policy_check_result.schema.json`; a Checkov adapter translates Checkov JSON to this schema.
|
||
- **REQ-19:** Six-input confidence signal is specified under `platform/confidence_signal.py` with per-env thresholds (dev 0.50 / qa 0.75 / prod 0.90 / dr 0.95) and severity→penalty mapping (critical=hard override, high=-0.2, medium=-0.05, low=-0.01, info=0.0).
|
||
- **REQ-20:** Tiered audit ledger design is authored: S3 Object Lock (compliance mode, 7-yr) + DynamoDB outbox (RPO=0, JWS detached signatures, `prev_event_hash` chain, daily checkpoints).
|
||
- **REQ-21:** Full 8-concern HITL matrix + separation-of-duties design is authored (CODEOWNERS routing + DynamoDB identity-distinctness check; pre-execution gate model; 1d warn / 2d freeze timeout).
|
||
- **REQ-22:** Contract schema (JSON Schema draft 2020-12) is defined under `schemas/contract.schema.json` with per-env mandatory/optional inputs (W3.E) and `profile: agentic` marker for L3B fields.
|
||
|
||
### Category: AWS OIDC Bootstrap
|
||
- **REQ-23:** AWS auth bootstrap + state backend for the spike: an S3 state bucket + DynamoDB lock/outbox table + an IAM user with a minimal scoped policy (S3 + DynamoDB + plan-only). The temporary long-lived key is used once (waiver D-034) then rotated via `scripts/rotate_spike_key.sh` after each spike run (D-039). **Real OIDC federation is deferred to v1.2** — Gitea Actions does not support `id-token: write` (RESEARCH TARGET 1, conf 0.95), blocked on go-gitea/gitea#36988.
|
||
|
||
### Category: v1 Spike — IR, L1, Adapter
|
||
- **REQ-24:** One real L1 module `l1-s3` exists under `modules-ir/l1/l1-s3/` with an IR-typed interface (typed inputs/outputs/NFRs) registered in the L1 registry.
|
||
- **REQ-25:** One real L2 thin-composition `l2-static-asset` exists under `modules-ir/l2/l2-static-asset/` referencing `l1-s3` only (depth 1, within max-depth-5).
|
||
- **REQ-26:** The Terraform adapter (`adapters/terraform/`) compiles the IR-typed L1 interface to Terraform `variable`/`output` blocks and the L2 thin-composition tree to a Terraform root module; it emits a real `terraform plan` against AWS via OIDC; state is stored in S3 + DynamoDB.
|
||
|
||
### Category: v1 Spike — End-to-End
|
||
- **REQ-27:** One end-to-end contract submission (`contracts/spike.yaml` for `l2-static-asset`) flows through: contract schema validation → contract→IR resolution → `terraform plan` (real AWS) → Checkov `PolicyCheckResult` → confidence signal → evidence event written to the DynamoDB outbox.
|
||
- **REQ-28:** Spike verification (`scripts/verify_phase10.sh`) proves the IR-shaped commitments hold: the adapter is the only substrate-specific code; no polyglot mess; the L1 content, contract YML, and thin-composition tree are substrate-agnostic.
|
||
|
||
## Out of Scope (v1.1)
|
||
|
||
| Feature | Reason |
|
||
|---------|--------|
|
||
| Full HITL matrix wiring (qa/prod/dr) | Spike is dev-only (`terraform plan`); HITL wiring is v1.2. |
|
||
| Kyverno + OPA policy engines | Spike uses Checkov only; Kyverno/OPA are v1.2. |
|
||
| MCP skill catalog + real L3B agent | L3B spike = a single stub contract submission; the 5-skill catalog is v1.2. |
|
||
| GitOps reconciler (ArgoCD/Flux) | v1.2. |
|
||
| Multi-region state / outbox | Single-region in v1 (§9, §12.3). |
|
||
| Prod/dr environments | v1.2. |
|
||
| Terraform `apply` (real provisioning) | Spike runs `plan` only; `apply` is gated by HITL in v1.2. |
|
||
|
||
## Clarifications (Phase 01, v1.0 — retained for history)
|
||
|
||
| REQ | Original criterion | Clarified criterion (effective) | Decision |
|
||
|-----|--------------------|----------------------------------|----------|
|
||
| REQ-09 | Three repos exist | Three repos exist (`acdl`, `acdl-contracts`, `acdl-evidence`) under `continuous-intelligence`; new repos use `default_branch: "main"`, `auto_init: true` | D-015 |
|
||
| REQ-10 | "Pages returns 200 with placeholder `index.html`" on `acdl-evidence` | Gitea has no Pages; substitute: an HTTP GET against the raw file URL `https://git.cloudinit.dev/continuous-intelligence/acdl-evidence/raw/branch/main/index.html` returns 200 with the placeholder HTML body | D-012, D-016 |
|
||
| REQ-10 | "`qa` and `prod` environments exist on `acdl-contracts`" | Gitea has no environments API and ignores `environment:` blocks; substitute: the reusable workflow defines `qa-gate` and `prod-gate` jobs gated by `workflow_dispatch` approval inputs (D-004 fallback); a `qa` and `prod` branch may be created on `acdl-contracts` as a visible stand-in for environments | D-013 |
|
||
|
||
## Out of Scope (v1.0 demo — retained for history)
|
||
|
||
| Feature | Reason |
|
||
|---------|--------|
|
||
| Real cloud provisioning (AWS/GCP/Azure) | Demo explicitly stubs all infrastructure; no cloud access available. |
|
||
| Real LLM inference / external AI APIs | Spec forbids external AI; L3B is a keyword parser. |
|
||
| Production-grade infrastructure | Demo target is a 30-minute executive show, not a production system. |
|
||
| Adversarial tamper-proofing of evidence | Hash chain is demonstrative; not cryptographically secure against a determined attacker. |
|
||
| Multi-tenant isolation | Out of demo scope. |
|
||
|
||
## Traceability
|
||
|
||
### v1.0 (prior — demo)
|
||
|
||
| Requirement | Phase | Status |
|
||
|-------------|-------|--------|
|
||
| REQ-01 | 1 | complete (v1.0.1) |
|
||
| REQ-02 | 2 | complete (v1.0.2) |
|
||
| REQ-03 | 2 | complete (v1.0.2) |
|
||
| REQ-04 | 3 | complete (v1.0.3) |
|
||
| REQ-05 | 3 | complete (v1.0.3) |
|
||
| REQ-06 | 3 | complete (v1.0.3) |
|
||
| REQ-07 | 3 | complete (v1.0.3) |
|
||
| REQ-08 | 3 | complete (v1.0.3) |
|
||
| REQ-09 | 1 | complete (v1.0.1) |
|
||
| REQ-10 | 4 | complete (v1.0.4) |
|
||
| REQ-11 | 3 | complete (v1.0.3) |
|
||
| REQ-12 | 4 | complete (v1.0.4) |
|
||
| REQ-13 | 5 | complete (v1.0.5) |
|
||
| REQ-14 | 5 | complete (v1.0.5) |
|
||
| REQ-15 | 5 | complete (v1.0.5) |
|
||
|
||
### v1.1 (active — architecture finalization + v1 spike)
|
||
|
||
| Requirement | Phase | Status |
|
||
|-------------|-------|--------|
|
||
| REQ-16 | 07 | complete (v1.1.2) |
|
||
| REQ-17 | 07 | complete (v1.1.2) |
|
||
| REQ-18 | 07 | complete (v1.1.2) |
|
||
| REQ-19 | 07 | complete (v1.1.2) |
|
||
| REQ-20 | 07 | complete (v1.1.2) |
|
||
| REQ-21 | 07 | complete (v1.1.2) |
|
||
| REQ-22 | 07 | complete (v1.1.2) |
|
||
| REQ-23 | 08 | complete (v1.1.3) |
|
||
| REQ-24 | 09 | complete (v1.1.4) |
|
||
| REQ-25 | 10 | complete (v1.1.5) |
|
||
| REQ-26 | 09 | complete (v1.1.4) |
|
||
| REQ-27 | 10 | complete (v1.1.5) |
|
||
| REQ-28 | 10 | complete (v1.1.5) | |