docs(P04 W2): pilot-run docs (REQ-321) — adapters/README, METRICS, ARCHITECTURE §12.8, consumer onboarding
- adapters/README.md: fixed stale TYPE_MAP/INPUT_MAP refs (the adapter is a stateless assembler); added the blockchain-exchange consumer row + the Gitea adapter note (SPEC §10 Q1 — no cross-repo uses:) - docs/METRICS.md: Post-Pilot denominators activated (AI Decision Accuracy + Human Escalation Frequency + the third metric now have non-zero data from the blkex-pilot-apply-v0.2 run) - .ciagent/ARCHITECTURE.md §12.8: Pilot Estate (v1.26 live) — the first real consumer estate, the live apply, the Gitea adapter, the evidence stream - .ciagent/nova-blockchain-exchange/README.md: consumer onboarding guide (deploy invocation, secrets, contract shape, verification) ---ci--- project: acdl phase: 4 milestone: v1.26 status: execute wave: W2 ---
This commit is contained in:
+51
-7
@@ -46,12 +46,28 @@ never import an engine directly — they go through the registry.
|
||||
|
||||
## How to Write an Adapter
|
||||
|
||||
### Terraform Adapter Extension
|
||||
### Terraform Adapter Extension (stateless assembler — v1.11 rewrite)
|
||||
|
||||
1. Add a stack type → Terraform type mapping to `TYPE_MAP`.
|
||||
2. Add non-identity input mappings to `INPUT_MAP`.
|
||||
3. Add non-identity output mappings to `OUTPUT_MAP`.
|
||||
4. Add a specialized `_emit_resource` branch if the resource needs nested blocks (e.g. inline policies, rule sets).
|
||||
> The adapter owns **no module content**. There is no `TYPE_MAP`, no
|
||||
> `INPUT_MAP`, no `OUTPUT_MAP`, and no per-type branch logic (all deleted
|
||||
> in the v1.11 rewrite — the 918-line monolith collapsed to a ~80-line
|
||||
> assembler). Engine-specific shape lives in each L1 module's own
|
||||
> `terraform/` dir (`versions.tf`/`variables.tf`/`locals.tf`/`main.tf`/
|
||||
> `outputs.tf`); the adapter only assembles them.
|
||||
|
||||
To extend the Terraform adapter, **do not edit the adapter** — instead:
|
||||
|
||||
1. Add an L1 module with a real `terraform/` dir (owning its resource
|
||||
shape, nested HCL blocks, and defaults).
|
||||
2. Register it in `modules/registry.json` under the module name with its
|
||||
`terraform_dir` path. The adapter reads `registry.json` to find each
|
||||
module's directory.
|
||||
3. The adapter emits `module "<rid>" { source = "<path>" }` blocks at
|
||||
the root, with resolved inputs + wired `ref:` refs between modules.
|
||||
No type-specific translation lives in the adapter.
|
||||
|
||||
> If you find yourself reaching for a "TYPE_MAP"-style constant, the L1
|
||||
> module is missing a piece — fix the module, not the adapter.
|
||||
|
||||
### Policy Adapter Pattern
|
||||
|
||||
@@ -76,7 +92,7 @@ never import an engine directly — they go through the registry.
|
||||
|
||||
## How to Test Adapters
|
||||
|
||||
- `tests/test_adapter.py` — Terraform adapter (`TYPE_MAP`, resource emission, refs, outputs).
|
||||
- `tests/test_adapter.py` — Terraform adapter (stateless assembly: registry read, `module "<rid>" { source }` emission, `ref:` wiring, outputs). No `TYPE_MAP`/`INPUT_MAP` tests — the adapter owns no type mappings.
|
||||
- `tests/test_checkov_adapter.py` — Checkov adapter.
|
||||
- `tests/test_wiz_adapter.py` — Wiz adapter.
|
||||
- `tests/test_kyverno_adapter.py` — Kyverno adapter.
|
||||
@@ -93,4 +109,32 @@ never import an engine directly — they go through the registry.
|
||||
3. Add the adapter's engine name to the `engine` enum in `schemas/policy_check_result.schema.json` if it is a policy adapter.
|
||||
4. Write a test (`tests/test_<name>_adapter.py`) plus a fixture (`tests/fixtures/<name>_fixture.json`).
|
||||
5. Add it to `scripts/run_platform.sh` if it is invoked at runtime.
|
||||
6. Update this README.
|
||||
6. Update this README.
|
||||
|
||||
## Consumers
|
||||
|
||||
The Terraform adapter compiles contract IR for consumer estates. The
|
||||
first real consumer estate is now live:
|
||||
|
||||
| Consumer | Version | Environment | Account | Forge / Adapter | Status |
|
||||
| --- | --- | --- | --- | --- | --- |
|
||||
| `nova-blockchain-exchange` | v0.2 | dev | `581513795199` | inline adapter (see note below) | **live** (pilot apply `blkex-pilot-apply-v0.2`, 2026-08-19) |
|
||||
|
||||
### Forge adapter note (SPEC §10 Q1)
|
||||
|
||||
Forge Actions (the consumer's forge runtime) does **not** support
|
||||
cross-repo `uses:` references — the forge rejects
|
||||
`uses: <owner>/<repo>/.github/workflows/<file>@<ref>` with
|
||||
`expected format {owner}/{repo}/.{git_platform}/workflows/{filename}@{ref}`.
|
||||
The consumer (`nova-blockchain-exchange`) therefore uses an **inline
|
||||
adapter** in its `deploy.yml`: the workflow does `actions/checkout@v4`
|
||||
on the consumer, then `actions/checkout@v4` `acdl/acdl` @ `ref: v1.25`
|
||||
into `platform/`, and runs `bash platform/scripts/run_platform.sh ...`
|
||||
directly — no `uses:` indirection.
|
||||
|
||||
The platform's own `.github/workflows/deploy.yml` (this repo) stays as
|
||||
the **GitHub Actions reference implementation** — the reusable
|
||||
`workflow_call` workflow used by GitHub-hosted consumers. The two
|
||||
files share the same contract shape; the only declared difference is
|
||||
the forge/runtime, not the stages or commands. See
|
||||
`.ciagent/ARCHITECTURE.md` §12.8 for the live pilot-estate wiring.
|
||||
Reference in New Issue
Block a user