k8s-crd-design-review

Analyze Kubernetes CRD YAML manifests for schema, CEL, and compatibility issues.

Updated Aug 27, 2026
One-click install
npx skills add https://github.com/promptlylabs/skills --skill k8s-crd-design-review
Or copy as Structured Prompt for Agent
Please help me install this Agent Skill.
Skill: k8s-crd-design-review
Source: https://github.com/promptlylabs/skills/tree/main/plugins/promptly-skills/skills/k8s-crd-design-review
Command: npx skills add https://github.com/promptlylabs/skills --skill k8s-crd-design-review

SYSTEM DOCUMENTATION & REQUIREMENTS

💡 This Skill includes references (resource) components.

What problem does it solve?

Reviews Kubernetes CRD designs to ensure the API contract is strict, evolvable, and aligned with Kubernetes conventions.

Core Features & Use Cases

  • Deterministic CRD review workflow covering schema validation, CEL constraints, and webhook considerations.
  • Guidance on status subresources, conditions, observedGeneration, and printer-columns to improve operator observability and GitOps readiness.
  • Versioning and migration planning to minimize breaking changes and facilitate safe API evolution.

Quick Start

Provide a CRD YAML manifest and intended API semantics to start a design review and generate a compatibility assessment.

Frequently Asked Questions about k8s-crd-design-review

High-intent search queries and answers about installing and using this skill.

FAQPage Schema
How do I review a Kubernetes CRD for safe API design and evolution?

To review a Kubernetes CRD for safe API design, validate schema invariants, status conventions, and reference patterns. Apply cross-field CEL rules, subresource usage, and GitOps compatibility checks to ensure a strict, evolvable API contract aligned with Kubernetes conventions.

What is the best way to validate cross-field rules in Kubernetes CRDs?

The best way to validate cross-field rules in Kubernetes CRDs is by applying CEL validations. This enforces schema invariants and safe API semantics directly within the CRD, ensuring robust constraints without relying solely on external webhooks.

How does GitOps compatibility affect Kubernetes CRD status subresource design?

GitOps compatibility requires strict separation of spec and status subresources in Kubernetes CRDs. Designing status conventions with conditions and observedGeneration improves operator observability and prevents automated reconcilers from overwriting desired state.

When do I need webhooks for Kubernetes CRD validation versus CEL expressions?

You need webhooks for Kubernetes CRD validation when logic exceeds CEL expression capabilities or requires external data lookups. Use focused webhooks for complex admission control, while relying on CEL for structural schema invariants and standard field constraints.

How do I plan versioning and migration to minimize breaking changes in Kubernetes CRDs?

To plan versioning and migration in Kubernetes CRDs, audit API semantics and structural schemas to identify breaking changes. Generate a formal compatibility assessment and actionable change recommendations to facilitate safe API evolution across versions.

Can I audit operator observability through Kubernetes CRD printer-columns?

Yes, you can audit operator observability through Kubernetes CRD printer-columns. Defining appropriate printer-columns alongside status conditions and observedGeneration enhances CLI visibility and improves operational readiness for cluster operators.