crdreference

command
v0.2.2 Latest Latest
Warning

This package is not in the latest version of its module.

Go to latest
Published: Oct 11, 2026 License: MIT Imports: 11 Imported by: 0

Documentation

Overview

crdreference renders the field reference for every custom resource this operator ships.

The source is the CRD schema rather than the Go source, because the schema is what the API server enforces: a type, a required list, an enum, a default and a list semantic all reach a reader the way a cluster will apply them. The schemas it reads are generated with descriptions, which the shipped ones drop (`crd:maxDescLen=0`), so the page carries the doc comments the Go types hold without the CRDs in etcd carrying them too.

The pages are checked in and regenerated by `make docs-reference`. Running it without -write refuses a page that no longer matches the API, which is how a field added to a Go type cannot leave the reference behind.

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL