crds

Documentation

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) Build() (*apiext.CustomResourceDefinition, error)
  • func (b *Builder) WithGroup(groupName string) *Builder
  • func (b *Builder) WithKind(kind string) *Builder
  • func (b *Builder) WithListKind(listKind string) *Builder
  • func (b *Builder) WithName(name string) *Builder
  • func (b *Builder) WithPlural(plural string) *Builder
  • func (b *Builder) WithPrinterColumns(columnName, columnType, jsonPath string) *Builder
  • func (b *Builder) WithScope(scope apiext.ResourceScope) *Builder
  • func (b *Builder) WithShortNames(shortNames []string) *Builder
  • func (b *Builder) WithVersion(version string) *Builder
• type CustomResource
  • func (cr *CustomResource) GetAPIObject() *apiext.CustomResourceDefinition

Types

type Builder

type Builder struct {
	// contains filtered or unexported fields
}

Builder is struct used to build the CRD object

func NewBuilder

func NewBuilder() *Builder

NewBuilder returns a new builder for creating CRD

func (*Builder) Build

func (b *Builder) Build() (*apiext.CustomResourceDefinition, error)

Build returns the CustomResourceDefinition from the builder

func (*Builder) WithGroup

func (b *Builder) WithGroup(groupName string) *Builder

WithGroup is used to add group field to the CRD

func (*Builder) WithKind

func (b *Builder) WithKind(kind string) *Builder

WithKind is used to add kind field to the CRD

func (*Builder) WithListKind

func (b *Builder) WithListKind(listKind string) *Builder

WithListKind is used to add listkind field to the CRD

func (*Builder) WithName

func (b *Builder) WithName(name string) *Builder

WithName is used to add name field to the CRD

func (*Builder) WithPlural

func (b *Builder) WithPlural(plural string) *Builder

WithPlural is used to add plural field to the CRD

func (*Builder) WithPrinterColumns

func (b *Builder) WithPrinterColumns(columnName, columnType, jsonPath string) *Builder

WithPrinterColumns is used to add printercolumns field to the CRD

func (*Builder) WithScope

func (b *Builder) WithScope(scope apiext.ResourceScope) *Builder

WithScope is used to add scope field to the CRD

func (*Builder) WithShortNames

func (b *Builder) WithShortNames(shortNames []string) *Builder

WithShortNames is used to add shortnames field to the CRD

func (*Builder) WithVersion

func (b *Builder) WithVersion(version string) *Builder

WithVersion is used to add version field to the CRD

type CustomResource

type CustomResource struct {
	// contains filtered or unexported fields
}

CustomResource is a wrapper over the CustomResourceDefinition of apiextensions, used to build the CRD object

func (*CustomResource) GetAPIObject

func (cr *CustomResource) GetAPIObject() *apiext.CustomResourceDefinition

GetAPIObject returns the CRD API from the wrapper struct