The recipe data layer is the rule-based engine that turns a Criteria
query ({service, accelerator, intent, os, platform, nodes}) into a
resolved RecipeResult — the merged spec, component refs, deployment
order, and validation phases that aicr bundle consumes.
This page covers everything related to AICR recipes for contributors:
the three layers that contribute data (registry, overlay,
mixin), the on-disk schemas for each, the resolver's merge
algorithm, and the invariants the resolver enforces. End-user recipe
authoring lives in
recipe-development.md; this
page is for contributors changing recipe content or extending the
resolver in pkg/recipe.
Where does my change go? Most changes hit exactly one of three files. Skim Decision matrix before editing — picking the wrong layer leaks defaults across recipes or duplicates content across overlays.
┌──────────────┐ ┌──────────────┐ ┌──────────────┐
│ Registry │ │ Mixin │ │ Overlay │
│ recipes/ │ │ recipes/ │ │ recipes/ │
│ registry.yaml│ │ mixins/*.yaml│ │ overlays/ │
│ │ │ │ │ │
│ Component │ │ Composable │ │ Criteria- │
│ catalog + │ │ fragment │ │ matched │
│ defaults │ │ (constraints │ │ recipe with │
│ (chart, ns, │ │ + componentRefs)│ │ spec.base │
│ scheduling) │ │ │ │ inheritance │
└──────┬───────┘ └──────┬───────┘ └──────┬───────┘
│ │ │
└─────────────────┴─────────────────┘
│
▼
┌────────────────────┐
│ RecipeResult │
│ (merged, ordered, │
│ validated) │
└────────────────────┘
Resolution: the resolver loads the base spec (overlays/base.yaml) as
the merge seed, then merges each matching overlay's inheritance chain
on top (base → ... → leaf), then applies the leaf's mixins, then
finally injects registry defaults for any component field the chain
left unset. Per-component values files (recipes/components/<name>/)
are pulled in at bundle time, not at recipe resolution.
| Registry entry | Overlay | Mixin | |
|---|---|---|---|
| Purpose | Make a chart/kustomization available to recipes; set component-wide defaults | Pin versions, set values, scope by criteria | Share constraints or componentRefs across overlays |
| Authority | Component-wide (one entry per component) | Criteria-matched (selected by query) | Opt-in (referenced via spec.mixins) |
| File | recipes/registry.yaml (one entry) |
recipes/overlays/<name>.yaml (one file per shape) |
recipes/mixins/<name>.yaml (one file per fragment) |
| Lifecycle | Add once; bump defaultVersion on chart upgrade |
Add per cluster shape; cull when shape retires | Stable; new mixin only when ≥ 2 leaves duplicate the same block |
| Kind | ComponentRegistry |
RecipeMetadata |
RecipeMixin |
| Carries criteria? | No | Yes (spec.criteria) |
No (rejected at load) |
Carries base? |
No | Yes (single-parent chain) | No |
| Example | "make gpu-operator available, default to chart v25.10.1" |
"for eks + gb200 + training + ubuntu, pin K8s ≥ 1.32.4" |
"for any overlay opting in via mixins: [os-ubuntu], require Ubuntu 24.04" |
Rule of thumb: a change targeting all recipes goes in registry; a change targeting one cluster shape goes in an overlay; a change shared by ≥ 2 overlays as an opt-in fragment goes in a mixin.
The registry is the component catalog. Each entry declares a chart or
kustomization the resolver can reference and supplies defaults the
resolver injects into any ComponentRef that leaves the field unset.
Top-level schema (ComponentRegistry):
apiVersion: aicr.run/v1alpha2
kind: ComponentRegistry
components:
- name: <component-id>
...ComponentConfig fields (see pkg/recipe/components.go):
| Field | Type | Required | Purpose |
|---|---|---|---|
name |
string | yes | Component identifier (matches componentRefs[].name in overlays) |
displayName |
string | yes | Human label used in CLI output and bundle templates |
valueOverrideKeys |
[]string | no | Alt keys for --set <key>:path=value (e.g., gpuoperator) |
helm |
HelmConfig |
one of helm/kustomize | Chart defaults (see below) |
kustomize |
KustomizeConfig |
one of helm/kustomize | Kustomization defaults (see below) |
nodeScheduling |
NodeSchedulingConfig |
no | Helm value paths for injecting selectors/tolerations/taints (system, accelerated, plus nodeCountPaths) |
podScheduling |
PodSchedulingConfig |
no | Helm value paths for workload pod scheduling injection |
storageClassPaths |
[]string | no | Helm value paths where --storage-class is written |
validations |
[]ComponentValidationConfig |
no | Bundle-time validation checks (function, severity, conditions, message) |
healthCheck.assertFile |
string | yes | Chainsaw assert YAML (relative to data dir) consumed by aicr validate --phase deployment (runtime — #1220) and by make check-health locally. Content is restricted to the read-only assert / error operation allowlist. Enforced at PR time by pkg/recipe.TestComponentRegistry_RequiresHealthCheck (every component must declare a path) and validators/chainsaw.TestValidateTestReadOnly_RegistryContent (every declared path must pass the allowlist) — see #1223. |
gkeCriticalPriority |
bool | no | Synthesize ResourceQuota on GKE so system-*-critical pods admit |
hasSelfRefCRDs |
bool | no | Tells helmfile to emit disableValidation: true (chart ships CRD + CR in same release) |
manifestsUseChartCRDs |
bool | no | Tells helmfile to emit disableValidation: true on the release carrying the attached manifests — the injected -post wrapper, or the collapsed vendored folder under --vendor-charts (manifests create CRs of CRDs the chart installs) |
HelmConfig: defaultRepository, defaultChart, defaultVersion,
defaultNamespace. KustomizeConfig: defaultSource, defaultPath,
defaultTag. A component must have either helm or kustomize,
not both.
pkg/component/generic.go carries a ComponentConfig marked
Deprecated: — that is a separate, unused-in-production legacy type;
the live ComponentConfig is the one in pkg/recipe/components.go.
Defaults flow into a ComponentRef only when the field is empty —
see applyRegistryDefaults below. defaultVersion
is the single source of truth for a component's version and a pinned
overlay must not diverge from it unexpectedly — see
Version pinning is single-source.
An overlay is a RecipeMetadata document with a spec.criteria block
that selects it for matching queries. Overlays live in
recipes/overlays/ and inherit single-parent via spec.base.
kind: RecipeMetadata
apiVersion: aicr.run/v1alpha2
metadata:
name: gb200-eks-ubuntu-training
spec:
base: gb200-eks-training # inheritance chain root → leaf
mixins: # composed AFTER inheritance merge
- os-ubuntu
criteria:
service: eks # query → overlay selection
accelerator: gb200
os: ubuntu
intent: training
# platform: kubeflow # optional 6th dimension
constraints: # OS/K8s/GPU/SystemD constraints
- name: K8s.server.version
value: ">= 1.32.4"
componentRefs: [] # overrides on inherited components
validation: # per-phase validation config
readiness: { ... }
deployment: { ... }
performance: { ... }
conformance: { ... }Criteria fields (see pkg/recipe/criteria.go type Criteria):
| Field | Type | Wildcard | Static OSS values |
|---|---|---|---|
service |
CriteriaServiceType |
any or empty |
eks, gke, aks, oke, ocp, kind, lke, bcm |
accelerator |
CriteriaAcceleratorType |
any or empty |
h100, h200, gb200, b200, a100, l40, l40s, rtx-pro-6000 |
intent |
CriteriaIntentType |
any or empty |
training, inference |
os |
CriteriaOSType |
any or empty |
ubuntu, rhel, cos, amazonlinux, ol, talos |
platform |
CriteriaPlatformType |
any or empty |
dynamo, kubeflow, nim, runai, slurm |
nodes |
int | 0 |
any positive int |
--data overlays may contribute additional values via the criteria
registry — Has(FieldX, ...) is consulted when a value misses the
fast-path switch in Parse<X>. Adding a new value to a Go enum
(e.g., a new accelerator) is multi-file work; audit
CriteriaAccelerator* callers as listed in CLAUDE.md before merging.
Specificity. Each criteria carries a specificity score equal to
the count of non-any, non-empty fields. The current Specificity()
in criteria.go counts six fields: service, accelerator,
intent, os, platform, nodes. Overlays are sorted by
specificity ascending, so less-specific overlays merge first.
Matching is asymmetric. Recipe-side any is a wildcard (matches
anything in the query); query-side any is not a wildcard (matches
only recipe-side any). A generic query never resolves to a
hardware-specific recipe. See MatchesCriteriaField in
criteria.go.
Inheritance. spec.base walks a single-parent chain from leaf →
... → base (the root spec, held separately on the metadata store).
Cycles are detected at catalog load. Per-field merge: constraints
merge by name (later wins on same name; new appended); componentRefs
merge by name field-by-field; criteria are not inherited (each
recipe declares its own).
Leaf. A leaf is the most specific overlay in a chain — the
terminal node carrying fully-qualified criteria (every relevant
dimension set, e.g. service + accelerator + os + intent +
platform) that an end-user query actually resolves to. A leaf
usually adds little of its own (often componentRefs: []); its job is
to bind one inheritance chain plus its mixins under a single
criteria fingerprint. "Base → ... → leaf" throughout this page refers
to walking from the root spec down to this node. Leaf is a role, not a
distinct kind — every overlay is a RecipeMetadata; "leaf" just
names the ones at the end of a chain.
Inheritance is single-parent, which means cross-cutting concerns (OS
constraints, platform components) would otherwise duplicate across
every leaf. Mixins are composable fragments referenced via
spec.mixins. They live in recipes/mixins/ and use kind
RecipeMixin.
# recipes/mixins/os-ubuntu.yaml
kind: RecipeMixin
apiVersion: aicr.run/v1alpha2
metadata:
name: os-ubuntu
spec:
constraints:
- name: OS.release.ID
value: ubuntu
- name: OS.release.VERSION_ID
value: "24.04"
componentRefs: [] # optionalMixin files currently in the tree: os-ubuntu, os-talos,
platform-inference, platform-kubeflow.
Mixin rules:
- A mixin carries only
constraintsandcomponentRefs. Settingcriteria,base,mixins, orvalidationis rejected at load. - Resolution order: base chain merged first, then mixins applied to
the merged result. A leaf adopts a mixin by listing its file
basename in
spec.mixins. - Mixin componentRefs are restricted to additive merges via
mixinComponentRefSafeForMerge(seepkg/recipe/metadata_store.go). A mixin componentRef may only setname,namespace,manifestFiles,preManifestFiles. Setting any ofchart,type,source,version,tag,path,valuesFile,overrides,patches,dependencyRefs,cleanup,expectedResources,healthCheckAssertsis rejected at compose time — those fields silently override the chain's chosen chart, so the resolver names the offending field and refuses to merge (see ADR-005 "Silent constraint override" mitigation). - When a snapshot evaluator is wired in, mixin constraints are evaluated against it after merging; failure invalidates the entire composed candidate. In plain query mode mixin constraints are merged but not evaluated.
Some overlays apply across an entire criteria dimension without being
referenced via spec.base or spec.mixins. The resolver picks them
up automatically because FindMatchingOverlays returns all maximal
matches, not just the most specific one. Two wildcard patterns in
the tree today: gb200-any.yaml (matches service: any) and
monitoring-hpa.yaml (matches intent: any).
# recipes/overlays/gb200-any.yaml
spec:
base: base
criteria:
service: any # wildcard — matches eks, oke, gke, ...
accelerator: gb200
validation:
deployment:
constraints:
- name: Deployment.gpu-operator.version
value: ">= v25.10.0"For a query {service: eks, accelerator: gb200, intent: training},
the resolver returns three independent maximal leaves —
gb200-eks-training (matched by explicit criteria), gb200-any
(matched by service: any), and monitoring-hpa (matched by
intent: any). Each leaf's inheritance chain is resolved separately
and merged onto the base spec in specificity order.
Maximal-leaf filter. filterToMaximalLeaves (in
metadata_store.go) drops any match that is a transitive
spec.base ancestor of another match — ancestors re-enter the
output via chain resolution, so keeping them as separate matches
would double-count their contributions. Independent leaves on
unrelated chains (wildcard + explicit) are kept; one is not an
ancestor of the other.
When to use a wildcard overlay vs a mixin:
| Use a criteria-wildcard overlay when... | Use a mixin when... |
|---|---|
| Content applies based on query criteria | Content applies based on explicit opt-in |
| Consumer set is determined by matching | Consumer set is an enumerated list of leaves |
| Adopt-by-default is desired for new matching overlays | Each consumer should reference it explicitly |
You need a validation block (mixins can't carry one) |
You only need constraints / componentRefs |
Precedence. Leaves merge in specificity-ascending order, so a
service-specific leaf overrides the wildcard on same-named
constraints. spec.validation.<phase> blocks merge per-field:
checks and constraints union (nil = inherit, [] = clear,
non-empty = union); nodeSelection and infrastructure are
wholesale-replace. Don't carry per-fabric values in a wildcard
(NCCL bandwidth thresholds differ per service); reserve wildcards
for content genuinely uniform across the wildcard dimension.
The resolver lives in pkg/recipe/metadata_store.go. The merge
proceeds in this temporal order:
base chain (root → leaf) → mixins → registry defaults → CLI/API --set
The base inheritance chain is merged first (root → leaf, later
ancestors override earlier ones on same-named entries). Mixins are
applied after the chain, not before it: mergeMixins appends each
referenced mixin's constraints and componentRefs. A mixin constraint
whose name already exists in the chain (or in another mixin) is
rejected — constraints have no merge semantic, so a name collision
is treated as an unambiguous conflict, not resolved by last-wins
precedence. Registry defaults then fill any still-empty componentRef
fields, and CLI/API --set overrides win last.
Implementation notes:
- Seed.
initBaseMergedSpec()cloness.Base(parsed fromoverlays/base.yaml) into the merge target. The base spec is held separately on the metadata store; it is not an overlay candidate inFindMatchingOverlays. - Chain merge. For each maximal leaf, the inheritance chain is
walked root → leaf and
mergedSpec.Merge(&recipe.Spec)is called for each. Same-named constraints/componentRefs override; new entries append. - Mixin merge.
mergeMixins(mergedSpec)walksspec.mixinson the leaf, loads each fromrecipes/mixins/, and appends.mixinComponentRefSafeForMergerejects mixin componentRefs that touch identity/sourcing fields. - Registry defaults.
applyRegistryDefaults(provider, refs)fills in chart/version/namespace/source/tag/path defaults for anyComponentReffield still empty after the chain merge. Failure to load the registry is propagated, not swallowed — partial refs would fail downstream far from the root cause. - Topological sort.
TopologicalSort()orders components bydependencyRefsfor the finalDeploymentOrder. Cycles produceErrCodeInvalidRequest. Components disabled viaoverrides.enabled: false(ComponentRef.IsEnabled()) are excluded from the ordering, and an edge pointing at a declared-but-disabled component is treated as satisfied (assumed provided externally) so it does not trigger a false cycle; an edge to an undeclared component still surfaces asErrCodeInvalidRequest.TopologicalLevels()/ComponentRefsTopologicalLevels()apply the same filter.
Deep-copy semantics. deepMergeMap (metadata.go) recurses into
nested map[string]any. Non-map values (scalars and []any) are
deep-copied via serializer.DeepCopyAny so dst never aliases
src's slice values. This matters: copying []any by reference
during overlay merge would let a downstream mutation (e.g., bundler
appending a toleration) leak back into the cached source map and
corrupt subsequent queries. The
CLAUDE.md
anti-patterns list calls this out — any new helper that touches
overlay-derived maps must follow the same rule.
Recipe output is reproducible: same inputs → same bytes. The data layer enforces this via two rules.
Use serializer.MarshalYAMLDeterministic for any output that feeds
a digest, signature, OCI manifest, or fingerprint. yaml.v3 walks
Go maps in randomized order, so two consecutive marshals of the same
map[string]any produce different byte sequences. Plain
yaml.Marshal is fine for human-readable scratch output but is a
correctness bug anywhere a downstream consumer hashes the bytes.
Per-dimension ordered lists, not unordered maps. RecipeResult
fields like appliedOverlays, componentRefs, deploymentOrder,
and the per-dimension fingerprint diff are ordered slices, not maps,
so iteration is deterministic.
The metadata store is read-only after init. LoadMetadataStoreFor(dp)
returns a sync.Once-cached *MetadataStore per DataProvider
identity, so concurrent recipe builds against the same provider share
the store without locks. Per-request mutations (chain resolution,
constraint evaluation, registry defaulting) happen on clones, never
on the cached spec.
Deferred registration. pendingRegistryEntry stages each
overlay's criteria for the per-provider criteria registry before
registration. The actual Register(field, value, origin) calls only
fire after every overlay parses cleanly, the base recipe is present,
and dependency validation passes. Partial catalog loads never leak
into the registry; a malformed overlay does not poison criteria
validation for the next process.
Eviction. EvictCachedStore(provider) and
EvictCachedRegistry(provider) drop a single provider's cache entry
without disturbing other providers. Use after rewriting a --data
overlay on disk.
RecipeResult (in pkg/recipe/metadata.go) is the resolver's
externally-visible product. Fields beyond ComponentRefs and
DeploymentOrder that contributors should be aware of:
| Field | Purpose |
|---|---|
Metadata.AppliedOverlays |
Ordered list of overlays merged into this result (base first, leaf last). |
Metadata.ExcludedOverlays |
Overlays that matched criteria but were dropped (e.g., a mixin constraint failed against the snapshot). Each carries a typed Reason (constraint-failed, mixin-constraint-failed). |
Metadata.ConstraintWarnings |
Per-constraint detail for excluded overlays (overlay, constraint name, expected vs actual, reason text). |
Validation |
Multi-phase config (readiness, deployment, performance, conformance) inherited from overlay metadata. |
owner (unexported) |
*Builder that produced this result. AssertOwnedBy(b) enforces — two builders bound to different DataProviders must not cross-read each other's results. |
provider (unexported) |
DataProvider that produced this result; accessed via (*RecipeResult).DataProvider(). Lets GetValuesForComponent route file reads through the originating provider even after the package-global has rotated. |
ComponentRef extras beyond the chart-identity fields:
| Field | Purpose |
|---|---|
ManifestFiles |
Extra manifest files to bundle at sync-wave N+1 (after primary chart). Additive merge, dedup. |
PreManifestFiles |
Manifest files to bundle at sync-wave N-1 (before primary chart) — e.g., a Namespace with PSS labels the chart pods need. Additive merge, dedup; .. segments rejected at load. |
ExpectedResources |
List of {Kind, Name, Namespace} the deployment phase validator asserts exist. Overlay wholesale-replaces. |
HealthCheckAsserts |
Raw Chainsaw assert YAML loaded from the registry's healthCheck.assertFile; overlay wins if set. |
Cleanup |
Bundler uninstalls this component after validation (used for ephemeral validators like nccl-doctor). |
- Decide registry vs overlay vs mixin (decision matrix).
- Write the YAML in the correct directory. For an overlay, set
spec.baseto the most specific shared ancestor and let the chain carry shared constraints; only declare what differs. - Ship the chainsaw health check (registry entries only). Every
new component in
recipes/registry.yamlMUST declarehealthCheck.assertFilepointing atrecipes/checks/<name>/health-check.yaml, and that file MUST use only the read-onlyassert/erroroperation allowlist (noscript,apply,wait,command, etc. — seevalidators/chainsaw/allowlist.go). The contract is enforced at PR time bypkg/recipe.TestComponentRegistry_RequiresHealthCheckandvalidators/chainsaw.TestValidateTestReadOnly_RegistryContent— both gatemake qualify. See #1223 and the chainsaw health check section in validator.md for the assertion patterns currently in use (DaemonSetnumberReady == desiredNumberScheduled, DeploymentAvailable=True, CRDEstablished=True). - Run
make bom-docsand commitdocs/user/container-images.mdif your change touchesregistry.yaml, a component'svalues.yaml, or a chart version pin (see BOM regeneration). - Unit tests.
make testruns the recipe-resolution suite —pkg/recipe/yaml_test.go(static catalog: parse, refs, enum values, inheritance depth, no cycles) andpkg/recipe/metadata_test.go(runtime merge, topological sort). Both gatemake qualify. If your change adds a registry entry, a new overlay file, or a mixin, the static suite typically picks it up without new test code. - Integration validation. For a new chart pin, run
make qualifyand let the e2e pipeline render the bundle. KWOK simulated clusters (make kwok-e2e RECIPE=<name>) catch most resolution regressions without GPU hardware.
docs/user/container-images.md is auto-generated from the actual
rendered Helm templates of every chart referenced by the registry. It
is regenerated by make bom-docs.
Run make bom-docs and commit the regenerated
docs/user/container-images.md in the same PR whenever you:
- Add or remove a component in
recipes/registry.yaml - Bump a chart version (in
registry.yaml, an overlay, or a mixin) - Modify a component's
values.yamlin a way that changes which images render (image repo override, subchart enable/disable, etc.)
The regen can also surface drift from upstream chart updates — when a chart bumps an image inside its own templates without a registry pin change on our side. That drift will appear in the BOM diff whether you expected it or not.
TestCommittedBOMVersionsMatchRegistry (tools/bom/freshness_test.go,
run by make test → make qualify) checks the committed doc's version
column against the registry pins with no Helm rendering, so a chart-pin
bump that forgets make bom-docs fails CI. The check treats the doc as
an exact registry projection: it is bidirectional (a component added
to the registry without a doc row, or a doc row left behind after a
component is removed, both fail), rejects duplicate rows, and compares
every row — pinned components by their effective type (Helm
defaultVersion or Kustomize defaultTag) and unpinned components
against the — sentinel, so a fabricated version on an otherwise
unpinned row cannot slip through. Because a docs-only PR that edits the committed
BOM skips the full tests job, the bom-freshness job in
.github/workflows/merge-gate.yaml runs this same test whenever
docs/user/container-images.md or recipes/registry.yaml change, so
the gate holds for docs-only edits too.
TestCommittedBOMVariantsMatchRecipePins (same file, same jobs) gates
the doc's Version variants table the same way: it derives every
explicit base/overlay/mixin Helm pin that differs from its registry
default and compares bidirectionally — a new divergent pin without a
variant row fails, and a stale row without a backing pin fails. Variant
discovery reads only the recipe data (the pins are the source facts);
it has no dependency on the version-pin guard's exemption policy, which
decides whether a divergence is allowed, not what deploys.
Neither gate catches upstream image drift — a chart bumping an image
inside its own templates without a pin change on our side. Full make bom-check verifies that too by
re-rendering, but it is opt-in only — not wired into make qualify,
make lint, or the PR gate. So you still must run make bom-docs after
a values change.
The BOM renders each chart at its registry defaultVersion, but at
resolution the registry default is only a fallback: a componentRef
that sets version (Helm) or tag (Kustomize) in base.yaml, an
overlay, or a mixin overrides it. So the BOM reflects what recipes
actually install only when no pin diverges from the registry
default. A pin that drifts from the default — most dangerously on a
component whose sole consumer diverges — makes the BOM advertise a
version no recipe installs (issue #1424; #1418's aws-efa bug).
The registry defaultVersion is therefore the single source of truth
for a component's version. TestOverlayVersionPinsMatchRegistry
(pkg/recipe/version_pin_guard_test.go, run by make test →
make qualify) fails if any base/overlay/mixin pin diverges from the
registry default. A version bump must update the registry default (the
BOM reads it) and every pin that sets it, or CI fails. If an
overlay must legitimately run a different chart version (e.g. a
platform validated against an older chart), add an entry to
versionPinExemptions with a justification — a declared divergence is
not a silent one. Do not exempt a component whose only consumer
diverges; that reinstates the exact fiction the guard prevents.
- Skipping
make bom-docsafter a values change that alters rendered images. A stale version column now fails CI (TestCommittedBOMVersionsMatchRegistry), but image drift from a values change without a pin bump does not surface in qualify — the BOM goes stale silently. See Version freshness is gated; image drift is not. - Mutating in place during merge. Overlay-derived
map[string]anyand[]anymust be deep-copied, not aliased.deepMergeMapdoes this for you; a bespoke helper that recurses into maps but copies[]anyby reference will alias and corrupt the cached source map. - Plain
yaml.Marshalon output that feeds a digest. Useserializer.MarshalYAMLDeterministicfor any byte sequence a downstream consumer hashes (evidence predicate body, OCI manifest, signature input, fingerprint). - Adding a new criteria value to the Go enum but missing call
sites. A new accelerator, OS, intent, or platform value is
enumerated in many files — the criteria registry, OpenAPI spec,
every docs page that lists current values, issue templates, the
Specificity()helper. Start from the Go type incriteria.goand follow the audit list in CLAUDE.md. - Setting identity fields in a mixin componentRef when overriding
an inherited component. A mixin may not override
chart,version,valuesFile, etc. on a component the inheritance chain already carries — the resolver rejects with the offending field name. Move chart-changing logic to an overlay. (A mixin may still introduce a new component with these fields.) - Bumping a chart version in only one place. The registry
defaultVersionis the single source of truth; an overlayversionpin that drifts from it makes the BOM advertise a version no recipe installs.TestOverlayVersionPinsMatchRegistryfails on undeclared drift — see Version pinning is single-source. - Assuming the cluster fingerprint is trustworthy. The
fingerprint block persisted in
aicr snapshotoutput is advisory; trust-bearing consumers recompute viafingerprint.FromMeasurements(...)before acting. See the collector docs and ADR-007 for details.
- recipe-development.md — end-user recipe authoring guide
- component.md — adding a component to the registry
- validator.md — adding bundle-time component validation checks
- validator.md — adding a validator check or health check
- ADR-005 — overlay refactoring rationale (mixin composition, maximal-leaf resolver, wildcard overlays)
- ADR-007 — fingerprint, evidence bundle, verification
- pkg/recipe godoc — implementation
- api/aicr/v1/server.yaml — recipe API contract and criteria enums