crdref

Overview ¶

Command crdref generates the operator resource reference, the block between the marker comments in docs/site/reference/operator-resources.md, from the operator's own sources:

• config/crd/bases: one entry per CustomResourceDefinition, its summary, names, printer columns, spec and status fields and every rule the API server enforces from the schema;
• config/samples: the entry's example, from the kubebuilder sample named <group>_<version>_<kind>.yaml when one exists;
• internal/controller: the controller that reconciles the kind.

An entry states only what those sources show: a part with nothing to show is left out. With -check, crdref writes nothing and fails when the committed page differs from what it would generate.