crd

Documentation

Index

• type CRDHandler
  • func NewCRDHandler(client crdclient.Interface) *CRDHandler
  • func (h *CRDHandler) EnsureCRD(meta *CRDMeta, namespacedScoped bool) (*apiextensionsv1.CustomResourceDefinition, error)
• type CRDMeta
  • func NewCRDMeta(groupName, kind, listKind, singular, plural string, versions []*Version, ...) *CRDMeta
• type Version
  • func NewVersion(name, typeSource string, fn common.GetOpenAPIDefinitions, deprecated bool) *Version

Types

type CRDHandler

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

CRDHandler takes care of ensuring CRD's for a cluster.

func NewCRDHandler

func NewCRDHandler(client crdclient.Interface) *CRDHandler

NewCRDHandler returns a new CRDHandler.

func (*CRDHandler) EnsureCRD

func (h *CRDHandler) EnsureCRD(meta *CRDMeta, namespacedScoped bool) (*apiextensionsv1.CustomResourceDefinition, error)

EnsureCRD ensures a CRD in a cluster given the CRD's metadata.

type CRDMeta

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

CRDMeta contains version, validation and API information for a CRD.

func NewCRDMeta

func NewCRDMeta(groupName, kind, listKind, singular, plural string, versions []*Version, shortNames ...string) *CRDMeta

NewCRDMeta creates a CRDMeta type which can be passed to a CRDHandler in order to create/ensure a CRD.

type Version

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

Version specifies the API version and meta information that is needed to generate OpenAPI schema based CRD validation.

func NewVersion

func NewVersion(name, typeSource string, fn common.GetOpenAPIDefinitions, deprecated bool) *Version

NewVersion returns a CRD API version with validation metadata.