v1beta1

Documentation

Overview

Package v1beta1 contains meta types used to configure Crossplane packages. +kubebuilder:object:generate=true +groupName=meta.pkg.crossplane.io +versionName=v1beta1

Index

• Constants
• Variables
• func ConvertObjectMeta(in metav1.ObjectMeta) metav1.ObjectMeta
• type CrossplaneConstraints
  • func (in *CrossplaneConstraints) DeepCopy() *CrossplaneConstraints
  • func (in *CrossplaneConstraints) DeepCopyInto(out *CrossplaneConstraints)
• type Dependency
  • func (in *Dependency) DeepCopy() *Dependency
  • func (in *Dependency) DeepCopyInto(out *Dependency)
• type FromHubConverter
• type Function
  • func (c *Function) ConvertFrom(hub conversion.Hub) error
  • func (c *Function) ConvertTo(hub conversion.Hub) error
  • func (in *Function) DeepCopy() *Function
  • func (in *Function) DeepCopyInto(out *Function)
  • func (in *Function) DeepCopyObject() runtime.Object
• type FunctionSpec
  • func (in *FunctionSpec) DeepCopy() *FunctionSpec
  • func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)
• type GeneratedFromHubConverter
  • func (in *GeneratedFromHubConverter) DeepCopy() *GeneratedFromHubConverter
  • func (in *GeneratedFromHubConverter) DeepCopyInto(out *GeneratedFromHubConverter)
  • func (c *GeneratedFromHubConverter) Function(source *v1.Function) *Function
• type GeneratedToHubConverter
  • func (in *GeneratedToHubConverter) DeepCopy() *GeneratedToHubConverter
  • func (in *GeneratedToHubConverter) DeepCopyInto(out *GeneratedToHubConverter)
  • func (c *GeneratedToHubConverter) Function(source *Function) *v1.Function
• type MetaSpec
  • func (in *MetaSpec) DeepCopy() *MetaSpec
  • func (in *MetaSpec) DeepCopyInto(out *MetaSpec)
• type ToHubConverter

Constants

const (
	Group   = "meta.pkg.crossplane.io"
	Version = "v1beta1"
)

Package type metadata.

Variables

var (
	// SchemeGroupVersion is group version used to register these objects.
	SchemeGroupVersion = schema.GroupVersion{Group: Group, Version: Version}

	// SchemeBuilder is used to add go types to the GroupVersionKind scheme.
	SchemeBuilder = &scheme.Builder{GroupVersion: SchemeGroupVersion}

	// AddToScheme adds all registered types to scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

var (
	FunctionKind             = reflect.TypeOf(Function{}).Name()
	FunctionGroupKind        = schema.GroupKind{Group: Group, Kind: FunctionKind}.String()
	FunctionKindAPIVersion   = FunctionKind + "." + SchemeGroupVersion.String()
	FunctionGroupVersionKind = SchemeGroupVersion.WithKind(FunctionKind)
)

Function type metadata.

Functions

func ConvertObjectMeta

func ConvertObjectMeta(in metav1.ObjectMeta) metav1.ObjectMeta

ConvertObjectMeta 'converts' ObjectMeta by producing a deepcopy. This is necessary because goverter can't convert metav1.Time. It also prevents goverter generating code that is functionally identical to deepcopygen's.

Types

type CrossplaneConstraints

type CrossplaneConstraints struct {
	// Semantic version constraints of Crossplane that package is compatible with.
	Version string `json:"version"`
}

CrossplaneConstraints specifies a packages compatibility with Crossplane versions.

func (*CrossplaneConstraints) DeepCopy

func (in *CrossplaneConstraints) DeepCopy() *CrossplaneConstraints

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new CrossplaneConstraints.

func (*CrossplaneConstraints) DeepCopyInto

func (in *CrossplaneConstraints) DeepCopyInto(out *CrossplaneConstraints)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type Dependency

type Dependency struct {
	// Provider is the name of a Provider package image.
	Provider *string `json:"provider,omitempty"`

	// Configuration is the name of a Configuration package image.
	Configuration *string `json:"configuration,omitempty"`

	// Function is the name of a Function package image.
	Function *string `json:"function,omitempty"`

	// Version is the semantic version constraints of the dependency image.
	Version string `json:"version"`
}

Dependency is a dependency on another package. One of Provider or Configuration may be supplied.

func (*Dependency) DeepCopy

func (in *Dependency) DeepCopy() *Dependency

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Dependency.

func (*Dependency) DeepCopyInto

func (in *Dependency) DeepCopyInto(out *Dependency)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type FromHubConverter

type FromHubConverter interface {
	Function(in *v1.Function) *Function
}

A FromHubConverter converts v1beta1 types from the 'hub' v1 type.

goverter:converter goverter:name GeneratedFromHubConverter goverter:extend ConvertObjectMeta goverter:output:file ./zz_generated.conversion.go goverter:output:package github.com/crossplane/crossplane/apis/pkg/meta/v1beta1 +k8s:deepcopy-gen=false

type Function

type Function struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`

	Spec FunctionSpec `json:"spec"`
}

A Function is the description of a Crossplane Function package.

func (*Function) ConvertFrom

func (c *Function) ConvertFrom(hub conversion.Hub) error

ConvertFrom converts this Function from the Hub version.

func (*Function) ConvertTo

func (c *Function) ConvertTo(hub conversion.Hub) error

ConvertTo converts this Function to the Hub version.

func (*Function) DeepCopy

func (in *Function) DeepCopy() *Function

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new Function.

func (*Function) DeepCopyInto

func (in *Function) DeepCopyInto(out *Function)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*Function) DeepCopyObject

func (in *Function) DeepCopyObject() runtime.Object

DeepCopyObject is an autogenerated deepcopy function, copying the receiver, creating a new runtime.Object.

type FunctionSpec

type FunctionSpec struct {
	MetaSpec `json:",inline"`

	// Image is the packaged Function image.
	Image *string `json:"image,omitempty"`
}

FunctionSpec specifies the configuration of a Function.

func (*FunctionSpec) DeepCopy

func (in *FunctionSpec) DeepCopy() *FunctionSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new FunctionSpec.

func (*FunctionSpec) DeepCopyInto

func (in *FunctionSpec) DeepCopyInto(out *FunctionSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type GeneratedFromHubConverter

type GeneratedFromHubConverter struct{}

func (*GeneratedFromHubConverter) DeepCopy

func (in *GeneratedFromHubConverter) DeepCopy() *GeneratedFromHubConverter

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GeneratedFromHubConverter.

func (*GeneratedFromHubConverter) DeepCopyInto

func (in *GeneratedFromHubConverter) DeepCopyInto(out *GeneratedFromHubConverter)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GeneratedFromHubConverter) Function

func (c *GeneratedFromHubConverter) Function(source *v1.Function) *Function

type GeneratedToHubConverter

type GeneratedToHubConverter struct{}

func (*GeneratedToHubConverter) DeepCopy

func (in *GeneratedToHubConverter) DeepCopy() *GeneratedToHubConverter

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new GeneratedToHubConverter.

func (*GeneratedToHubConverter) DeepCopyInto

func (in *GeneratedToHubConverter) DeepCopyInto(out *GeneratedToHubConverter)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

func (*GeneratedToHubConverter) Function

func (c *GeneratedToHubConverter) Function(source *Function) *v1.Function

type MetaSpec

type MetaSpec struct {
	// Semantic version constraints of Crossplane that package is compatible with.
	Crossplane *CrossplaneConstraints `json:"crossplane,omitempty"`

	// Dependencies on other packages.
	DependsOn []Dependency `json:"dependsOn,omitempty"`
}

MetaSpec are fields that every meta package type must implement.

func (*MetaSpec) DeepCopy

func (in *MetaSpec) DeepCopy() *MetaSpec

DeepCopy is an autogenerated deepcopy function, copying the receiver, creating a new MetaSpec.

func (*MetaSpec) DeepCopyInto

func (in *MetaSpec) DeepCopyInto(out *MetaSpec)

DeepCopyInto is an autogenerated deepcopy function, copying the receiver, writing into out. in must be non-nil.

type ToHubConverter

type ToHubConverter interface {
	Function(in *Function) *v1.Function
}

A ToHubConverter converts v1beta1 types to the 'hub' v1 type.

goverter:converter goverter:name GeneratedToHubConverter goverter:extend ConvertObjectMeta goverter:output:file ./zz_generated.conversion.go goverter:output:package github.com/crossplane/crossplane/apis/pkg/meta/v1beta1 +k8s:deepcopy-gen=false