ccrd

Documentation

Overview

Package ccrd generates CustomResourceDefinitions from Crossplane definitions.

v1beta1.JSONSchemaProps is incompatible with controller-tools (as of 0.2.4) because it is missing JSON tags and uses float64, which is a disallowed type. We thus copy the entire struct as CRDSpecTemplate. See the below issue: https://github.com/kubernetes-sigs/controller-tools/issues/291

Index

• Constants
• func BaseProps() map[string]v1beta1.JSONSchemaProps
• func CompositeResourceClaimPrinterColumns() []v1beta1.CustomResourceColumnDefinition
• func CompositeResourceClaimSpecProps() map[string]v1beta1.JSONSchemaProps
• func CompositeResourcePrinterColumns() []v1beta1.CustomResourceColumnDefinition
• func CompositeResourceSpecProps() map[string]v1beta1.JSONSchemaProps
• func CompositeResourceStatusProps() map[string]v1beta1.JSONSchemaProps
• func IsEstablished(s v1beta1.CustomResourceDefinitionStatus) bool
• func New(o ...Option) (*v1beta1.CustomResourceDefinition, error)
• func NewSpec(t v1alpha1.CRDSpecTemplate) (v1beta1.CustomResourceDefinitionSpec, error)
• type Option
  • func ForCompositeResource(d *v1alpha1.CompositeResourceDefinition) Option
  • func ForCompositeResourceClaim(d *v1alpha1.CompositeResourceDefinition) Option

Constants

const (
	CategoryClaim     = "claim"
	CategoryComposite = "composite"
)

Category names for generated claim and composite CRDs.

Functions

func BaseProps

func BaseProps() map[string]v1beta1.JSONSchemaProps

BaseProps is a partial OpenAPIV3Schema for the spec fields that Crossplane expects to be present for all CRDs that it creates.

func CompositeResourceClaimPrinterColumns

func CompositeResourceClaimPrinterColumns() []v1beta1.CustomResourceColumnDefinition

CompositeResourceClaimPrinterColumns returns the set of default printer columns that should exist in all generated composite resource claim CRDs.

func CompositeResourceClaimSpecProps

func CompositeResourceClaimSpecProps() map[string]v1beta1.JSONSchemaProps

CompositeResourceClaimSpecProps is a partial OpenAPIV3Schema for the spec fields that Crossplane expects to be present for all published infrastructure resources.

func CompositeResourcePrinterColumns

func CompositeResourcePrinterColumns() []v1beta1.CustomResourceColumnDefinition

CompositeResourcePrinterColumns returns the set of default printer columns that should exist in all generated composite resource CRDs.

func CompositeResourceSpecProps

func CompositeResourceSpecProps() map[string]v1beta1.JSONSchemaProps

CompositeResourceSpecProps is a partial OpenAPIV3Schema for the spec fields that Crossplane expects to be present for all defined infrastructure resources.

func CompositeResourceStatusProps

func CompositeResourceStatusProps() map[string]v1beta1.JSONSchemaProps

CompositeResourceStatusProps is a partial OpenAPIV3Schema for the status fields that Crossplane expects to be present for all defined or published infrastructure resources.

func IsEstablished

func IsEstablished(s v1beta1.CustomResourceDefinitionStatus) bool

IsEstablished is a helper function to check whether api-server is ready to accept the instances of registered CRD.

func New

func New(o ...Option) (*v1beta1.CustomResourceDefinition, error)

New produces a new CustomResourceDefinition.

func NewSpec

func NewSpec(t v1alpha1.CRDSpecTemplate) (v1beta1.CustomResourceDefinitionSpec, error)

NewSpec produces a CustomResourceDefinitionSpec from the supplied template.

Types

type Option

type Option func(*v1beta1.CustomResourceDefinition) error

An Option configures the supplied CustomResourceDefinition.

func ForCompositeResource

func ForCompositeResource(d *v1alpha1.CompositeResourceDefinition) Option

ForCompositeResource derives the CustomResourceDefinition for a composite resource from the supplied CompositeResourceDefinition.

func ForCompositeResourceClaim

func ForCompositeResourceClaim(d *v1alpha1.CompositeResourceDefinition) Option

ForCompositeResourceClaim derives the CustomResourceDefinition for a composite resource claim from the supplied CompositeResourceDefinition.