v1alpha1

package
v1.0.0-rc.0 Latest Latest
Warning

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

Go to latest
Published: Nov 9, 2020 License: Apache-2.0 Imports: 8 Imported by: 5

Documentation

Overview

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

Index

Constants

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

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

Condition types.

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

Reasons a package is or is not installed.

View Source
const (
	Group   = "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 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.

View Source
var (
	ControllerConfigKind             = reflect.TypeOf(ControllerConfig{}).Name()
	ControllerConfigGroupKind        = schema.GroupKind{Group: Group, Kind: ControllerConfigKind}.String()
	ControllerConfigKindAPIVersion   = ControllerConfigKind + "." + SchemeGroupVersion.String()
	ControllerConfigGroupVersionKind = SchemeGroupVersion.WithKind(ControllerConfigKind)
)

ControllerConfig type metadata.

Functions

func Active

func Active() runtimev1alpha1.Condition

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

func Healthy

func Healthy() runtimev1alpha1.Condition

Healthy indicates that the current revision is healthy.

func Inactive

func Inactive() runtimev1alpha1.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() runtimev1alpha1.Condition

Unhealthy indicates that the current revision is unhealthy.

func UnknownHealth added in v0.14.0

func UnknownHealth() runtimev1alpha1.Condition

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

func Unpacking

func Unpacking() runtimev1alpha1.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: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

GetCondition of this Configuration.

func (*Configuration) GetControllerConfigRef added in v0.14.0

func (p *Configuration) GetControllerConfigRef() *runtimev1alpha1.Reference

GetControllerConfigRef of this Configuration.

func (*Configuration) GetCurrentIdentifier added in v0.14.0

func (p *Configuration) GetCurrentIdentifier() string

GetCurrentIdentifier of this Configuration.

func (*Configuration) GetCurrentRevision

func (p *Configuration) GetCurrentRevision() string

GetCurrentRevision of this Configuration.

func (*Configuration) GetIgnoreCrossplaneConstraints added in v0.14.0

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) 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 ...runtimev1alpha1.Condition)

SetConditions of this Configuration.

func (*Configuration) SetControllerConfigRef added in v0.14.0

func (p *Configuration) SetControllerConfigRef(r *runtimev1alpha1.Reference)

SetControllerConfigRef of this Configuration.

func (*Configuration) SetCurrentIdentifier added in v0.14.0

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

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) 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: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="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane}

func (*ConfigurationRevision) DeepCopy

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

GetCondition of this ConfigurationRevision.

func (*ConfigurationRevision) GetControllerConfigRef added in v0.14.0

func (p *ConfigurationRevision) GetControllerConfigRef() *runtimev1alpha1.Reference

GetControllerConfigRef of this ConfigurationRevision.

func (*ConfigurationRevision) GetControllerReference

func (p *ConfigurationRevision) GetControllerReference() runtimev1alpha1.Reference

GetControllerReference of this ConfigurationRevision.

func (*ConfigurationRevision) GetDesiredState

GetDesiredState of this ConfigurationRevision.

func (*ConfigurationRevision) GetIgnoreCrossplaneConstraints added in v0.14.0

func (p *ConfigurationRevision) GetIgnoreCrossplaneConstraints() *bool

GetIgnoreCrossplaneConstraints of this ConfigurationRevision.

func (*ConfigurationRevision) GetObjects

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) GetSource

func (p *ConfigurationRevision) GetSource() string

GetSource of this ConfigurationRevision.

func (*ConfigurationRevision) SetConditions

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

SetConditions of this ConfigurationRevision.

func (*ConfigurationRevision) SetControllerConfigRef added in v0.14.0

func (p *ConfigurationRevision) SetControllerConfigRef(r *runtimev1alpha1.Reference)

SetControllerConfigRef of this ConfigurationRevision.

func (*ConfigurationRevision) SetControllerReference

func (p *ConfigurationRevision) SetControllerReference(c runtimev1alpha1.Reference)

SetControllerReference of this ConfigurationRevision.

func (*ConfigurationRevision) SetDesiredState

func (p *ConfigurationRevision) SetDesiredState(s PackageRevisionDesiredState)

SetDesiredState of this ConfigurationRevision.

func (*ConfigurationRevision) SetIgnoreCrossplaneConstraints added in v0.14.0

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

SetIgnoreCrossplaneConstraints of this ConfigurationRevision.

func (*ConfigurationRevision) SetObjects

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) SetSource

func (p *ConfigurationRevision) SetSource(s string)

SetSource 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

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

func (*ConfigurationRevisionList) DeepCopyInto

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

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

	Spec ControllerConfigSpec `json:"spec,omitempty"`
}

ControllerConfig is the CRD type for a packaged controller configuration. +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster

func (*ControllerConfig) DeepCopy added in v0.14.0

func (in *ControllerConfig) DeepCopy() *ControllerConfig

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

func (*ControllerConfig) DeepCopyInto added in v0.14.0

func (in *ControllerConfig) DeepCopyInto(out *ControllerConfig)

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

func (*ControllerConfig) DeepCopyObject added in v0.14.0

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

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

type ControllerConfigList added in v0.14.0

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

ControllerConfigList contains a list of ControllerConfig.

func (*ControllerConfigList) DeepCopy added in v0.14.0

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

func (*ControllerConfigList) DeepCopyInto added in v0.14.0

func (in *ControllerConfigList) DeepCopyInto(out *ControllerConfigList)

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

func (*ControllerConfigList) DeepCopyObject added in v0.14.0

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

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

type ControllerConfigSpec added in v0.14.0

type ControllerConfigSpec struct {
	// Number of desired pods. This is a pointer to distinguish between explicit
	// zero and not specified. Defaults to 1.
	// Note: If more than 1 replica is set and leader election is not enabled then
	// controllers could conflict. Environment variable "LEADER_ELECTION" can be
	// used to enable leader election process.
	// +optional
	Replicas *int32 `json:"replicas,omitempty"`
	// NodeSelector is a selector which must be true for the pod to fit on a node.
	// Selector which must match a node's labels for the pod to be scheduled on that node.
	// More info: https://kubernetes.io/docs/concepts/configuration/assign-pod-node/
	// +optional
	NodeSelector map[string]string `json:"nodeSelector,omitempty"`
	// ServiceAccountName is the name of the ServiceAccount to use to run this pod.
	// More info: https://kubernetes.io/docs/tasks/configure-pod-container/configure-service-account/
	// +optional
	ServiceAccountName *string `json:"serviceAccountName,omitempty"`
	// NodeName is a request to schedule this pod onto a specific node. If it is non-empty,
	// the scheduler simply schedules this pod onto that node, assuming that it fits resource
	// requirements.
	// +optional
	NodeName *string `json:"nodeName,omitempty"`
	// PodSecurityContext holds pod-level security attributes and common container settings.
	// Optional: Defaults to empty.  See type description for default values of each field.
	// +optional
	PodSecurityContext *corev1.PodSecurityContext `json:"podSecurityContext,omitempty"`
	// SecurityContext holds container-level security attributes and common container settings.
	// Optional: Defaults to empty.  See type description for default values of each field.
	// +optional
	SecurityContext *corev1.SecurityContext `json:"securityContext,omitempty"`
	// ImagePullSecrets is an optional list of references to secrets in the same namespace to use for pulling any of the images used by this PodSpec.
	// If specified, these secrets will be passed to individual puller implementations for them to use. For example,
	// in the case of docker, only DockerConfig type secrets are honored.
	// More info: https://kubernetes.io/docs/concepts/containers/images#specifying-imagepullsecrets-on-a-pod
	// Setting ImagePullSecrets will replace any secrets that have been
	// propagated to a controller Deployment, typically via packagePullSecrets.
	// +optional
	ImagePullSecrets []corev1.LocalObjectReference `json:"imagePullSecrets,omitempty"`
	// Image pull policy.
	// One of Always, Never, IfNotPresent.
	// Defaults to Always if :latest tag is specified, or IfNotPresent otherwise.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/containers/images#updating-images
	// +optional
	ImagePullPolicy *corev1.PullPolicy `json:"imagePullPolicy,omitempty"`
	// If specified, the pod's scheduling constraints
	// +optional
	Affinity *corev1.Affinity `json:"affinity,omitempty"`
	// If specified, the pod's tolerations.
	// +optional
	Tolerations []corev1.Toleration `json:"tolerations,omitempty"`
	// If specified, indicates the pod's priority. "system-node-critical" and
	// "system-cluster-critical" are two special keywords which indicate the
	// highest priorities with the former being the highest priority. Any other
	// name must be defined by creating a PriorityClass object with that name.
	// If not specified, the pod priority will be default or zero if there is no
	// default.
	// +optional
	PriorityClassName *string `json:"priorityClassName,omitempty"`
	// RuntimeClassName refers to a RuntimeClass object in the node.k8s.io group, which should be used
	// to run this pod.  If no RuntimeClass resource matches the named class, the pod will not be run.
	// If unset or empty, the "legacy" RuntimeClass will be used, which is an implicit class with an
	// empty definition that uses the default runtime handler.
	// More info: https://git.k8s.io/enhancements/keps/sig-node/runtime-class.md
	// This is a beta feature as of Kubernetes v1.14.
	// +optional
	RuntimeClassName *string `json:"runtimeClassName,omitempty"`
	// Compute Resources required by this container.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/concepts/configuration/manage-compute-resources-container/
	// +optional
	ResourceRequirements *corev1.ResourceRequirements `json:"resources,omitempty"`
	// Arguments to the entrypoint.
	// The docker image's CMD is used if this is not provided.
	// Variable references $(VAR_NAME) are expanded using the container's environment. If a variable
	// cannot be resolved, the reference in the input string will be unchanged. The $(VAR_NAME) syntax
	// can be escaped with a double $$, ie: $$(VAR_NAME). Escaped references will never be expanded,
	// regardless of whether the variable exists or not.
	// Cannot be updated.
	// More info: https://kubernetes.io/docs/tasks/inject-data-application/define-command-argument-container/#running-a-command-in-a-shell
	// +optional
	Args []string `json:"args,omitempty"`
	// List of sources to populate environment variables in the container.
	// The keys defined within a source must be a C_IDENTIFIER. All invalid keys
	// will be reported as an event when the container is starting. When a key exists in multiple
	// sources, the value associated with the last source will take precedence.
	// Values defined by an Env with a duplicate key will take precedence.
	// Cannot be updated.
	// +optional
	EnvFrom []corev1.EnvFromSource `json:"envFrom,omitempty"`
	// List of environment variables to set in the container.
	// Cannot be updated.
	// +optional
	Env []corev1.EnvVar `json:"env,omitempty"`
}

ControllerConfigSpec specifies the configuration for a packaged controller. Values provided will override package manager defaults. Labels and annotations are passed to both the controller Deployment and ServiceAccount.

func (*ControllerConfigSpec) DeepCopy added in v0.14.0

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

func (*ControllerConfigSpec) DeepCopyInto added in v0.14.0

func (in *ControllerConfigSpec) DeepCopyInto(out *ControllerConfigSpec)

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() *runtimev1alpha1.Reference
	SetControllerConfigRef(r *runtimev1alpha1.Reference)

	GetCurrentRevision() string
	SetCurrentRevision(r string)

	GetCurrentIdentifier() string
	SetCurrentIdentifier(r string)
}

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

type PackageRevision

type PackageRevision interface {
	resource.Object
	resource.Conditioned

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

	GetControllerReference() runtimev1alpha1.Reference
	SetControllerReference(c runtimev1alpha1.Reference)

	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() *runtimev1alpha1.Reference
	SetControllerConfigRef(r *runtimev1alpha1.Reference)

	GetRevision() int64
	SetRevision(r int64)
}

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 {
	runtime.Object

	// 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 *v1alpha1.Reference `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"`
}

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 {
	runtimev1alpha1.ConditionedStatus `json:",inline"`
	ControllerRef                     runtimev1alpha1.Reference `json:"controllerRef,omitempty"`

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

PackageRevisionStatus represents the observed state of a PackageRevision.

func (*PackageRevisionStatus) DeepCopy

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"`
}

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: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

GetCondition of this Provider.

func (*Provider) GetControllerConfigRef added in v0.14.0

func (p *Provider) GetControllerConfigRef() *runtimev1alpha1.Reference

GetControllerConfigRef of this Provider.

func (*Provider) GetCurrentIdentifier added in v0.14.0

func (p *Provider) GetCurrentIdentifier() string

GetCurrentIdentifier of this Provider.

func (*Provider) GetCurrentRevision

func (p *Provider) GetCurrentRevision() string

GetCurrentRevision of this Provider.

func (*Provider) GetIgnoreCrossplaneConstraints added in v0.14.0

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) 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 ...runtimev1alpha1.Condition)

SetConditions of this Provider.

func (*Provider) SetControllerConfigRef added in v0.14.0

func (p *Provider) SetControllerConfigRef(r *runtimev1alpha1.Reference)

SetControllerConfigRef of this Provider.

func (*Provider) SetCurrentIdentifier added in v0.14.0

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

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) 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: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="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane}

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

GetCondition of this ProviderRevision.

func (*ProviderRevision) GetControllerConfigRef added in v0.14.0

func (p *ProviderRevision) GetControllerConfigRef() *runtimev1alpha1.Reference

GetControllerConfigRef of this ProviderRevision.

func (*ProviderRevision) GetControllerReference

func (p *ProviderRevision) GetControllerReference() runtimev1alpha1.Reference

GetControllerReference of this ProviderRevision.

func (*ProviderRevision) GetDesiredState

func (p *ProviderRevision) GetDesiredState() PackageRevisionDesiredState

GetDesiredState of this ProviderRevision.

func (*ProviderRevision) GetIgnoreCrossplaneConstraints added in v0.14.0

func (p *ProviderRevision) GetIgnoreCrossplaneConstraints() *bool

GetIgnoreCrossplaneConstraints of this ProviderRevision.

func (*ProviderRevision) GetObjects

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) GetSource

func (p *ProviderRevision) GetSource() string

GetSource of this ProviderRevision.

func (*ProviderRevision) SetConditions

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

SetConditions of this ProviderRevision.

func (*ProviderRevision) SetControllerConfigRef added in v0.14.0

func (p *ProviderRevision) SetControllerConfigRef(r *runtimev1alpha1.Reference)

SetControllerConfigRef of this ProviderREvsion.

func (*ProviderRevision) SetControllerReference

func (p *ProviderRevision) SetControllerReference(c runtimev1alpha1.Reference)

SetControllerReference of this ProviderRevision.

func (*ProviderRevision) SetDesiredState

func (p *ProviderRevision) SetDesiredState(s PackageRevisionDesiredState)

SetDesiredState of this ProviderRevision.

func (*ProviderRevision) SetIgnoreCrossplaneConstraints added in v0.14.0

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

SetIgnoreCrossplaneConstraints of this ProviderRevision.

func (*ProviderRevision) SetObjects

func (p *ProviderRevision) SetObjects(c []runtimev1alpha1.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) SetSource

func (p *ProviderRevision) SetSource(s string)

SetSource 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

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 *v1alpha1.Reference `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 {
	v1alpha1.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"
)

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL