v1alpha1

package
v1.15.2 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Apr 9, 2024 License: Apache-2.0 Imports: 9 Imported by: 4

Documentation

Overview

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

Index

Constants

View Source 
const (
	Group   = "meta.pkg.crossplane.io"
	Version = "v1alpha1"
)

Package type metadata.

Variables

View Source 
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
)
View Source 
var (
	ProviderKind             = reflect.TypeOf(Provider{}).Name()
	ProviderGroupKind        = schema.GroupKind{Group: Group, Kind: ProviderKind}.String()
	ProviderKindAPIVersion   = ProviderKind + "." + SchemeGroupVersion.String()
	ProviderGroupVersionKind = SchemeGroupVersion.WithKind(ProviderKind)
)

Provider type metadata.

View Source 
var (
	ConfigurationKind             = reflect.TypeOf(Configuration{}).Name()
	ConfigurationGroupKind        = schema.GroupKind{Group: Group, Kind: ConfigurationKind}.String()
	ConfigurationKindAPIVersion   = ConfigurationKind + "." + SchemeGroupVersion.String()
	ConfigurationGroupVersionKind = SchemeGroupVersion.WithKind(ConfigurationKind)
)

Configuration type metadata.

Functions

func ConvertObjectMeta added in v1.11.0 

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 Configuration 

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

	Spec ConfigurationSpec `json:"spec"`
}

A Configuration is the description of a Crossplane Configuration package.

func (*Configuration) ConvertFrom added in v1.0.0 

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

ConvertFrom converts this Configuration from the Hub version.

func (*Configuration) ConvertTo added in v1.0.0 

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

ConvertTo converts this Configuration to the Hub version.

func (*Configuration) DeepCopy 

func (in *Configuration) DeepCopy() *Configuration

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

func (*Configuration) DeepCopyInto 

func (in *Configuration) DeepCopyInto(out *Configuration)

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

func (*Configuration) DeepCopyObject 

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

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

type ConfigurationSpec 

type ConfigurationSpec struct {
	MetaSpec `json:",inline"`
}

ConfigurationSpec specifies the configuration of a Configuration.

func (*ConfigurationSpec) DeepCopy 

func (in *ConfigurationSpec) DeepCopy() *ConfigurationSpec

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

func (*ConfigurationSpec) DeepCopyInto 

func (in *ConfigurationSpec) DeepCopyInto(out *ConfigurationSpec)

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

type ControllerSpec 

type ControllerSpec struct {
	// Image is the packaged Provider controller image.
	Image *string `json:"image,omitempty"`

	// PermissionRequests for RBAC rules required for this provider's controller
	// to function. The RBAC manager is responsible for assessing the requested
	// permissions.
	// +optional
	PermissionRequests []rbacv1.PolicyRule `json:"permissionRequests,omitempty"`
}

ControllerSpec specifies the configuration for the packaged Provider controller.

func (*ControllerSpec) DeepCopy 

func (in *ControllerSpec) DeepCopy() *ControllerSpec

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

func (*ControllerSpec) DeepCopyInto 

func (in *ControllerSpec) DeepCopyInto(out *ControllerSpec)

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

type CrossplaneConstraints added in v0.14.0 

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 added in v0.14.0 

func (in *CrossplaneConstraints) DeepCopy() *CrossplaneConstraints

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

func (*CrossplaneConstraints) DeepCopyInto added in v0.14.0 

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 added in v1.11.0 

type FromHubConverter interface {
	Configuration(in *v1.Configuration) *Configuration
	Provider(in *v1.Provider) *Provider
}

A FromHubConverter converts v1alpha1 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/v1alpha1 +k8s:deepcopy-gen=false

type GeneratedFromHubConverter added in v1.11.0 

type GeneratedFromHubConverter struct{}

func (*GeneratedFromHubConverter) Configuration added in v1.11.0 

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

func (*GeneratedFromHubConverter) DeepCopy added in v1.11.0 

func (in *GeneratedFromHubConverter) DeepCopy() *GeneratedFromHubConverter

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

func (*GeneratedFromHubConverter) DeepCopyInto added in v1.11.0 

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) Provider added in v1.11.0 

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

type GeneratedToHubConverter added in v1.11.0 

type GeneratedToHubConverter struct{}

func (*GeneratedToHubConverter) Configuration added in v1.11.0 

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

func (*GeneratedToHubConverter) DeepCopy added in v1.11.0 

func (in *GeneratedToHubConverter) DeepCopy() *GeneratedToHubConverter

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

func (*GeneratedToHubConverter) DeepCopyInto added in v1.11.0 

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) Provider added in v1.11.0 

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

type MetaSpec added in v0.14.0 

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 added in v0.14.0 

func (in *MetaSpec) DeepCopy() *MetaSpec

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

func (*MetaSpec) DeepCopyInto added in v0.14.0 

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

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

type Provider 

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

	Spec ProviderSpec `json:"spec"`
}

A Provider is the description of a Crossplane Provider package.

func (*Provider) ConvertFrom added in v1.0.0 

func (p *Provider) ConvertFrom(hub conversion.Hub) error

ConvertFrom converts this Provider from the Hub version.

func (*Provider) ConvertTo added in v1.0.0 

func (p *Provider) ConvertTo(hub conversion.Hub) error

ConvertTo converts this Provider to the Hub version.

func (*Provider) DeepCopy 

func (in *Provider) DeepCopy() *Provider

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

func (*Provider) DeepCopyInto 

func (in *Provider) DeepCopyInto(out *Provider)

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

func (*Provider) DeepCopyObject 

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

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

type ProviderSpec 

type ProviderSpec struct {
	// Configuration for the packaged Provider's controller.
	Controller ControllerSpec `json:"controller"`

	MetaSpec `json:",inline"`
}

ProviderSpec specifies the configuration of a Provider.

func (*ProviderSpec) DeepCopy 

func (in *ProviderSpec) DeepCopy() *ProviderSpec

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

func (*ProviderSpec) DeepCopyInto 

func (in *ProviderSpec) DeepCopyInto(out *ProviderSpec)

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

type ToHubConverter added in v1.11.0 

type ToHubConverter interface {
	Configuration(in *Configuration) *v1.Configuration
	Provider(in *Provider) *v1.Provider
}

A ToHubConverter converts v1alpha1 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/v1alpha1 +k8s:deepcopy-gen=false

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.