v1

package
v1.10.2 Latest Latest
Warning

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

 Go to latest Published: Jan 17, 2023 License: Apache-2.0 Imports: 10 Imported by: 20

Documentation

Overview

Package v1 contains resources relating to Crossplane packages. +kubebuilder:object:generate=true +groupName=pkg.crossplane.io +versionName=v1

Index

Constants

View Source 
const (
	// A TypeInstalled indicates whether a package has been installed.
	TypeInstalled xpv1.ConditionType = "Installed"

	// A TypeHealthy indicates whether a package is healthy.
	TypeHealthy xpv1.ConditionType = "Healthy"
)

Condition types.

View Source 
const (
	ReasonUnpacking     xpv1.ConditionReason = "UnpackingPackage"
	ReasonInactive      xpv1.ConditionReason = "InactivePackageRevision"
	ReasonActive        xpv1.ConditionReason = "ActivePackageRevision"
	ReasonUnhealthy     xpv1.ConditionReason = "UnhealthyPackageRevision"
	ReasonHealthy       xpv1.ConditionReason = "HealthyPackageRevision"
	ReasonUnknownHealth xpv1.ConditionReason = "UnknownPackageRevisionHealth"
)

Reasons a package is or is not installed.

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

Package type metadata.

View Source 
const (
	// LabelParentPackage is used as key for the owner package label we add to the
	// revisions. Its corresponding value should be the name of the owner package.
	LabelParentPackage = "pkg.crossplane.io/package"
)

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 the scheme
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var (
	ConfigurationKind             = reflect.TypeOf(Configuration{}).Name()
	ConfigurationGroupKind        = schema.GroupKind{Group: Group, Kind: ConfigurationKind}.String()
	ConfigurationKindAPIVersion   = ConfigurationKind + "." + SchemeGroupVersion.String()
	ConfigurationGroupVersionKind = SchemeGroupVersion.WithKind(ConfigurationKind)
)

Configuation type metadata.

View Source 
var (
	ConfigurationRevisionKind             = reflect.TypeOf(ConfigurationRevision{}).Name()
	ConfigurationRevisionGroupKind        = schema.GroupKind{Group: Group, Kind: ConfigurationRevisionKind}.String()
	ConfigurationRevisionKindAPIVersion   = ConfigurationRevisionKind + "." + SchemeGroupVersion.String()
	ConfigurationRevisionGroupVersionKind = SchemeGroupVersion.WithKind(ConfigurationRevisionKind)
)

ConfigurationRevision type metadata.

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 (
	ProviderRevisionKind             = reflect.TypeOf(ProviderRevision{}).Name()
	ProviderRevisionGroupKind        = schema.GroupKind{Group: Group, Kind: ProviderRevisionKind}.String()
	ProviderRevisionKindAPIVersion   = ProviderRevisionKind + "." + SchemeGroupVersion.String()
	ProviderRevisionGroupVersionKind = SchemeGroupVersion.WithKind(ProviderRevisionKind)
)

ProviderRevision type metadata.

Functions

func Active 

func Active() xpv1.Condition

Active indicates that the package manager has installed and activated a package revision.

func Healthy 

func Healthy() xpv1.Condition

Healthy indicates that the current revision is healthy.

func Inactive 

func Inactive() xpv1.Condition

Inactive indicates that the package manager is waiting for a package revision to be transitioned to an active state.

func RefNames 

func RefNames(refs []corev1.LocalObjectReference) []string

RefNames converts a slice of LocalObjectReferences to a slice of strings.

func Unhealthy 

func Unhealthy() xpv1.Condition

Unhealthy indicates that the current revision is unhealthy.

func UnknownHealth 

func UnknownHealth() xpv1.Condition

UnknownHealth indicates that the health of the current revision is unknown.

func Unpacking 

func Unpacking() xpv1.Condition

Unpacking indicates that the package manager is waiting for a package revision to be unpacked.

Types

type Configuration 

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

	Spec   ConfigurationSpec   `json:"spec,omitempty"`
	Status ConfigurationStatus `json:"status,omitempty"`
}

Configuration is the CRD type for a request to add a configuration to Crossplane. +kubebuilder:subresource:status +kubebuilder:storageversion +kubebuilder:printcolumn:name="INSTALLED",type="string",JSONPath=".status.conditions[?(@.type=='Installed')].status" +kubebuilder:printcolumn:name="HEALTHY",type="string",JSONPath=".status.conditions[?(@.type=='Healthy')].status" +kubebuilder:printcolumn:name="PACKAGE",type="string",JSONPath=".spec.package" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,pkg}

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.

func (*Configuration) GetActivationPolicy 

func (p *Configuration) GetActivationPolicy() *RevisionActivationPolicy

GetActivationPolicy of this Configuration.

func (*Configuration) GetCondition 

func (p *Configuration) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Configuration.

func (*Configuration) GetControllerConfigRef 

func (p *Configuration) GetControllerConfigRef() *ControllerConfigReference

GetControllerConfigRef of this Configuration.

func (*Configuration) GetCurrentIdentifier 

func (p *Configuration) GetCurrentIdentifier() string

GetCurrentIdentifier of this Configuration.

func (*Configuration) GetCurrentRevision 

func (p *Configuration) GetCurrentRevision() string

GetCurrentRevision of this Configuration.

func (*Configuration) GetIgnoreCrossplaneConstraints 

func (p *Configuration) GetIgnoreCrossplaneConstraints() *bool

GetIgnoreCrossplaneConstraints of this Configuration.

func (*Configuration) GetPackagePullPolicy 

func (p *Configuration) GetPackagePullPolicy() *corev1.PullPolicy

GetPackagePullPolicy of this Configuration.

func (*Configuration) GetPackagePullSecrets 

func (p *Configuration) GetPackagePullSecrets() []corev1.LocalObjectReference

GetPackagePullSecrets of this Configuration.

func (*Configuration) GetRevisionHistoryLimit 

func (p *Configuration) GetRevisionHistoryLimit() *int64

GetRevisionHistoryLimit of this Configuration.

func (*Configuration) GetSkipDependencyResolution 

func (p *Configuration) GetSkipDependencyResolution() *bool

GetSkipDependencyResolution of this Configuration.

func (*Configuration) GetSource 

func (p *Configuration) GetSource() string

GetSource of this Configuration.

func (*Configuration) SetActivationPolicy 

func (p *Configuration) SetActivationPolicy(a *RevisionActivationPolicy)

SetActivationPolicy of this Configuration.

func (*Configuration) SetConditions 

func (p *Configuration) SetConditions(c ...xpv1.Condition)

SetConditions of this Configuration.

func (*Configuration) SetControllerConfigRef 

func (p *Configuration) SetControllerConfigRef(r *ControllerConfigReference)

SetControllerConfigRef of this Configuration.

func (*Configuration) SetCurrentIdentifier 

func (p *Configuration) SetCurrentIdentifier(s string)

SetCurrentIdentifier of this Configuration.

func (*Configuration) SetCurrentRevision 

func (p *Configuration) SetCurrentRevision(s string)

SetCurrentRevision of this Configuration.

func (*Configuration) SetIgnoreCrossplaneConstraints 

func (p *Configuration) SetIgnoreCrossplaneConstraints(b *bool)

SetIgnoreCrossplaneConstraints of this Configuration.

func (*Configuration) SetPackagePullPolicy 

func (p *Configuration) SetPackagePullPolicy(i *corev1.PullPolicy)

SetPackagePullPolicy of this Configuration.

func (*Configuration) SetPackagePullSecrets 

func (p *Configuration) SetPackagePullSecrets(s []corev1.LocalObjectReference)

SetPackagePullSecrets of this Configuration.

func (*Configuration) SetRevisionHistoryLimit 

func (p *Configuration) SetRevisionHistoryLimit(l *int64)

SetRevisionHistoryLimit of this Configuration.

func (*Configuration) SetSkipDependencyResolution 

func (p *Configuration) SetSkipDependencyResolution(b *bool)

SetSkipDependencyResolution of this Configuration.

func (*Configuration) SetSource 

func (p *Configuration) SetSource(s string)

SetSource of this Configuration.

type ConfigurationList 

type ConfigurationList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Configuration `json:"items"`
}

ConfigurationList contains a list of Configuration.

func (*ConfigurationList) DeepCopy 

func (in *ConfigurationList) DeepCopy() *ConfigurationList

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

func (*ConfigurationList) DeepCopyInto 

func (in *ConfigurationList) DeepCopyInto(out *ConfigurationList)

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

func (*ConfigurationList) DeepCopyObject 

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

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

type ConfigurationRevision 

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

	Spec   PackageRevisionSpec   `json:"spec,omitempty"`
	Status PackageRevisionStatus `json:"status,omitempty"`
}

A ConfigurationRevision that has been added to Crossplane. +kubebuilder:subresource:status +kubebuilder:storageversion +kubebuilder:printcolumn:name="HEALTHY",type="string",JSONPath=".status.conditions[?(@.type=='Healthy')].status" +kubebuilder:printcolumn:name="REVISION",type="string",JSONPath=".spec.revision" +kubebuilder:printcolumn:name="IMAGE",type="string",JSONPath=".spec.image" +kubebuilder:printcolumn:name="STATE",type="string",JSONPath=".spec.desiredState" +kubebuilder:printcolumn:name="DEP-FOUND",type="string",JSONPath=".status.foundDependencies" +kubebuilder:printcolumn:name="DEP-INSTALLED",type="string",JSONPath=".status.installedDependencies" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,pkgrev}

func (*ConfigurationRevision) DeepCopy 

func (in *ConfigurationRevision) DeepCopy() *ConfigurationRevision

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

func (*ConfigurationRevision) DeepCopyInto 

func (in *ConfigurationRevision) DeepCopyInto(out *ConfigurationRevision)

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

func (*ConfigurationRevision) DeepCopyObject 

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

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

func (*ConfigurationRevision) GetCondition 

func (p *ConfigurationRevision) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this ConfigurationRevision.

func (*ConfigurationRevision) GetControllerConfigRef 

func (p *ConfigurationRevision) GetControllerConfigRef() *ControllerConfigReference

GetControllerConfigRef of this ConfigurationRevision.

func (*ConfigurationRevision) GetControllerReference 

func (p *ConfigurationRevision) GetControllerReference() ControllerReference

GetControllerReference of this ConfigurationRevision.

func (*ConfigurationRevision) GetDependencyStatus 

func (p *ConfigurationRevision) GetDependencyStatus() (found, installed, invalid int64)

GetDependencyStatus of this v.

func (*ConfigurationRevision) GetDesiredState 

func (p *ConfigurationRevision) GetDesiredState() PackageRevisionDesiredState

GetDesiredState of this ConfigurationRevision.

func (*ConfigurationRevision) GetIgnoreCrossplaneConstraints 

func (p *ConfigurationRevision) GetIgnoreCrossplaneConstraints() *bool

GetIgnoreCrossplaneConstraints of this ConfigurationRevision.

func (*ConfigurationRevision) GetObjects 

func (p *ConfigurationRevision) GetObjects() []xpv1.TypedReference

GetObjects of this ConfigurationRevision.

func (*ConfigurationRevision) GetPackagePullPolicy 

func (p *ConfigurationRevision) GetPackagePullPolicy() *corev1.PullPolicy

GetPackagePullPolicy of this ConfigurationRevision.

func (*ConfigurationRevision) GetPackagePullSecrets 

func (p *ConfigurationRevision) GetPackagePullSecrets() []corev1.LocalObjectReference

GetPackagePullSecrets of this ConfigurationRevision.

func (*ConfigurationRevision) GetRevision 

func (p *ConfigurationRevision) GetRevision() int64

GetRevision of this ConfigurationRevision.

func (*ConfigurationRevision) GetSkipDependencyResolution 

func (p *ConfigurationRevision) GetSkipDependencyResolution() *bool

GetSkipDependencyResolution of this ConfigurationRevision.

func (*ConfigurationRevision) GetSource 

func (p *ConfigurationRevision) GetSource() string

GetSource of this ConfigurationRevision.

func (*ConfigurationRevision) GetWebhookTLSSecretName added in v1.7.0 

func (p *ConfigurationRevision) GetWebhookTLSSecretName() *string

GetWebhookTLSSecretName of this ConfigurationRevision.

func (*ConfigurationRevision) SetConditions 

func (p *ConfigurationRevision) SetConditions(c ...xpv1.Condition)

SetConditions of this ConfigurationRevision.

func (*ConfigurationRevision) SetControllerConfigRef 

func (p *ConfigurationRevision) SetControllerConfigRef(r *ControllerConfigReference)

SetControllerConfigRef of this ConfigurationRevision.

func (*ConfigurationRevision) SetControllerReference 

func (p *ConfigurationRevision) SetControllerReference(c ControllerReference)

SetControllerReference of this ConfigurationRevision.

func (*ConfigurationRevision) SetDependencyStatus 

func (p *ConfigurationRevision) SetDependencyStatus(found, installed, invalid int64)

SetDependencyStatus of this ConfigurationRevision.

func (*ConfigurationRevision) SetDesiredState 

func (p *ConfigurationRevision) SetDesiredState(s PackageRevisionDesiredState)

SetDesiredState of this ConfigurationRevision.

func (*ConfigurationRevision) SetIgnoreCrossplaneConstraints 

func (p *ConfigurationRevision) SetIgnoreCrossplaneConstraints(b *bool)

SetIgnoreCrossplaneConstraints of this ConfigurationRevision.

func (*ConfigurationRevision) SetObjects 

func (p *ConfigurationRevision) SetObjects(c []xpv1.TypedReference)

SetObjects of this ConfigurationRevision.

func (*ConfigurationRevision) SetPackagePullPolicy 

func (p *ConfigurationRevision) SetPackagePullPolicy(i *corev1.PullPolicy)

SetPackagePullPolicy of this ConfigurationRevision.

func (*ConfigurationRevision) SetPackagePullSecrets 

func (p *ConfigurationRevision) SetPackagePullSecrets(s []corev1.LocalObjectReference)

SetPackagePullSecrets of this ConfigurationRevision.

func (*ConfigurationRevision) SetRevision 

func (p *ConfigurationRevision) SetRevision(r int64)

SetRevision of this ConfigurationRevision.

func (*ConfigurationRevision) SetSkipDependencyResolution 

func (p *ConfigurationRevision) SetSkipDependencyResolution(b *bool)

SetSkipDependencyResolution of this ConfigurationRevision.

func (*ConfigurationRevision) SetSource 

func (p *ConfigurationRevision) SetSource(s string)

SetSource of this ConfigurationRevision.

func (*ConfigurationRevision) SetWebhookTLSSecretName added in v1.7.0 

func (p *ConfigurationRevision) SetWebhookTLSSecretName(b *string)

SetWebhookTLSSecretName of this ConfigurationRevision.

type ConfigurationRevisionList 

type ConfigurationRevisionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ConfigurationRevision `json:"items"`
}

ConfigurationRevisionList contains a list of ConfigurationRevision.

func (*ConfigurationRevisionList) DeepCopy 

func (in *ConfigurationRevisionList) DeepCopy() *ConfigurationRevisionList

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

func (*ConfigurationRevisionList) DeepCopyInto 

func (in *ConfigurationRevisionList) DeepCopyInto(out *ConfigurationRevisionList)

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

func (*ConfigurationRevisionList) DeepCopyObject 

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

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

func (*ConfigurationRevisionList) GetRevisions 

func (p *ConfigurationRevisionList) GetRevisions() []PackageRevision

GetRevisions of this ConfigurationRevisionList.

type ConfigurationSpec 

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

ConfigurationSpec specifies details about a request to install a configuration to Crossplane.

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 ConfigurationStatus 

type ConfigurationStatus struct {
	xpv1.ConditionedStatus `json:",inline"`
	PackageStatus          `json:",inline"`
}

ConfigurationStatus represents the observed state of a Configuration.

func (*ConfigurationStatus) DeepCopy 

func (in *ConfigurationStatus) DeepCopy() *ConfigurationStatus

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

func (*ConfigurationStatus) DeepCopyInto 

func (in *ConfigurationStatus) DeepCopyInto(out *ConfigurationStatus)

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

type ControllerConfigReference added in v1.10.0 

type ControllerConfigReference struct {
	// Name of the ControllerConfig.
	Name string `json:"name"`
}

A ControllerConfigReference to a ControllerConfig resource that will be used to configure the packaged controller Deployment.

func (*ControllerConfigReference) DeepCopy added in v1.10.0 

func (in *ControllerConfigReference) DeepCopy() *ControllerConfigReference

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

func (*ControllerConfigReference) DeepCopyInto added in v1.10.0 

func (in *ControllerConfigReference) DeepCopyInto(out *ControllerConfigReference)

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

type ControllerReference added in v1.10.0 

type ControllerReference struct {
	// Name of the controller.
	Name string `json:"name"`
}

A ControllerReference references the controller (e.g. Deployment), if any, that is responsible for reconciling the types a package revision installs.

func (*ControllerReference) DeepCopy added in v1.10.0 

func (in *ControllerReference) DeepCopy() *ControllerReference

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

func (*ControllerReference) DeepCopyInto added in v1.10.0 

func (in *ControllerReference) DeepCopyInto(out *ControllerReference)

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

type Package 

type Package interface {
	resource.Object
	resource.Conditioned

	GetSource() string
	SetSource(s string)

	GetActivationPolicy() *RevisionActivationPolicy
	SetActivationPolicy(a *RevisionActivationPolicy)

	GetPackagePullSecrets() []corev1.LocalObjectReference
	SetPackagePullSecrets(s []corev1.LocalObjectReference)

	GetPackagePullPolicy() *corev1.PullPolicy
	SetPackagePullPolicy(i *corev1.PullPolicy)

	GetRevisionHistoryLimit() *int64
	SetRevisionHistoryLimit(l *int64)

	GetIgnoreCrossplaneConstraints() *bool
	SetIgnoreCrossplaneConstraints(b *bool)

	GetControllerConfigRef() *ControllerConfigReference
	SetControllerConfigRef(r *ControllerConfigReference)

	GetCurrentRevision() string
	SetCurrentRevision(r string)

	GetCurrentIdentifier() string
	SetCurrentIdentifier(r string)

	GetSkipDependencyResolution() *bool
	SetSkipDependencyResolution(*bool)
}

Package is the interface satisfied by package types. +k8s:deepcopy-gen=false

type PackageRevision 

type PackageRevision interface {
	resource.Object
	resource.Conditioned

	GetObjects() []xpv1.TypedReference
	SetObjects(c []xpv1.TypedReference)

	GetControllerReference() ControllerReference
	SetControllerReference(c ControllerReference)

	GetSource() string
	SetSource(s string)

	GetPackagePullSecrets() []corev1.LocalObjectReference
	SetPackagePullSecrets(s []corev1.LocalObjectReference)

	GetPackagePullPolicy() *corev1.PullPolicy
	SetPackagePullPolicy(i *corev1.PullPolicy)

	GetDesiredState() PackageRevisionDesiredState
	SetDesiredState(d PackageRevisionDesiredState)

	GetIgnoreCrossplaneConstraints() *bool
	SetIgnoreCrossplaneConstraints(b *bool)

	GetControllerConfigRef() *ControllerConfigReference
	SetControllerConfigRef(r *ControllerConfigReference)

	GetRevision() int64
	SetRevision(r int64)

	GetSkipDependencyResolution() *bool
	SetSkipDependencyResolution(*bool)

	GetDependencyStatus() (found, installed, invalid int64)
	SetDependencyStatus(found, installed, invalid int64)

	GetWebhookTLSSecretName() *string
	SetWebhookTLSSecretName(n *string)
}

PackageRevision is the interface satisfied by package revision types. +k8s:deepcopy-gen=false

type PackageRevisionDesiredState 

type PackageRevisionDesiredState string

PackageRevisionDesiredState is the desired state of the package revision. 

const (
	// PackageRevisionActive is an active package revision.
	PackageRevisionActive PackageRevisionDesiredState = "Active"

	// PackageRevisionInactive is an inactive package revision.
	PackageRevisionInactive PackageRevisionDesiredState = "Inactive"
)

type PackageRevisionList 

type PackageRevisionList interface {
	client.ObjectList

	// GetRevisions gets the list of PackageRevisions in a PackageRevisionList.
	// This is a costly operation, but allows for treating different revision
	// list types as a single interface. If causing a performance bottleneck in
	// a shared reconciler, consider refactoring the controller to use a
	// reconciler for the specific type.
	GetRevisions() []PackageRevision
}

PackageRevisionList is the interface satisfied by package revision list types. +k8s:deepcopy-gen=false

type PackageRevisionSpec 

type PackageRevisionSpec struct {
	// ControllerConfigRef references a ControllerConfig resource that will be
	// used to configure the packaged controller Deployment.
	// +optional
	ControllerConfigReference *ControllerConfigReference `json:"controllerConfigRef,omitempty"`

	// DesiredState of the PackageRevision. Can be either Active or Inactive.
	DesiredState PackageRevisionDesiredState `json:"desiredState"`

	// Package image used by install Pod to extract package contents.
	Package string `json:"image"`

	// PackagePullSecrets are named secrets in the same namespace that can be
	// used to fetch packages from private registries. They are also applied to
	// any images pulled for the package, such as a provider's controller image.
	// +optional
	PackagePullSecrets []corev1.LocalObjectReference `json:"packagePullSecrets,omitempty"`

	// PackagePullPolicy defines the pull policy for the package. It is also
	// applied to any images pulled for the package, such as a provider's
	// controller image.
	// Default is IfNotPresent.
	// +optional
	// +kubebuilder:default=IfNotPresent
	PackagePullPolicy *corev1.PullPolicy `json:"packagePullPolicy,omitempty"`

	// Revision number. Indicates when the revision will be garbage collected
	// based on the parent's RevisionHistoryLimit.
	Revision int64 `json:"revision"`

	// IgnoreCrossplaneConstraints indicates to the package manager whether to
	// honor Crossplane version constrains specified by the package.
	// Default is false.
	// +optional
	// +kubebuilder:default=false
	IgnoreCrossplaneConstraints *bool `json:"ignoreCrossplaneConstraints,omitempty"`

	// SkipDependencyResolution indicates to the package manager whether to skip
	// resolving dependencies for a package. Setting this value to true may have
	// unintended consequences.
	// Default is false.
	// +optional
	// +kubebuilder:default=false
	SkipDependencyResolution *bool `json:"skipDependencyResolution,omitempty"`

	// WebhookTLSSecretName is the name of the TLS Secret that will be used
	// by the provider to serve a TLS-enabled webhook server. The certificate
	// will be injected to webhook configurations as well as CRD conversion
	// webhook strategy if needed.
	// If it's not given, provider will not have a certificate mounted to its
	// filesystem, webhook configurations won't be deployed and if there is a
	// CRD with webhook conversion strategy, the installation will fail.
	// +optional
	WebhookTLSSecretName *string `json:"webhookTLSSecretName,omitempty"`
}

PackageRevisionSpec specifies the desired state of a PackageRevision.

func (*PackageRevisionSpec) DeepCopy 

func (in *PackageRevisionSpec) DeepCopy() *PackageRevisionSpec

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

func (*PackageRevisionSpec) DeepCopyInto 

func (in *PackageRevisionSpec) DeepCopyInto(out *PackageRevisionSpec)

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

type PackageRevisionStatus 

type PackageRevisionStatus struct {
	xpv1.ConditionedStatus `json:",inline"`

	// ControllerRef references the controller (e.g. Deployment), if any, that
	// is responsible for reconciling the objects this package revision
	// installed.
	ControllerRef ControllerReference `json:"controllerRef,omitempty"`

	// References to objects owned by PackageRevision.
	ObjectRefs []xpv1.TypedReference `json:"objectRefs,omitempty"`

	// Dependency information.
	FoundDependencies     int64 `json:"foundDependencies,omitempty"`
	InstalledDependencies int64 `json:"installedDependencies,omitempty"`
	InvalidDependencies   int64 `json:"invalidDependencies,omitempty"`

	// PermissionRequests made by this package. The package declares that its
	// controller needs these permissions to run. The RBAC manager is
	// responsible for granting them.
	PermissionRequests []rbacv1.PolicyRule `json:"permissionRequests,omitempty"`
}

PackageRevisionStatus represents the observed state of a PackageRevision.

func (*PackageRevisionStatus) DeepCopy 

func (in *PackageRevisionStatus) DeepCopy() *PackageRevisionStatus

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

func (*PackageRevisionStatus) DeepCopyInto 

func (in *PackageRevisionStatus) DeepCopyInto(out *PackageRevisionStatus)

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

type PackageSpec 

type PackageSpec struct {
	// Package is the name of the package that is being requested.
	Package string `json:"package"`

	// RevisionActivationPolicy specifies how the package controller should
	// update from one revision to the next. Options are Automatic or Manual.
	// Default is Automatic.
	// +optional
	// +kubebuilder:default=Automatic
	RevisionActivationPolicy *RevisionActivationPolicy `json:"revisionActivationPolicy,omitempty"`

	// RevisionHistoryLimit dictates how the package controller cleans up old
	// inactive package revisions.
	// Defaults to 1. Can be disabled by explicitly setting to 0.
	// +optional
	// +kubebuilder:default=1
	RevisionHistoryLimit *int64 `json:"revisionHistoryLimit,omitempty"`

	// PackagePullSecrets are named secrets in the same namespace that can be used
	// to fetch packages from private registries.
	// +optional
	PackagePullSecrets []corev1.LocalObjectReference `json:"packagePullSecrets,omitempty"`

	// PackagePullPolicy defines the pull policy for the package.
	// Default is IfNotPresent.
	// +optional
	// +kubebuilder:default=IfNotPresent
	PackagePullPolicy *corev1.PullPolicy `json:"packagePullPolicy,omitempty"`

	// IgnoreCrossplaneConstraints indicates to the package manager whether to
	// honor Crossplane version constrains specified by the package.
	// Default is false.
	// +optional
	// +kubebuilder:default=false
	IgnoreCrossplaneConstraints *bool `json:"ignoreCrossplaneConstraints,omitempty"`

	// SkipDependencyResolution indicates to the package manager whether to skip
	// resolving dependencies for a package. Setting this value to true may have
	// unintended consequences.
	// Default is false.
	// +optional
	// +kubebuilder:default=false
	SkipDependencyResolution *bool `json:"skipDependencyResolution,omitempty"`
}

PackageSpec specifies the desired state of a Package.

func (*PackageSpec) DeepCopy 

func (in *PackageSpec) DeepCopy() *PackageSpec

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

func (*PackageSpec) DeepCopyInto 

func (in *PackageSpec) DeepCopyInto(out *PackageSpec)

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

type PackageStatus 

type PackageStatus struct {
	// CurrentRevision is the name of the current package revision. It will
	// reflect the most up to date revision, whether it has been activated or
	// not.
	CurrentRevision string `json:"currentRevision,omitempty"`

	// CurrentIdentifier is the most recent package source that was used to
	// produce a revision. The package manager uses this field to determine
	// whether to check for package updates for a given source when
	// packagePullPolicy is set to IfNotPresent. Manually removing this field
	// will cause the package manager to check that the current revision is
	// correct for the given package source.
	CurrentIdentifier string `json:"currentIdentifier,omitempty"`
}

PackageStatus represents the observed state of a Package.

func (*PackageStatus) DeepCopy 

func (in *PackageStatus) DeepCopy() *PackageStatus

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

func (*PackageStatus) DeepCopyInto 

func (in *PackageStatus) DeepCopyInto(out *PackageStatus)

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,omitempty"`
	Status ProviderStatus `json:"status,omitempty"`
}

Provider is the CRD type for a request to add a provider to Crossplane. +kubebuilder:subresource:status +kubebuilder:storageversion +kubebuilder:printcolumn:name="INSTALLED",type="string",JSONPath=".status.conditions[?(@.type=='Installed')].status" +kubebuilder:printcolumn:name="HEALTHY",type="string",JSONPath=".status.conditions[?(@.type=='Healthy')].status" +kubebuilder:printcolumn:name="PACKAGE",type="string",JSONPath=".spec.package" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,pkg}

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.

func (*Provider) GetActivationPolicy 

func (p *Provider) GetActivationPolicy() *RevisionActivationPolicy

GetActivationPolicy of this Provider.

func (*Provider) GetCondition 

func (p *Provider) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this Provider.

func (*Provider) GetControllerConfigRef 

func (p *Provider) GetControllerConfigRef() *ControllerConfigReference

GetControllerConfigRef of this Provider.

func (*Provider) GetCurrentIdentifier 

func (p *Provider) GetCurrentIdentifier() string

GetCurrentIdentifier of this Provider.

func (*Provider) GetCurrentRevision 

func (p *Provider) GetCurrentRevision() string

GetCurrentRevision of this Provider.

func (*Provider) GetIgnoreCrossplaneConstraints 

func (p *Provider) GetIgnoreCrossplaneConstraints() *bool

GetIgnoreCrossplaneConstraints of this Provider.

func (*Provider) GetPackagePullPolicy 

func (p *Provider) GetPackagePullPolicy() *corev1.PullPolicy

GetPackagePullPolicy of this Provider.

func (*Provider) GetPackagePullSecrets 

func (p *Provider) GetPackagePullSecrets() []corev1.LocalObjectReference

GetPackagePullSecrets of this Provider.

func (*Provider) GetRevisionHistoryLimit 

func (p *Provider) GetRevisionHistoryLimit() *int64

GetRevisionHistoryLimit of this Provider.

func (*Provider) GetSkipDependencyResolution 

func (p *Provider) GetSkipDependencyResolution() *bool

GetSkipDependencyResolution of this Provider.

func (*Provider) GetSource 

func (p *Provider) GetSource() string

GetSource of this Provider.

func (*Provider) SetActivationPolicy 

func (p *Provider) SetActivationPolicy(a *RevisionActivationPolicy)

SetActivationPolicy of this Provider.

func (*Provider) SetConditions 

func (p *Provider) SetConditions(c ...xpv1.Condition)

SetConditions of this Provider.

func (*Provider) SetControllerConfigRef 

func (p *Provider) SetControllerConfigRef(r *ControllerConfigReference)

SetControllerConfigRef of this Provider.

func (*Provider) SetCurrentIdentifier 

func (p *Provider) SetCurrentIdentifier(s string)

SetCurrentIdentifier of this Provider.

func (*Provider) SetCurrentRevision 

func (p *Provider) SetCurrentRevision(s string)

SetCurrentRevision of this Provider.

func (*Provider) SetIgnoreCrossplaneConstraints 

func (p *Provider) SetIgnoreCrossplaneConstraints(b *bool)

SetIgnoreCrossplaneConstraints of this Provider.

func (*Provider) SetPackagePullPolicy 

func (p *Provider) SetPackagePullPolicy(i *corev1.PullPolicy)

SetPackagePullPolicy of this Provider.

func (*Provider) SetPackagePullSecrets 

func (p *Provider) SetPackagePullSecrets(s []corev1.LocalObjectReference)

SetPackagePullSecrets of this Provider.

func (*Provider) SetRevisionHistoryLimit 

func (p *Provider) SetRevisionHistoryLimit(l *int64)

SetRevisionHistoryLimit of this Provider.

func (*Provider) SetSkipDependencyResolution 

func (p *Provider) SetSkipDependencyResolution(b *bool)

SetSkipDependencyResolution of this Provider.

func (*Provider) SetSource 

func (p *Provider) SetSource(s string)

SetSource of this Provider.

type ProviderList 

type ProviderList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []Provider `json:"items"`
}

ProviderList contains a list of Provider.

func (*ProviderList) DeepCopy 

func (in *ProviderList) DeepCopy() *ProviderList

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

func (*ProviderList) DeepCopyInto 

func (in *ProviderList) DeepCopyInto(out *ProviderList)

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

func (*ProviderList) DeepCopyObject 

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

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

type ProviderRevision 

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

	Spec   PackageRevisionSpec   `json:"spec,omitempty"`
	Status PackageRevisionStatus `json:"status,omitempty"`
}

A ProviderRevision that has been added to Crossplane. +kubebuilder:subresource:status +kubebuilder:storageversion +kubebuilder:printcolumn:name="HEALTHY",type="string",JSONPath=".status.conditions[?(@.type=='Healthy')].status" +kubebuilder:printcolumn:name="REVISION",type="string",JSONPath=".spec.revision" +kubebuilder:printcolumn:name="IMAGE",type="string",JSONPath=".spec.image" +kubebuilder:printcolumn:name="STATE",type="string",JSONPath=".spec.desiredState" +kubebuilder:printcolumn:name="DEP-FOUND",type="string",JSONPath=".status.foundDependencies" +kubebuilder:printcolumn:name="DEP-INSTALLED",type="string",JSONPath=".status.installedDependencies" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane,pkgrev}

func (*ProviderRevision) DeepCopy 

func (in *ProviderRevision) DeepCopy() *ProviderRevision

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

func (*ProviderRevision) DeepCopyInto 

func (in *ProviderRevision) DeepCopyInto(out *ProviderRevision)

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

func (*ProviderRevision) DeepCopyObject 

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

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

func (*ProviderRevision) GetCondition 

func (p *ProviderRevision) GetCondition(ct xpv1.ConditionType) xpv1.Condition

GetCondition of this ProviderRevision.

func (*ProviderRevision) GetControllerConfigRef 

func (p *ProviderRevision) GetControllerConfigRef() *ControllerConfigReference

GetControllerConfigRef of this ProviderRevision.

func (*ProviderRevision) GetControllerReference 

func (p *ProviderRevision) GetControllerReference() ControllerReference

GetControllerReference of this ProviderRevision.

func (*ProviderRevision) GetDependencyStatus 

func (p *ProviderRevision) GetDependencyStatus() (found, installed, invalid int64)

GetDependencyStatus of this ProviderRevision.

func (*ProviderRevision) GetDesiredState 

func (p *ProviderRevision) GetDesiredState() PackageRevisionDesiredState

GetDesiredState of this ProviderRevision.

func (*ProviderRevision) GetIgnoreCrossplaneConstraints 

func (p *ProviderRevision) GetIgnoreCrossplaneConstraints() *bool

GetIgnoreCrossplaneConstraints of this ProviderRevision.

func (*ProviderRevision) GetObjects 

func (p *ProviderRevision) GetObjects() []xpv1.TypedReference

GetObjects of this ProviderRevision.

func (*ProviderRevision) GetPackagePullPolicy 

func (p *ProviderRevision) GetPackagePullPolicy() *corev1.PullPolicy

GetPackagePullPolicy of this ProviderRevision.

func (*ProviderRevision) GetPackagePullSecrets 

func (p *ProviderRevision) GetPackagePullSecrets() []corev1.LocalObjectReference

GetPackagePullSecrets of this ProviderRevision.

func (*ProviderRevision) GetRevision 

func (p *ProviderRevision) GetRevision() int64

GetRevision of this ProviderRevision.

func (*ProviderRevision) GetSkipDependencyResolution 

func (p *ProviderRevision) GetSkipDependencyResolution() *bool

GetSkipDependencyResolution of this ProviderRevision.

func (*ProviderRevision) GetSource 

func (p *ProviderRevision) GetSource() string

GetSource of this ProviderRevision.

func (*ProviderRevision) GetWebhookTLSSecretName added in v1.7.0 

func (p *ProviderRevision) GetWebhookTLSSecretName() *string

GetWebhookTLSSecretName of this ProviderRevision.

func (*ProviderRevision) SetConditions 

func (p *ProviderRevision) SetConditions(c ...xpv1.Condition)

SetConditions of this ProviderRevision.

func (*ProviderRevision) SetControllerConfigRef 

func (p *ProviderRevision) SetControllerConfigRef(r *ControllerConfigReference)

SetControllerConfigRef of this ProviderREvsion.

func (*ProviderRevision) SetControllerReference 

func (p *ProviderRevision) SetControllerReference(c ControllerReference)

SetControllerReference of this ProviderRevision.

func (*ProviderRevision) SetDependencyStatus 

func (p *ProviderRevision) SetDependencyStatus(found, installed, invalid int64)

SetDependencyStatus of this ProviderRevision.

func (*ProviderRevision) SetDesiredState 

func (p *ProviderRevision) SetDesiredState(s PackageRevisionDesiredState)

SetDesiredState of this ProviderRevision.

func (*ProviderRevision) SetIgnoreCrossplaneConstraints 

func (p *ProviderRevision) SetIgnoreCrossplaneConstraints(b *bool)

SetIgnoreCrossplaneConstraints of this ProviderRevision.

func (*ProviderRevision) SetObjects 

func (p *ProviderRevision) SetObjects(c []xpv1.TypedReference)

SetObjects of this ProviderRevision.

func (*ProviderRevision) SetPackagePullPolicy 

func (p *ProviderRevision) SetPackagePullPolicy(i *corev1.PullPolicy)

SetPackagePullPolicy of this ProviderRevision.

func (*ProviderRevision) SetPackagePullSecrets 

func (p *ProviderRevision) SetPackagePullSecrets(s []corev1.LocalObjectReference)

SetPackagePullSecrets of this ProviderRevision.

func (*ProviderRevision) SetRevision 

func (p *ProviderRevision) SetRevision(r int64)

SetRevision of this ProviderRevision.

func (*ProviderRevision) SetSkipDependencyResolution 

func (p *ProviderRevision) SetSkipDependencyResolution(b *bool)

SetSkipDependencyResolution of this ProviderRevision.

func (*ProviderRevision) SetSource 

func (p *ProviderRevision) SetSource(s string)

SetSource of this ProviderRevision.

func (*ProviderRevision) SetWebhookTLSSecretName added in v1.7.0 

func (p *ProviderRevision) SetWebhookTLSSecretName(b *string)

SetWebhookTLSSecretName of this ProviderRevision.

type ProviderRevisionList 

type ProviderRevisionList struct {
	metav1.TypeMeta `json:",inline"`
	metav1.ListMeta `json:"metadata,omitempty"`
	Items           []ProviderRevision `json:"items"`
}

ProviderRevisionList contains a list of ProviderRevision.

func (*ProviderRevisionList) DeepCopy 

func (in *ProviderRevisionList) DeepCopy() *ProviderRevisionList

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

func (*ProviderRevisionList) DeepCopyInto 

func (in *ProviderRevisionList) DeepCopyInto(out *ProviderRevisionList)

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

func (*ProviderRevisionList) DeepCopyObject 

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

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

func (*ProviderRevisionList) GetRevisions 

func (p *ProviderRevisionList) GetRevisions() []PackageRevision

GetRevisions of this ProviderRevisionList.

type ProviderSpec 

type ProviderSpec struct {
	PackageSpec `json:",inline"`

	// ControllerConfigRef references a ControllerConfig resource that will be
	// used to configure the packaged controller Deployment.
	// +optional
	ControllerConfigReference *ControllerConfigReference `json:"controllerConfigRef,omitempty"`
}

ProviderSpec specifies details about a request to install a provider to Crossplane.

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 ProviderStatus 

type ProviderStatus struct {
	xpv1.ConditionedStatus `json:",inline"`
	PackageStatus          `json:",inline"`
}

ProviderStatus represents the observed state of a Provider.

func (*ProviderStatus) DeepCopy 

func (in *ProviderStatus) DeepCopy() *ProviderStatus

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

func (*ProviderStatus) DeepCopyInto 

func (in *ProviderStatus) DeepCopyInto(out *ProviderStatus)

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

type RevisionActivationPolicy 

type RevisionActivationPolicy string

RevisionActivationPolicy indicates how a package should activate its revisions. 

var (
	// AutomaticActivation indicates that package should automatically activate
	// package revisions.
	AutomaticActivation RevisionActivationPolicy = "Automatic"
	// ManualActivation indicates that a user will manually activate package
	// revisions.
	ManualActivation RevisionActivationPolicy = "Manual"
)

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.