K8S Crd Design Review

Kubernetes CRD Design Review

Perform a deterministic design + contract review for Kubernetes CRDs (the generated CRD YAML is the compiled API contract).

Inputs

Accept at least one of:

• CRD YAML (full manifest) or a CRD diff
• A short description of intended API semantics and controller behavior

If key info is missing, ask for it before concluding compatibility/migration:

• Whether a controller exists, what it owns, and whether it writes status
• Whether this is a new API or a change to an existing API
• Served versions, storage version, and existing clients
• Whether objects already exist in clusters (migration needed?)
• Any GitOps/SSA constraints (patch strategy, desired stable identities)

Workflow (always follow this order)

1) Identify scope

• Identify group, kind(s), version(s), and whether this is new vs change.
• Identify controller existence and ownership boundaries.
• If reviewing Go types, confirm which generated CRD YAML(s) correspond to them.

2) Contract integrity checks (spec/status + controller operability)

• Spec vs status boundary
  • spec = user intent / desired state.
  • status = controller-observed state.
  • Flag lifecycle/state-machine fields in spec if the controller owns transitions.
• Require subresources.status when a controller exists and writes status
• Conditions + observedGeneration
  • Recommend status.conditions and status.observedGeneration (Kubernetes conventions; critical for tooling/GitOps correctness).
  • Model Conditions as a map keyed by type, not a chronological list: prefer schema markers (x-kubernetes-list-type: map with x-kubernetes-list-map-keys: [type]) for SSA/GitOps safety.
  • Use state-style Condition types (adjectives/past tense: Ready, Degraded, Succeeded; avoid transition names or phases for new APIs).
  • Include one high-signal summary condition (Ready for long-running; Succeeded for bounded execution).
  • For GitOps/status-tool compatibility, check the kstatus shape: Ready as aggregate current-state signal, Reconciling=True for active progress, Stalled=True for blocked/broken progress, and current observedGeneration.
  • Flag status.phase / status.state when it is the primary lifecycle contract for a new CRD; conditions should be the primary machine-readable readiness contract.
  • Ensure each Condition has semantic True/False/Unknown values with consistent meaning.
  • Remember: status updates via /status subresource use separate RBAC.

See ./references/conditions-and-status.md for deeper semantics and ./references/kstatus-readiness.md for kstatus compatibility.

3) Schema correctness & validation (prevent invalid stored objects)

Use a 3-step validation hierarchy: always exhaust each level before moving to the next.

Step 1: Schema validation (required)

Review the OpenAPI v3 schema (prefer the generated CRD YAML/diff):

• Required fields for true invariants
• Enums for constrained strings
• Defaulting and nullable behavior
• Type constraints, patterns, min/max bounds
• Structural schema: ensure spec.preserveUnknownFields: false for strict validation and automatic version conversion
• Object references & relationships: Classify the relationship before judging its shape: fixed-kind, bounded multi-kind, generic-object, or field reference. Prefer explicit fooRef / fooRefs objects to a bare fooName string, but a fixed-kind reference normally needs only {name} (and an explicit namespace only when cross-namespace use is intentional).
  • Require a non-empty name inside a reference object. Put group, kind, or resource in the instance only when the user actually selects a target type; do not default a single allowed value merely as speculative tooling metadata.
  • For a fixed-kind {name} reference, ensure the field name and field documentation identify the target kind and scope. A generic navigation tool needs a separately published relationship map; ordinary CRD structural schema does not encode that mapping.
  • When a review concerns editor navigation or resource-graph tooling, see ./references/relationship-metadata.md.
  • Omit namespace unless you explicitly allow cross-namespace references.
  • Avoid apiVersion in references; let the controller map versions.
  • Keep UID/resourceVersion in status, not spec, unless there is an exceptional API requirement.
  • Treat cross-namespace references as security-sensitive. Prefer same-namespace references; if cross-namespace is intentional, require explicit scope semantics and consider a ReferenceGrant-style producer opt-in.
  • dependsOn is an advisable (community) deviation from the fooRefs advise. Use it when you explicitly model a dependency graph and your controller implements full DAG semantics (readiness definition, scope rules, cycle detection). See ./references/object-references.md.
  • Use parentRef only for resources your operator directly manages; do not use it to model general relationships.
  • See ./references/object-references.md for schema examples and deeper guidance.

Step 2: CEL validation (before webhooks)

When cross-field invariants or complex constraints cannot be expressed with basic OpenAPI rules, use CEL (x-kubernetes-validations):

• Cross-field invalid combinations (e.g., "field A only allowed if field B is set")
• Exactly-one-of constraints
• Numeric range relationships between fields
• Enum dependencies

Best practice: Write minimal, targeted rules with clear error messages. CEL is stateless, auditable, and version-safe—always prefer it to webhooks. See ./references/validation-and-cel.md for examples.

Step 3: Webhooks (only if Steps 1–2 are insufficient)

Only recommend webhooks when schema and CEL cannot express the constraint. This is a significant operational decision. Always double-check first:

• Can this be expressed with required fields, enums, or patterns?
• Can this be expressed with CEL (stateless, auditable, version-safe)?
• Is the webhook truly necessary, or is the controller solving it better?
• Webhooks add latency, availability risk, and debugging complexity—operational costs often exceed benefits.

If a webhook is necessary:

• Conversion webhooks: Use only if structural schema conversion insufficient.
• Validation/mutation webhooks: Configure with explicit timeouts, failurePolicy, and namespaceSelectors.
• Validate webhook availability and latency in your rollout plan.

See ./references/versioning-and-migrations.md for conversion strategy and ./references/review-template.md for operational checklist.

4) GitOps/SSA ergonomics

Focus on patchability and stable diffs:

• List semantics for arrays of objects
  • If items have stable identity (e.g., name, id), prefer map-like lists (x-kubernetes-list-type: map with x-kubernetes-list-map-keys).
  • Identify ordering sensitivity and full-array replacement hazards.

See ./references/list-semantics-gitops-ssa.md.

5) Operator UX (kubectl)

Review/add additionalPrinterColumns for operator-facing UX:

• Ready / health signal
• Status message / reason
• Key spec fields
• Never duplicate AGE (already shown by kubectl).

See ./references/printer-columns.md.

6) Compatibility & migration impact (mandatory)

Always include an explicit compatibility assessment:

• Classify change as non-breaking vs potentially breaking.
• Look beyond removals: tightening validation, type changes, list semantic changes, defaulting changes, semantic behavior shifts.
• If version evolution is involved: plan served versions, conversion webhooks, storage migration, and deprecation playbook.

See ./references/versioning-and-migrations.md.

7) Synthesize output

Follow the output template structure below:

• Rank risks + explain impact.
• List actionable changes with snippets.
• Provide PR-sized improvement plan.
• Include the PR review template (use ./references/review-template.md as the canonical template).

Output format (always use this template)

What’s good

• …

Top risks (ranked)

1. … — why it matters: …
2. … — why it matters: …
3. … — why it matters: …

Recommended changes (actionable)

• Change: …
  • Why: …
  • Snippet:

    # ...
    

Compatibility & migration impact (mandatory)

• Breaking? Yes/No
• Why: …
• If breaking or risky:
  • Migration / deprecation steps:
    1. …
    2. …
  • Rollout plan checklist:
    • …
    • …
  • Versioning notes: served versions, storage version, conversion considerations

Minimal improvement plan (PR-sized)

1. …
2. …
3. …

Template reference: Use ./references/review-template.md as the canonical template. Adapt to context while preserving section headings.