About This Tool

Primary Use Case

Key Features

• Aggregates hundreds of popular Kubernetes CRDs in JSON schema format
• Supports validation with tools like Datree, Kubeconform, and kubeval (with CRD Extractor)
• Enables local and CI-based schema validation without cluster access (shift-left approach)
• Provides VS Code intellisense and validation via Red Hat YAML plugin integration
• Includes a CRD Extractor utility to convert cluster CRDs to JSON schema for air-gapped environments
• Supports MacOS and Linux platforms for the CRD Extractor utility
• Automates YAML schema annotation with an included Python script

Insights & Recommendations

The CRD Extractor requires python3 and kubectl installed and supports MacOS and Linux platforms. Using this catalog enables a shift-left validation approach, allowing schema validation without cluster access, which is ideal for local development and CI pipelines. For YAML intellisense in VS Code, annotate manifests with the $schema property pointing to the relevant JSON schema URL. The included annotate-yaml.py script can automate this annotation process.

Installation

Download the latest release of the CRD Extractor from the repository releases page
Extract the downloaded crd-extractor.zip file
Ensure python3 and kubectl are installed on your machine
Run the CRD Extractor utility using ./crd-extractor.sh

Usage

Smart Usage Notes

• Integrate CRDs catalog validation into CI/CD pipelines to enforce secure Kubernetes configurations before deployment.
• Use the CRD Extractor utility to maintain up-to-date schemas in air-gapped or restricted environments, enhancing offline validation capabilities.
• Combine with Kubernetes admission controllers to automate policy enforcement using validated CRD schemas.
• Leverage VS Code intellisense integration for developer training and reducing misconfigurations at the source code level.
• Employ schema validation as a proactive defense to reduce attack surface caused by misconfigured or malicious custom resources.

Security Capability Profile