v1alpha1

package
v1.17.4 Latest Latest
Warning

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

 Go to latest Published: Dec 17, 2024 License: Apache-2.0 Imports: 7 Imported by: 6

Documentation

Overview

Package v1alpha1 contains API types that extend the Crossplane API. v1alpha1 composition revision schema is identical to v1beta1 +kubebuilder:object:generate=true +groupName=apiextensions.crossplane.io +versionName=v1alpha1

Index

Constants

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

Package type metadata.

Variables

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

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

	// AddToScheme adds all registered types to scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)
View Source 
var (
	EnvironmentConfigKind             = reflect.TypeOf(EnvironmentConfig{}).Name()
	EnvironmentConfigGroupKind        = schema.GroupKind{Group: Group, Kind: EnvironmentConfigKind}.String()
	EnvironmentConfigKindAPIVersion   = EnvironmentConfigKind + "." + SchemeGroupVersion.String()
	EnvironmentConfigGroupVersionKind = SchemeGroupVersion.WithKind(EnvironmentConfigKind)
)

EnvironmentConfig type metadata.

View Source 
var (
	UsageKind             = reflect.TypeOf(Usage{}).Name()
	UsageGroupKind        = schema.GroupKind{Group: Group, Kind: UsageKind}.String()
	UsageKindAPIVersion   = UsageKind + "." + SchemeGroupVersion.String()
	UsageGroupVersionKind = SchemeGroupVersion.WithKind(UsageKind)
)

Usage type metadata.

Functions

This section is empty.

Types

type EnvironmentConfig added in v1.11.0 

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

	// The data of this EnvironmentConfig.
	// This may contain any kind of structure that can be serialized into JSON.
	// +optional
	Data map[string]extv1.JSON `json:"data,omitempty"`
}

An EnvironmentConfig contains user-defined unstructured values for use in a Composition.

Read the Crossplane documentation for [more information about EnvironmentConfigs](https://docs.crossplane.io/latest/concepts/environment-configs). +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories=crossplane,shortName=envcfg

func (*EnvironmentConfig) DeepCopy added in v1.11.0 

func (in *EnvironmentConfig) DeepCopy() *EnvironmentConfig

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

func (*EnvironmentConfig) DeepCopyInto added in v1.11.0 

func (in *EnvironmentConfig) DeepCopyInto(out *EnvironmentConfig)

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

func (*EnvironmentConfig) DeepCopyObject added in v1.11.0 

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

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

type EnvironmentConfigList added in v1.11.0 

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

EnvironmentConfigList contains a list of EnvironmentConfigs.

func (*EnvironmentConfigList) DeepCopy added in v1.11.0 

func (in *EnvironmentConfigList) DeepCopy() *EnvironmentConfigList

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

func (*EnvironmentConfigList) DeepCopyInto added in v1.11.0 

func (in *EnvironmentConfigList) DeepCopyInto(out *EnvironmentConfigList)

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

func (*EnvironmentConfigList) DeepCopyObject added in v1.11.0 

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

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

type Resource added in v1.14.0 

type Resource struct {
	// API version of the referent.
	// +optional
	APIVersion string `json:"apiVersion,omitempty"`
	// Kind of the referent.
	// More info: https://git.k8s.io/community/contributors/devel/sig-architecture/api-conventions.md#types-kinds
	// +optional
	Kind string `json:"kind,omitempty"`
	// Reference to the resource.
	// +optional
	ResourceRef *ResourceRef `json:"resourceRef,omitempty"`
	// Selector to the resource.
	// This field will be ignored if ResourceRef is set.
	// +optional
	ResourceSelector *ResourceSelector `json:"resourceSelector,omitempty"`
}

Resource defines a cluster-scoped resource.

func (*Resource) DeepCopy added in v1.14.0 

func (in *Resource) DeepCopy() *Resource

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

func (*Resource) DeepCopyInto added in v1.14.0 

func (in *Resource) DeepCopyInto(out *Resource)

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

type ResourceRef added in v1.14.0 

type ResourceRef struct {
	// Name of the referent.
	Name string `json:"name"`
}

ResourceRef is a reference to a resource.

func (*ResourceRef) DeepCopy added in v1.14.0 

func (in *ResourceRef) DeepCopy() *ResourceRef

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

func (*ResourceRef) DeepCopyInto added in v1.14.0 

func (in *ResourceRef) DeepCopyInto(out *ResourceRef)

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

type ResourceSelector added in v1.14.0 

type ResourceSelector struct {
	// MatchLabels ensures an object with matching labels is selected.
	MatchLabels map[string]string `json:"matchLabels,omitempty"`

	// MatchControllerRef ensures an object with the same controller reference
	// as the selecting object is selected.
	MatchControllerRef *bool `json:"matchControllerRef,omitempty"`
}

ResourceSelector is a selector to a resource.

func (*ResourceSelector) DeepCopy added in v1.14.0 

func (in *ResourceSelector) DeepCopy() *ResourceSelector

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

func (*ResourceSelector) DeepCopyInto added in v1.14.0 

func (in *ResourceSelector) DeepCopyInto(out *ResourceSelector)

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

type Usage added in v1.14.0 

type Usage struct {
	metav1.TypeMeta   `json:",inline"`
	metav1.ObjectMeta `json:"metadata,omitempty"`
	// +kubebuilder:validation:XValidation:rule="has(self.by) || has(self.reason)",message="either \"spec.by\" or \"spec.reason\" must be specified."
	Spec   UsageSpec   `json:"spec"`
	Status UsageStatus `json:"status,omitempty"`
}

A Usage defines a deletion blocking relationship between two resources.

Usages prevent accidental deletion of a single resource or deletion of resources with dependent resources.

Read the Crossplane documentation for [more information about Compositions](https://docs.crossplane.io/latest/concepts/usages). +kubebuilder:object:root=true +kubebuilder:storageversion +kubebuilder:printcolumn:name="DETAILS",type="string",JSONPath=".metadata.annotations.crossplane\\.io/usage-details" +kubebuilder:printcolumn:name="READY",type="string",JSONPath=".status.conditions[?(@.type=='Ready')].status" +kubebuilder:printcolumn:name="AGE",type="date",JSONPath=".metadata.creationTimestamp" +kubebuilder:resource:scope=Cluster,categories=crossplane +kubebuilder:subresource:status

func (*Usage) DeepCopy added in v1.14.0 

func (in *Usage) DeepCopy() *Usage

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

func (*Usage) DeepCopyInto added in v1.14.0 

func (in *Usage) DeepCopyInto(out *Usage)

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

func (*Usage) DeepCopyObject added in v1.14.0 

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

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

type UsageList added in v1.14.0 

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

UsageList contains a list of Usage.

func (*UsageList) DeepCopy added in v1.14.0 

func (in *UsageList) DeepCopy() *UsageList

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

func (*UsageList) DeepCopyInto added in v1.14.0 

func (in *UsageList) DeepCopyInto(out *UsageList)

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

func (*UsageList) DeepCopyObject added in v1.14.0 

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

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

type UsageSpec added in v1.14.0 

type UsageSpec struct {
	// Of is the resource that is "being used".
	// +kubebuilder:validation:XValidation:rule="has(self.resourceRef) || has(self.resourceSelector)",message="either a resource reference or a resource selector should be set."
	Of Resource `json:"of"`
	// By is the resource that is "using the other resource".
	// +optional
	// +kubebuilder:validation:XValidation:rule="has(self.resourceRef) || has(self.resourceSelector)",message="either a resource reference or a resource selector should be set."
	By *Resource `json:"by,omitempty"`
	// Reason is the reason for blocking deletion of the resource.
	// +optional
	Reason *string `json:"reason,omitempty"`
	// ReplayDeletion will trigger a deletion on the used resource during the deletion of the usage itself, if it was attempted to be deleted at least once.
	// +optional
	ReplayDeletion *bool `json:"replayDeletion,omitempty"`
}

UsageSpec defines the desired state of Usage.

func (*UsageSpec) DeepCopy added in v1.14.0 

func (in *UsageSpec) DeepCopy() *UsageSpec

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

func (*UsageSpec) DeepCopyInto added in v1.14.0 

func (in *UsageSpec) DeepCopyInto(out *UsageSpec)

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

type UsageStatus added in v1.14.0 

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

UsageStatus defines the observed state of Usage.

func (*UsageStatus) DeepCopy added in v1.14.0 

func (in *UsageStatus) DeepCopy() *UsageStatus

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

func (*UsageStatus) DeepCopyInto added in v1.14.0 

func (in *UsageStatus) DeepCopyInto(out *UsageStatus)

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

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.