feat(P4): regression-gate policies + docs (REQ-304..307)

regression/ policies (3): cap-013-adapter-dedup, cap-023-metrics-collector,
cap-024-deck-structure — declarative mirrors of core/regression_verify.py
over capability-inventory JSON. The imperative regression_verify.py is kept
(drives CI gate); the policies are the declarative mirror (IDEATE I1 quality
improvement).

tests: test_regression_policies.py + clean/drifted fixtures. Skip-without-kj.

docs: adapters/README.md (new kyverno-json row + PolicyEngine Protocol
section with how-to-add-OpaEngine), adapters/kyverno-json/README.md (engine,
install, policy directory layout, 4 categories, severity convention),
schemas/README.md (D-116 engine enum reuse note), modules/STANDARDS.md §10
Policy Authoring Standard, docs/METRICS.md (swappable engine narrative).

---ci---
project: acdl
phase: 4
milestone: v1.25
status: execute
phase_role: execution
requirements:
  covered: [REQ-304, REQ-305, REQ-306, REQ-307]
  partial: []
---/ci---
This commit is contained in:
Jon Chery
2026-08-12 18:42:55 +00:00
parent 89f62c85ab
commit 38b51f3e6d
11 changed files with 425 additions and 2 deletions
+31
View File
@@ -12,6 +12,37 @@ Adapters translate the engine-agnostic Target Stack IR to engine-specific format
| Checkov adapter | `adapters/terraform/policy/checkov_adapter.py` | Checkov JSON | `PolicyCheckResult` records | Translates Checkov results |
| Wiz adapter | `adapters/wiz/wiz_adapter.py` | Wiz API issues JSON | `PolicyCheckResult` records | Translates Wiz security findings |
| Kyverno adapter | `adapters/kyverno/kyverno_adapter.py` | Kyverno PolicyReport JSON | `PolicyCheckResult` records | K8s-native policy translation |
| kyverno-json engine | `adapters/kyverno-json/kyverno_json_engine.py` | Any JSON/YAML payload | `PolicyCheckResult` records | **v1.25 primary policy engine** (swappable via `PolicyEngine` protocol) |
## Policy Engine Protocol (v1.25)
The `core/policy_engine.py` module defines the **swap boundary** between
Nova and its policy engines. A `PolicyEngine` Python Protocol (PEP 544)
with three members (`name`, `is_configured()`, `evaluate()`) is the
contract; a `PolicyEngineRegistry` selects the active engine from
`config.json`'s `policy.engine` key. The confidence signal and pipeline
never import an engine directly — they go through the registry.
**Implementations:**
- `KyvernoJsonEngine` (`adapters/kyverno-json/`) — shells to the `kj`
CLI; the v1.25 default.
- `NullEngine` (`core/policy_engine.py`) — fallback when the `policy`
key is absent (emits `SKIPPED`).
- Future: `OpaEngine` — implements the same protocol, shells to
`opa eval`. The OPA-equivalent surface is documented in
`.ciagent/RESEARCH.md` §4.2.
**How to add a new engine:**
1. Create `adapters/<name>/<name>_engine.py` implementing the
`PolicyEngine` protocol (`name`, `is_configured()`, `evaluate()`).
2. `evaluate()` returns `list[dict]` where each dict conforms to
`schemas/policy_check_result.schema.json`.
3. Register the engine in `core/policy_engine.py`'s `_autoload_*`
function (or call `register(name, factory)` at startup).
4. Set `config.json.policy.engine` to the engine's `name`.
5. Add the engine to the `engine` enum in
`schemas/policy_check_result.schema.json` if it needs a distinct
enum value (v1.25 reuses `"kyverno"` — see D-116).
## How to Write an Adapter
+103
View File
@@ -0,0 +1,103 @@
# kyverno-json Engine Adapter (v1.25)
The `kyverno-json` engine is Nova's **primary compliance/policy tool**
(v1.25), implemented behind the swappable `PolicyEngine` protocol so
OPA (or any other engine) can replace it one day.
## What kyverno-json is
[kyverno-json](https://github.com/kyverno/kyverno-json) is a standalone
Go binary from the Kyverno project — a **separate runtime** from the
K8s Kyverno admission controller. It applies Kyverno `ValidatingPolicy`
resources to **any** JSON or YAML payload file via the `kj scan` CLI.
Unlike the K8s Kyverno adapter (`adapters/kyverno/`), which only
speaks to K8s manifests, kyverno-json evaluates consumer contracts,
resolved Stack IR, terraform plan JSON, and even the merged PCR list
itself (meta-policies).
## Install
```bash
bash scripts/install-kyverno-json.sh
# or directly:
go install github.com/kyverno/kyverno-json/cmd/kj@latest
kj version
```
The platform functions without the binary — `is_configured()` returns
`False` when `which kj` is absent → `evaluate()` returns a single
`SKIPPED` PCR (`KJ_ENGINE_NOT_CONFIGURED`). The confidence signal
proceeds with a neutral `policy` input (D-120 graceful degradation).
## Policy directory layout
```
adapters/kyverno-json/policies/
├── _smoke.json # round-trip smoke test
├── contract/ # consumer contract JSON policies
│ ├── require-id-pattern.json
│ ├── require-env-in-enum.json
│ ├── require-infrastructure-min-1.json
│ └── forbid-unknown-fields.json
├── stack-ir/ # resolved Stack IR policies
│ ├── require-tagging-standard.json
│ ├── forbid-public-ingress.json
│ └── require-encryption-by-default.json
├── plan-json/ # terraform show -json policies
│ ├── forbid-plaintext-secrets.json
│ ├── forbid-iam-wildcard.json
│ └── require-kms-reference.json
├── meta/ # policies over the merged PCR list
│ ├── block-on-any-critical.json
│ └── tagging-rules-agree.json
└── regression/ # capability-inventory policies
├── cap-013-adapter-dedup.json
├── cap-023-metrics-collector.json
└── cap-024-deck-structure.json
```
## The four policy categories
1. **contract/** — over the consumer contract JSON (pre-resolve).
2. **stack-ir/** — over the resolved Target Stack IR (post-resolve).
3. **plan-json/** — over `terraform show -json` output (pipeline Step 5b).
4. **meta/** — over the merged `list[PolicyCheckResult]` (meta-policies).
5. **regression/** — over the capability-inventory JSON (declarative
mirrors of `core/regression_verify.py`).
## Severity convention
kyverno-json does not natively assign severities. Each Nova policy
declares its severity via a `metadata.annotations` field:
```yaml
metadata:
annotations:
nova.cloudinit.dev/severity: high
```
Valid values: `critical`, `high`, `medium`, `low`, `info` (default
when absent).
## Engine enum reuse (D-116)
kyverno-json PCR records carry `engine: "kyverno"` (no new enum value).
The `engine` field records the policy-engine *family*, not the specific
binary. The K8s Kyverno adapter and the kyverno-json engine are
distinguished by `ruleId` prefix (`KYVERNO_` vs `KJ_`) and `evidence`
payload shape (`namespace`/`kind` vs `assertion`/`jmespath`).
## Schema path
The output records validate against
[`schemas/policy_check_result.schema.json`](../../schemas/policy_check_result.schema.json)
(`engine: "kyverno"` is in the enum). The confidence signal consumes
the merged PCR list engine-agnostically.
## Swap boundary
The `PolicyEngine` protocol (`core/policy_engine.py`) is the swap
boundary. The OPA-equivalent surface is documented in
`.ciagent/RESEARCH.md` §4.2 — a future `OpaEngine` implements the same
protocol without touching the confidence signal, the PCR schema, or
the pipeline.
@@ -0,0 +1,30 @@
{
"apiVersion": "json.kyverno.io/v1alpha1",
"kind": "ValidatingPolicy",
"metadata": {
"name": "cap-013-adapter-dedup",
"annotations": {
"nova.cloudinit.dev/severity": "medium",
"title.policy.kyverno.io": "No duplicate adapter registrations (CAP-013 declarative mirror)"
}
},
"spec": {
"rules": [
{
"name": "no-duplicate-adapters",
"validate": {
"message": "Each adapter must be registered exactly once (no duplicate adapter names in the capability inventory). Declarative mirror of core/regression_verify.py CAP-013.",
"assert": {
"all": [
{
"check": {
"adapters": "(length(duplicates(@)) == `0`)"
}
}
]
}
}
}
]
}
}
@@ -0,0 +1,32 @@
{
"apiVersion": "json.kyverno.io/v1alpha1",
"kind": "ValidatingPolicy",
"metadata": {
"name": "cap-023-metrics-collector",
"annotations": {
"nova.cloudinit.dev/severity": "medium",
"title.policy.kyverno.io": "Every metric has a grounded/derived/deferred status (CAP-023 declarative mirror)"
}
},
"spec": {
"rules": [
{
"name": "every-metric-has-status",
"validate": {
"message": "Every metric in docs/METRICS.md must declare a status (grounded, derived, or deferred). Declarative mirror of core/regression_verify.py CAP-023.",
"assert": {
"all": [
{
"check": {
"~.metrics": {
"(contains(['grounded','derived','deferred'], status))": true
}
}
}
]
}
}
}
]
}
}
@@ -0,0 +1,35 @@
{
"apiVersion": "json.kyverno.io/v1alpha1",
"kind": "ValidatingPolicy",
"metadata": {
"name": "cap-024-deck-structure",
"annotations": {
"nova.cloudinit.dev/severity": "low",
"title.policy.kyverno.io": "Deck structure matches the documented 4-beat arc (CAP-024 declarative mirror)"
}
},
"spec": {
"rules": [
{
"name": "deck-has-4-beats",
"validate": {
"message": "The deck must have the 4-beat arc: Problem, Solution, Proof, Roadmap+Ask. Declarative mirror of core/regression_verify.py CAP-024.",
"assert": {
"all": [
{
"check": {
"deck.beats": "(length(@) >= `4`)"
}
},
{
"check": {
"deck.beats": "(contains(@, 'Problem') && contains(@, 'Solution') && contains(@, 'Proof') && contains(@, 'Roadmap+Ask'))"
}
}
]
}
}
}
]
}
}