CheatPress

kubeconform Manifest schema validator

Version 0.8.0 · source

kubeconform, Postcard, light preview Light · Postcard 102 × 152 mm · PDF kubeconform, Postcard, dark preview Dark · Postcard 102 × 152 mm · PDF kubeconform, Postcard, ink saver preview Ink saver · Postcard 102 × 152 mm · PDF
kubeconform, A5, light preview Light · A5 148 × 210 mm · PDF kubeconform, A5, dark preview Dark · A5 148 × 210 mm · PDF kubeconform, A5, ink saver preview Ink saver · A5 148 × 210 mm · PDF
kubeconform, A4, light preview Light · A4 210 × 297 mm · PDF kubeconform, A4, dark preview Dark · A4 210 × 297 mm · PDF kubeconform, A4, ink saver preview Ink saver · A4 210 × 297 mm · PDF
kubeconform, A4 landscape, light preview Light · A4 landscape 297 × 210 mm · PDF kubeconform, A4 landscape, dark preview Dark · A4 landscape 297 × 210 mm · PDF kubeconform, A4 landscape, ink saver preview Ink saver · A4 landscape 297 × 210 mm · PDF
kubeconform, A3, light preview Light · A3 297 × 420 mm · PDF kubeconform, A3, dark preview Dark · A3 297 × 420 mm · PDF kubeconform, A3, ink saver preview Ink saver · A3 297 × 420 mm · PDF
kubeconform, A3 landscape, light preview Light · A3 landscape 420 × 297 mm · PDF kubeconform, A3 landscape, dark preview Dark · A3 landscape 420 × 297 mm · PDF kubeconform, A3 landscape, ink saver preview Ink saver · A3 landscape 420 × 297 mm · PDF
kubeconform, Letter, light preview Light · Letter 8.5 × 11 in · PDF kubeconform, Letter, dark preview Dark · Letter 8.5 × 11 in · PDF kubeconform, Letter, ink saver preview Ink saver · Letter 8.5 × 11 in · PDF
kubeconform, Tabloid, light preview Light · Tabloid 11 × 17 in · PDF kubeconform, Tabloid, dark preview Dark · Tabloid 11 × 17 in · PDF kubeconform, Tabloid, ink saver preview Ink saver · Tabloid 11 × 17 in · PDF

Start here

kubeconform <file>
Validate one manifest
kubeconform <dir>
Validate a folder
kubeconform -summary <dir>
Add totals
kubeconform -strict <dir>
Reject unknown fields
kubeconform -kubernetes-version 1.30.0 <dir>
Pick a cluster version
kubeconform -ignore-missing-schemas <dir>
Skip unknown kinds
kubeconform -output pretty <dir>
Readable results
helm template <chart> | kubeconform -
Check rendered output

Concepts

  1. Manifests files, dirs, stdin
  2. Schema lookup kind + apiVersion
  3. Result valid / invalid / skipped

Running

kubeconform <file>
Validate one manifest
kubeconform <dir> <file>
Validate several paths at once
kubeconform -
Read manifests from stdin
kubeconform -summary <dir>
Print totals at the end
kubeconform -verbose <dir>
Show valid resources too
kubeconform -exit-on-error <dir>
Stop at the first failure
kubeconform -ignore-filename-pattern '<regex>' <dir>
Skip matching paths
kubeconform -n 16 <dir>
Use more parallel workers
kubeconform -v
Print the version
kubeconform -h
Show all flags
kubeconform -debug <dir>
Print debug information

Strictness and versions

kubeconform -strict <dir>
Fail on unknown or duplicate keys
kubeconform -kubernetes-version 1.30.0 <dir>
Validate against that Kubernetes version
Default is master, which tracks the newest schemas. Pin it to your cluster's version.
kubeconform -ignore-missing-schemas <dir>
Skip kinds without a schema
kubeconform -skip <kind>,<kind> <dir>
Ignore kinds, all API versions
kubeconform -skip v1/<Kind> <dir>
Ignore one group/version of a kind
kubeconform -reject <kind> <dir>
Fail on listed kinds or GVKs

Schemas and CRDs

kubeconform -schema-location default <dir>
Use the built-in schema source
kubeconform -schema-location '<url-or-path-template>' <dir>
Add a custom schema location
kubeconform -cache <dir> <manifests>
Cache downloaded schemas on disk
kubeconform -insecure-skip-tls-verify <dir>
Skip TLS checks on schema hosts
Template variables for -schema-location
Variable Expands to
{{.ResourceKind}} Kind of the resource
{{.ResourceAPIVersion}} Version part of apiVersion
{{.Group}} API group
{{.NormalizedKubernetesVersion}} Version with a v prefix
{{.StrictSuffix}} -strict when -strict is set
{{.KindSuffix}} Group and version suffix

Output

kubeconform -output pretty <dir>
Coloured, human-readable output
kubeconform -output json <dir>
Machine-readable result
kubeconform -output junit <dir>
JUnit XML for CI reports
kubeconform -output tap <dir>
TAP format
kubeconform -output text <dir>
Plain text, the default

Recipes

Validate a Helm chart
helm template <release> <chart> -f values.yaml \  | kubeconform -strict -summary -kubernetes-version 1.30.0 -
Validate a kustomize overlay
kustomize build overlays/prod \  | kubeconform -strict -ignore-missing-schemas -summary -
Include CRDs from the Datree catalog
kubeconform -strict -summary -schema-location default \  -schema-location 'https://raw.githubusercontent.com/datreeio/CRDs-catalog/main/{{.Group}}/{{.ResourceKind}}_{{.ResourceAPIVersion}}.json' \  manifests/
CI check with a schema cache
mkdir -p /tmp/schemaskubeconform -cache /tmp/schemas -n 8 -output junit manifests/ > report.xml