schemapatcher

Documentation

Index

• type Generator
  • func (g Generator) Generate(ctx *genall.GenerationContext) (result error)
  • func (Generator) RegisterMarkers(into *markers.Registry) error

Types

type Generator

type Generator struct {
	// ManifestsPath contains the CustomResourceDefinition YAML files.
	ManifestsPath string `marker:"manifests"`

	// MaxDescLen specifies the maximum description length for fields in CRD's OpenAPI schema.
	//
	// 0 indicates drop the description for all fields completely.
	// n indicates limit the description to at most n characters and truncate the description to
	// closest sentence boundary if it exceeds n characters.
	MaxDescLen *int `marker:",optional"`
}

Generator patches existing CRDs with new schemata.

For single-version CRDs, it will simply replace the global schema.

For multi-version CRDs, it will replace schemata of existing versions and *clear the schema* from any versions not specified in the Go code. It will *not* add new versions, or remove old ones.

For multi-version CRDs with identical schemata, it will take care of lifting the per-version schema up to the global schema.

func (Generator) Generate

func (g Generator) Generate(ctx *genall.GenerationContext) (result error)

func (Generator) RegisterMarkers

func (Generator) RegisterMarkers(into *markers.Registry) error