markers

Documentation

Index

• Variables
• func Register(reg *markers.Registry) error
• type ClaimNames
  • func (c ClaimNames) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error
• type DefaultCompositeDeletePolicy
  • func (c DefaultCompositeDeletePolicy) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error
• type DefaultCompositionRef
  • func (c DefaultCompositionRef) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error
• type EnforcedCompositionRef
  • func (c EnforcedCompositionRef) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error

Variables

var AllDefinitions []*definitionWithHelp

AllDefinitions contains all marker definitions for this package.

var XRDMarkers = []*definitionWithHelp{
	must(markers.MakeDefinition("crossbuilder:generate:xrd:claimNames", markers.DescribesType, ClaimNames{})),
	must(markers.MakeDefinition("crossbuilder:generate:xrd:defaultCompositionRef", markers.DescribesType, DefaultCompositionRef{})),
	must(markers.MakeDefinition("crossbuilder:generate:xrd:enforcedCompositionRef", markers.DescribesType, EnforcedCompositionRef{})),
	must(markers.MakeDefinition("crossbuilder:generate:xrd:defaultCompositeDeletePolicy", markers.DescribesType, DefaultCompositeDeletePolicy{})),
}

XRDMarkers lists all markers that directly modify the XRD (not validation schemas).

Functions

func Register

func Register(reg *markers.Registry) error

Register registers all definitions for CRD generation to the given registry.

Types

type ClaimNames

type ClaimNames struct {
	Kind       string   `marker:"kind"`
	Plural     string   `marker:"plural"`
	Singular   string   `marker:"singular,optional"`
	ShortNames []string `marker:"shortNames,optional"`
	ListKind   string   `marker:"listKind,optional"`
	Categories []string `marker:"categories,optional"`
}

ClaimNames is a marker to specify claim names for generated XRDs.

func (ClaimNames) ApplyToXRD

func (c ClaimNames) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error

ApplyToXRD applies the claim names to the XRD.

type DefaultCompositeDeletePolicy

type DefaultCompositeDeletePolicy struct {
	Policy xpv1.CompositeDeletePolicy `marker:"policy"`
}

DefaultCompositeDeletePolicy is a marker to specify the default composite delete policy of an XRD.

func (DefaultCompositeDeletePolicy) ApplyToXRD

func (c DefaultCompositeDeletePolicy) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error

ApplyToXRD applies the enforced composition ref to the XRD.

type DefaultCompositionRef

type DefaultCompositionRef struct {
	Name string `marker:"name"`
}

DefaultCompositionRef is a marker to specify the default composition ref of an XRD.

func (DefaultCompositionRef) ApplyToXRD

func (c DefaultCompositionRef) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error

ApplyToXRD applies the default composition ref to the XRD.

type EnforcedCompositionRef

type EnforcedCompositionRef struct {
	Name string `marker:"name"`
}

EnforcedCompositionRef is a marker to specify the enforced composition ref of an XRD.

func (EnforcedCompositionRef) ApplyToXRD

func (c EnforcedCompositionRef) ApplyToXRD(xrd *xapiext.CompositeResourceDefinition, version string) error

ApplyToXRD applies the enforced composition ref to the XRD.