emptypartialschemas

Documentation

Index

• func DefaultNameSystem() string
• func NameSystems() namer.NameSystems
• func NewGenFeatureGatedPartialSchemas(sanitizedName, targetPackage string, crdInfoTracker *generatorResultGatherer, ...) gengogenerator.Generator
• func NewGenerator(opts Options) generation.Generator
• func ReadCustomResourceDefinitionV1(objBytes []byte) (*apiextensionsv1.CustomResourceDefinition, error)
• func ReadCustomResourceDefinitionV1OrDie(objBytes []byte) *apiextensionsv1.CustomResourceDefinition
• func WriteSpecOnlyCustomResourceDefinitionV1(obj *apiextensionsv1.CustomResourceDefinition) ([]byte, error)
• type CRDInfo
• type CustomArgs
• type Options

Functions

func DefaultNameSystem

func DefaultNameSystem() string

DefaultNameSystem returns the default name system for ordering the types to be processed by the generators in this package.

func NameSystems

func NameSystems() namer.NameSystems

NameSystems returns the name system used by the generators in this package.

func NewGenFeatureGatedPartialSchemas

func NewGenFeatureGatedPartialSchemas(sanitizedName, targetPackage string, crdInfoTracker *generatorResultGatherer, groupName string) gengogenerator.Generator

func NewGenerator

func NewGenerator(opts Options) generation.Generator

NewGenerator builds a new empty-partial-schemas generator.

func ReadCustomResourceDefinitionV1

func ReadCustomResourceDefinitionV1(objBytes []byte) (*apiextensionsv1.CustomResourceDefinition, error)

func ReadCustomResourceDefinitionV1OrDie

func ReadCustomResourceDefinitionV1OrDie(objBytes []byte) *apiextensionsv1.CustomResourceDefinition

func WriteSpecOnlyCustomResourceDefinitionV1

func WriteSpecOnlyCustomResourceDefinitionV1(obj *apiextensionsv1.CustomResourceDefinition) ([]byte, error)

Types

type CRDInfo

type CRDInfo struct {
	CRDName                  string
	TopLevelFeatureGates     []string
	GroupName                string
	Version                  string
	PluralName               string
	KindName                 string
	Scope                    string
	HasStatus                bool
	FeatureGates             []string
	ShortNames               []string
	Category                 string
	ApprovedPRNumber         string
	FilenameRunLevel         string
	FilenameOperatorName     string
	FilenameOperatorOrdering string
	Capability               string
	PrinterColumns           []apiextensionsv1.CustomResourceColumnDefinition
	Annotations              map[string]string
	Labels                   map[string]string
}

type CustomArgs

type CustomArgs struct {
	BoundingDirs []string // Only deal with types rooted under these dirs.
}

CustomArgs is used tby the go2idl framework to pass args specific to this generator.

type Options

type Options struct {
	// Disabled indicates whether the empty-partial-schemas generator is enabled or not.
	// This default to false as the empty-partial-schemas generator is enabled by default.
	Disabled bool

	// OutputFileBaseName is the base name of the output file.
	// When omitted, DefaultOutputFileBaseName is used.
	// The current value of DefaultOutputFileBaseName is "MISSING".
	OutputFileBaseName string

	// Verify determines whether the generator should verify the content instead
	// of updating the generated file.
	Verify bool
}

Options contains the configuration required for the compatibility generator.