v1beta1

package
v1.17.0 Latest Latest
Warning

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

Go to latest
Published: Aug 28, 2024 License: Apache-2.0 Imports: 10 Imported by: 6

Documentation

Overview

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

Index

Constants

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

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 (
	LockKind             = reflect.TypeOf(Lock{}).Name()
	LockGroupKind        = schema.GroupKind{Group: Group, Kind: LockKind}.String()
	LockKindAPIVersion   = LockKind + "." + SchemeGroupVersion.String()
	LockGroupVersionKind = SchemeGroupVersion.WithKind(LockKind)
)

Lock type metadata.

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

Function type metadata.

View Source
var (
	FunctionRevisionKind             = reflect.TypeOf(FunctionRevision{}).Name()
	FunctionRevisionGroupKind        = schema.GroupKind{Group: Group, Kind: FunctionRevisionKind}.String()
	FunctionRevisionKindAPIVersion   = FunctionRevisionKind + "." + SchemeGroupVersion.String()
	FunctionRevisionGroupVersionKind = SchemeGroupVersion.WithKind(FunctionRevisionKind)
)

FunctionRevision type metadata.

View Source
var (
	DeploymentRuntimeConfigKind             = reflect.TypeOf(DeploymentRuntimeConfig{}).Name()
	DeploymentRuntimeConfigGroupKind        = schema.GroupKind{Group: Group, Kind: DeploymentRuntimeConfigKind}.String()
	DeploymentRuntimeConfigKindAPIVersion   = DeploymentRuntimeConfigKind + "." + SchemeGroupVersion.String()
	DeploymentRuntimeConfigGroupVersionKind = SchemeGroupVersion.WithKind(DeploymentRuntimeConfigKind)
)

DeploymentRuntimeConfig type metadata.

Functions

func ToNodes added in v1.4.0

func ToNodes(pkgs ...LockPackage) []dag.Node

ToNodes converts LockPackages to DAG nodes.

Types

type ControllerConfigReference added in v1.17.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.17.0

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

func (*ControllerConfigReference) DeepCopyInto added in v1.17.0

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

type ControllerReference added in v1.17.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.17.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.17.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 Dependency added in v1.4.0

type Dependency struct {
	// Package is the OCI image name without a tag or digest.
	Package string `json:"package"`

	// Type is the type of package. Can be either Configuration or Provider.
	Type PackageType `json:"type"`

	// Constraints is a valid semver range, which will be used to select a valid
	// dependency version.
	Constraints string `json:"constraints"`
}

A Dependency is a dependency of a package in the lock.

func (*Dependency) AddNeighbors added in v1.4.0

func (d *Dependency) AddNeighbors(...dag.Node) error

AddNeighbors is a no-op for dependencies. We should never be adding neighbors to a dependency.

func (*Dependency) DeepCopy added in v1.4.0

func (in *Dependency) DeepCopy() *Dependency

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

func (*Dependency) DeepCopyInto added in v1.4.0

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

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

func (*Dependency) Identifier added in v1.4.0

func (d *Dependency) Identifier() string

Identifier returns a dependency's source.

func (*Dependency) Neighbors added in v1.4.0

func (d *Dependency) Neighbors() []dag.Node

Neighbors in is a no-op for dependencies because we are not yet aware of its dependencies.

type DeploymentRuntimeConfig added in v1.14.0

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

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

The DeploymentRuntimeConfig provides settings for the Kubernetes Deployment of a Provider or composition function package.

Read the Crossplane documentation for [more information about DeploymentRuntimeConfigs](https://docs.crossplane.io/latest/concepts/providers/#runtime-configuration). +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories={crossplane}

func (*DeploymentRuntimeConfig) DeepCopy added in v1.14.0

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

func (*DeploymentRuntimeConfig) DeepCopyInto added in v1.14.0

func (in *DeploymentRuntimeConfig) DeepCopyInto(out *DeploymentRuntimeConfig)

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

func (*DeploymentRuntimeConfig) DeepCopyObject added in v1.14.0

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

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

type DeploymentRuntimeConfigList added in v1.14.0

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

DeploymentRuntimeConfigList contains a list of DeploymentRuntimeConfig.

func (*DeploymentRuntimeConfigList) DeepCopy added in v1.14.0

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

func (*DeploymentRuntimeConfigList) DeepCopyInto added in v1.14.0

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

func (*DeploymentRuntimeConfigList) DeepCopyObject added in v1.14.0

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

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

type DeploymentRuntimeConfigSpec added in v1.14.0

type DeploymentRuntimeConfigSpec struct {
	// DeploymentTemplate is the template for the Deployment object.
	// +optional
	DeploymentTemplate *DeploymentTemplate `json:"deploymentTemplate,omitempty"`
	// ServiceTemplate is the template for the Service object.
	// +optional
	ServiceTemplate *ServiceTemplate `json:"serviceTemplate,omitempty"`
	// ServiceAccountTemplate is the template for the ServiceAccount object.
	// +optional
	ServiceAccountTemplate *ServiceAccountTemplate `json:"serviceAccountTemplate,omitempty"`
}

DeploymentRuntimeConfigSpec 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 (*DeploymentRuntimeConfigSpec) DeepCopy added in v1.14.0

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

func (*DeploymentRuntimeConfigSpec) DeepCopyInto added in v1.14.0

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

type DeploymentTemplate added in v1.14.0

type DeploymentTemplate struct {
	// Metadata contains the configurable metadata fields for the Deployment.
	// +optional
	Metadata *ObjectMeta `json:"metadata,omitempty"`

	// Spec contains the configurable spec fields for the Deployment object.
	// +optional
	Spec *appsv1.DeploymentSpec `json:"spec,omitempty"`
}

DeploymentTemplate is the template for the Deployment object.

func (*DeploymentTemplate) DeepCopy added in v1.14.0

func (in *DeploymentTemplate) DeepCopy() *DeploymentTemplate

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

func (*DeploymentTemplate) DeepCopyInto added in v1.14.0

func (in *DeploymentTemplate) DeepCopyInto(out *DeploymentTemplate)

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

type Function added in v1.14.0

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

	Spec   FunctionSpec   `json:"spec,omitempty"`
	Status FunctionStatus `json:"status,omitempty"`
}

A Function installs an OCI compatible Crossplane package, extending Crossplane with support for a new kind of composition function.

Read the Crossplane documentation for [more information about Functions](https://docs.crossplane.io/latest/concepts/composition-functions). +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 (*Function) DeepCopy added in v1.14.0

func (in *Function) DeepCopy() *Function

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

func (*Function) DeepCopyInto added in v1.14.0

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

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

func (*Function) DeepCopyObject added in v1.14.0

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

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

type FunctionList added in v1.14.0

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

FunctionList contains a list of Function.

func (*FunctionList) DeepCopy added in v1.14.0

func (in *FunctionList) DeepCopy() *FunctionList

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

func (*FunctionList) DeepCopyInto added in v1.14.0

func (in *FunctionList) DeepCopyInto(out *FunctionList)

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

func (*FunctionList) DeepCopyObject added in v1.14.0

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

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

type FunctionRevision added in v1.14.0

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

	Spec   FunctionRevisionSpec   `json:"spec,omitempty"`
	Status FunctionRevisionStatus `json:"status,omitempty"`
}

A FunctionRevision represents a revision of a Function. Crossplane creates new revisions when there are changes to the Function.

Crossplane creates and manages FunctionRevisions. Don't directly edit FunctionRevisions. +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="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 (*FunctionRevision) DeepCopy added in v1.14.0

func (in *FunctionRevision) DeepCopy() *FunctionRevision

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

func (*FunctionRevision) DeepCopyInto added in v1.14.0

func (in *FunctionRevision) DeepCopyInto(out *FunctionRevision)

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

func (*FunctionRevision) DeepCopyObject added in v1.14.0

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

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

type FunctionRevisionList added in v1.14.0

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

FunctionRevisionList contains a list of FunctionRevision.

func (*FunctionRevisionList) DeepCopy added in v1.14.0

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

func (*FunctionRevisionList) DeepCopyInto added in v1.14.0

func (in *FunctionRevisionList) DeepCopyInto(out *FunctionRevisionList)

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

func (*FunctionRevisionList) DeepCopyObject added in v1.14.0

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

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

type FunctionRevisionSpec added in v1.14.0

type FunctionRevisionSpec struct {
	PackageRevisionSpec        `json:",inline"`
	PackageRevisionRuntimeSpec `json:",inline"`
}

FunctionRevisionSpec specifies configuration for a FunctionRevision.

func (*FunctionRevisionSpec) DeepCopy added in v1.14.0

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

func (*FunctionRevisionSpec) DeepCopyInto added in v1.14.0

func (in *FunctionRevisionSpec) DeepCopyInto(out *FunctionRevisionSpec)

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

type FunctionRevisionStatus added in v1.14.0

type FunctionRevisionStatus struct {
	PackageRevisionStatus `json:",inline"`

	// Endpoint is the gRPC endpoint where Crossplane will send
	// RunFunctionRequests.
	Endpoint string `json:"endpoint,omitempty"`
}

FunctionRevisionStatus represents the observed state of a FunctionRevision.

func (*FunctionRevisionStatus) DeepCopy added in v1.14.0

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

func (*FunctionRevisionStatus) DeepCopyInto added in v1.14.0

func (in *FunctionRevisionStatus) DeepCopyInto(out *FunctionRevisionStatus)

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

type FunctionSpec added in v1.14.0

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

	PackageRuntimeSpec `json:",inline"`
}

FunctionSpec specifies the configuration of a Function.

func (*FunctionSpec) DeepCopy added in v1.14.0

func (in *FunctionSpec) DeepCopy() *FunctionSpec

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

func (*FunctionSpec) DeepCopyInto added in v1.14.0

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

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

type FunctionStatus added in v1.14.0

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

FunctionStatus represents the observed state of a Function.

func (*FunctionStatus) DeepCopy added in v1.14.0

func (in *FunctionStatus) DeepCopy() *FunctionStatus

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

func (*FunctionStatus) DeepCopyInto added in v1.14.0

func (in *FunctionStatus) DeepCopyInto(out *FunctionStatus)

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

type Lock added in v1.4.0

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

	Packages []LockPackage `json:"packages,omitempty"`
}

Lock is the CRD type that tracks package dependencies. +kubebuilder:storageversion +kubebuilder:subresource:status +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster

func (*Lock) DeepCopy added in v1.4.0

func (in *Lock) DeepCopy() *Lock

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

func (*Lock) DeepCopyInto added in v1.4.0

func (in *Lock) DeepCopyInto(out *Lock)

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

func (*Lock) DeepCopyObject added in v1.4.0

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

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

type LockList added in v1.4.0

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

LockList contains a list of Lock.

func (*LockList) DeepCopy added in v1.4.0

func (in *LockList) DeepCopy() *LockList

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

func (*LockList) DeepCopyInto added in v1.4.0

func (in *LockList) DeepCopyInto(out *LockList)

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

func (*LockList) DeepCopyObject added in v1.4.0

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

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

type LockPackage added in v1.4.0

type LockPackage struct {
	// Name corresponds to the name of the package revision for this package.
	Name string `json:"name"`

	// Type is the type of package. Can be either Configuration or Provider.
	Type PackageType `json:"type"`

	// Source is the OCI image name without a tag or digest.
	Source string `json:"source"`

	// Version is the tag or digest of the OCI image.
	Version string `json:"version"`

	// Dependencies are the list of dependencies of this package. The order of
	// the dependencies will dictate the order in which they are resolved.
	Dependencies []Dependency `json:"dependencies"`
}

LockPackage is a package that is in the lock.

func (*LockPackage) AddNeighbors added in v1.4.0

func (l *LockPackage) AddNeighbors(_ ...dag.Node) error

AddNeighbors adds dependencies to a LockPackage. A LockPackage should always have all dependencies declared before being added to the Lock, so we no-op when adding a neighbor.

func (*LockPackage) DeepCopy added in v1.4.0

func (in *LockPackage) DeepCopy() *LockPackage

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

func (*LockPackage) DeepCopyInto added in v1.4.0

func (in *LockPackage) DeepCopyInto(out *LockPackage)

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

func (*LockPackage) Identifier added in v1.4.0

func (l *LockPackage) Identifier() string

Identifier returns the source of a LockPackage.

func (*LockPackage) Neighbors added in v1.4.0

func (l *LockPackage) Neighbors() []dag.Node

Neighbors returns dependencies of a LockPackage.

type ObjectMeta added in v1.14.0

type ObjectMeta struct {
	// Name is the name of the object.
	// +optional
	Name *string `json:"name,omitempty"`
	// Annotations is an unstructured key value map stored with a resource that
	// may be set by external tools to store and retrieve arbitrary metadata.
	// They are not queryable and should be preserved when modifying objects.
	// More info: http:https://kubernetes.io/docs/concepts/overview/working-with-objects/annotations/
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`

	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. Labels will be merged with internal labels
	// used by crossplane, and labels with a crossplane.io key might be
	// overwritten.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
	// +optional
	Labels map[string]string `json:"labels,omitempty"`
}

ObjectMeta is metadata contains the configurable metadata fields for the runtime objects.

func (*ObjectMeta) DeepCopy added in v1.14.0

func (in *ObjectMeta) DeepCopy() *ObjectMeta

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

func (*ObjectMeta) DeepCopyInto added in v1.14.0

func (in *ObjectMeta) DeepCopyInto(out *ObjectMeta)

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

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

type PackageRevisionRuntimeSpec struct {
	PackageRuntimeSpec `json:",inline"`
	// TLSServerSecretName is the name of the TLS Secret that stores server
	// certificates of the Provider.
	// +optional
	TLSServerSecretName *string `json:"tlsServerSecretName,omitempty"`

	// TLSClientSecretName is the name of the TLS Secret that stores client
	// certificates of the Provider.
	// +optional
	TLSClientSecretName *string `json:"tlsClientSecretName,omitempty"`
}

PackageRevisionRuntimeSpec specifies configuration for the runtime of a package revision. Only used by packages that uses a runtime, i.e. by providers and functions but not for configurations.

func (*PackageRevisionRuntimeSpec) DeepCopy added in v1.17.0

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

func (*PackageRevisionRuntimeSpec) DeepCopyInto added in v1.17.0

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

type PackageRevisionSpec

type PackageRevisionSpec struct {
	// 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"`

	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. May match selectors of replication controllers
	// and services.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
	// +optional
	CommonLabels map[string]string `json:"commonLabels,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"`

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

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

type PackageRuntimeSpec struct {
	// ControllerConfigRef references a ControllerConfig resource that will be
	// used to configure the packaged controller Deployment.
	// Deprecated: Use RuntimeConfigReference instead.
	// +optional
	ControllerConfigReference *ControllerConfigReference `json:"controllerConfigRef,omitempty"`
	// RuntimeConfigRef references a RuntimeConfig resource that will be used
	// to configure the package runtime.
	// +optional
	// +kubebuilder:default={"name": "default"}
	RuntimeConfigReference *RuntimeConfigReference `json:"runtimeConfigRef,omitempty"`
}

PackageRuntimeSpec specifies configuration for the runtime of a package. Only used by packages that uses a runtime, i.e. by providers and functions but not for configurations.

func (*PackageRuntimeSpec) DeepCopy added in v1.17.0

func (in *PackageRuntimeSpec) DeepCopy() *PackageRuntimeSpec

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

func (*PackageRuntimeSpec) DeepCopyInto added in v1.17.0

func (in *PackageRuntimeSpec) DeepCopyInto(out *PackageRuntimeSpec)

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

	// Map of string keys and values that can be used to organize and categorize
	// (scope and select) objects. May match selectors of replication controllers
	// and services.
	// More info: https://kubernetes.io/docs/concepts/overview/working-with-objects/labels/
	// +optional
	CommonLabels map[string]string `json:"commonLabels,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 PackageType added in v1.4.0

type PackageType string

A PackageType is a type of package.

const (
	ConfigurationPackageType PackageType = "Configuration"
	ProviderPackageType      PackageType = "Provider"
	FunctionPackageType      PackageType = "Function"
)

Types of packages.

type RevisionActivationPolicy

type RevisionActivationPolicy string

RevisionActivationPolicy indicates how a package should activate its revisions.

type RuntimeConfigReference added in v1.17.0

type RuntimeConfigReference struct {
	// API version of the referent.
	// +optional
	// +kubebuilder:default="pkg.crossplane.io/v1beta1"
	APIVersion *string `json:"apiVersion,omitempty"`
	// Kind of the referent.
	// +optional
	// +kubebuilder:default="DeploymentRuntimeConfig"
	Kind *string `json:"kind,omitempty"`
	// Name of the RuntimeConfig.
	Name string `json:"name"`
}

A RuntimeConfigReference to a runtime config resource that will be used to configure the package runtime.

func (*RuntimeConfigReference) DeepCopy added in v1.17.0

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

func (*RuntimeConfigReference) DeepCopyInto added in v1.17.0

func (in *RuntimeConfigReference) DeepCopyInto(out *RuntimeConfigReference)

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

type ServiceAccountTemplate added in v1.14.0

type ServiceAccountTemplate struct {
	// Metadata contains the configurable metadata fields for the ServiceAccount.
	// +optional
	Metadata *ObjectMeta `json:"metadata,omitempty"`
}

ServiceAccountTemplate is the template for the ServiceAccount object.

func (*ServiceAccountTemplate) DeepCopy added in v1.14.0

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

func (*ServiceAccountTemplate) DeepCopyInto added in v1.14.0

func (in *ServiceAccountTemplate) DeepCopyInto(out *ServiceAccountTemplate)

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

type ServiceTemplate added in v1.14.0

type ServiceTemplate struct {
	// Metadata contains the configurable metadata fields for the Service.
	// +optional
	Metadata *ObjectMeta `json:"metadata,omitempty"`
}

ServiceTemplate is the template for the Service object.

func (*ServiceTemplate) DeepCopy added in v1.14.0

func (in *ServiceTemplate) DeepCopy() *ServiceTemplate

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

func (*ServiceTemplate) DeepCopyInto added in v1.14.0

func (in *ServiceTemplate) DeepCopyInto(out *ServiceTemplate)

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

Jump to

Keyboard shortcuts

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