v1

Documentation

Overview

Package v1 contains API Schema definitions for the projection v1 API group +kubebuilder:object:generate=true +groupName=projection.be0x74a.io

Index

• Variables
• type DestinationRef
  • func (in *DestinationRef) DeepCopy() *DestinationRef
  • func (in *DestinationRef) DeepCopyInto(out *DestinationRef)
• type Overlay
  • func (in *Overlay) DeepCopy() *Overlay
  • func (in *Overlay) DeepCopyInto(out *Overlay)
• type Projection
  • func (in *Projection) DeepCopy() *Projection
  • func (in *Projection) DeepCopyInto(out *Projection)
  • func (in *Projection) DeepCopyObject() runtime.Object
• type ProjectionList
  • func (in *ProjectionList) DeepCopy() *ProjectionList
  • func (in *ProjectionList) DeepCopyInto(out *ProjectionList)
  • func (in *ProjectionList) DeepCopyObject() runtime.Object
• type ProjectionSpec
  • func (in *ProjectionSpec) DeepCopy() *ProjectionSpec
  • func (in *ProjectionSpec) DeepCopyInto(out *ProjectionSpec)
• type ProjectionStatus
  • func (in *ProjectionStatus) DeepCopy() *ProjectionStatus
  • func (in *ProjectionStatus) DeepCopyInto(out *ProjectionStatus)
• type SourceRef
  • func (in *SourceRef) DeepCopy() *SourceRef
  • func (in *SourceRef) DeepCopyInto(out *SourceRef)

Variables

var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "projection.be0x74a.io", Version: "v1"}

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

	// AddToScheme adds the types in this group-version to the given scheme.
	AddToScheme = SchemeBuilder.AddToScheme
)

Types

type DestinationRef

type DestinationRef struct {
	// Namespace to project into. Defaults to the Projection's own namespace.
	// +optional
	// +kubebuilder:validation:MaxLength=63
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
	Namespace string `json:"namespace,omitempty"`
	// Name in the destination namespace. Defaults to Source.Name.
	// +optional
	// +kubebuilder:validation:MaxLength=63
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
	Name string `json:"name,omitempty"`
}

DestinationRef identifies where the projected object should be written.

func (*DestinationRef) DeepCopy

func (in *DestinationRef) DeepCopy() *DestinationRef

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

func (*DestinationRef) DeepCopyInto

func (in *DestinationRef) DeepCopyInto(out *DestinationRef)

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

type Overlay

type Overlay struct {
	// +optional
	Labels map[string]string `json:"labels,omitempty"`
	// +optional
	Annotations map[string]string `json:"annotations,omitempty"`
}

Overlay is applied on top of the source object's metadata before writing to the destination. Overlay entries win on key conflicts with the source.

func (*Overlay) DeepCopy

func (in *Overlay) DeepCopy() *Overlay

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

func (*Overlay) DeepCopyInto

func (in *Overlay) DeepCopyInto(out *Overlay)

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

type Projection

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

	Spec   ProjectionSpec   `json:"spec,omitempty"`
	Status ProjectionStatus `json:"status,omitempty"`
}

Projection is the Schema for the projections API.

func (*Projection) DeepCopy

func (in *Projection) DeepCopy() *Projection

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

func (*Projection) DeepCopyInto

func (in *Projection) DeepCopyInto(out *Projection)

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

func (*Projection) DeepCopyObject

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

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

type ProjectionList

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

ProjectionList contains a list of Projection.

func (*ProjectionList) DeepCopy

func (in *ProjectionList) DeepCopy() *ProjectionList

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

func (*ProjectionList) DeepCopyInto

func (in *ProjectionList) DeepCopyInto(out *ProjectionList)

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

func (*ProjectionList) DeepCopyObject

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

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

type ProjectionSpec

type ProjectionSpec struct {
	// Source is the object to project from.
	Source SourceRef `json:"source"`
	// Destination controls where the projected object is written.
	// +optional
	Destination DestinationRef `json:"destination,omitempty"`
	// Overlay applies metadata patches on top of the projected object.
	// +optional
	Overlay Overlay `json:"overlay,omitempty"`
}

ProjectionSpec defines the desired state of Projection.

func (*ProjectionSpec) DeepCopy

func (in *ProjectionSpec) DeepCopy() *ProjectionSpec

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

func (*ProjectionSpec) DeepCopyInto

func (in *ProjectionSpec) DeepCopyInto(out *ProjectionSpec)

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

type ProjectionStatus

type ProjectionStatus struct {
	// Conditions reflect the current state of the projection. The controller
	// sets type "Ready" to True once the destination has been written, or
	// False with a reason describing why not.
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`
}

ProjectionStatus defines the observed state of Projection.

func (*ProjectionStatus) DeepCopy

func (in *ProjectionStatus) DeepCopy() *ProjectionStatus

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

func (*ProjectionStatus) DeepCopyInto

func (in *ProjectionStatus) DeepCopyInto(out *ProjectionStatus)

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

type SourceRef

type SourceRef struct {
	// APIVersion of the source object, e.g. "v1" or "apps/v1".
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern=`^([a-z0-9.-]+/)?v[0-9]+((alpha|beta)[0-9]+)?$`
	APIVersion string `json:"apiVersion"`
	// Kind of the source object, e.g. "ConfigMap".
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:Pattern=`^[A-Z][A-Za-z0-9]*$`
	Kind string `json:"kind"`
	// Name of the source object.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
	Name string `json:"name"`
	// Namespace of the source object.
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	// +kubebuilder:validation:Pattern=`^[a-z0-9]([-a-z0-9]*[a-z0-9])?$`
	Namespace string `json:"namespace"`
}

SourceRef identifies the Kubernetes object to project from.

func (*SourceRef) DeepCopy

func (in *SourceRef) DeepCopy() *SourceRef

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

func (*SourceRef) DeepCopyInto

func (in *SourceRef) DeepCopyInto(out *SourceRef)

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