v1alpha1

package
v0.0.1 Latest Latest
Warning

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

 Go to latest Published: Feb 16, 2023 License: Apache-2.0 Imports: 7 Imported by: 0

Documentation

Overview

Package v1alpha1 contains API Schema definitions for the delivery v1alpha1 API group +kubebuilder:object:generate=true +groupName=delivery.ocm.software

Index

Constants

View Source 
const (
	// ComponentVersionFetchFailedReason is used when we failed to retrieve a component version.
	ComponentVersionFetchFailedReason = "ComponentVersionFetchFailed"

	// ComponentDescriptorFetchFailedReason is used when we failed to retrieve a component descriptor.
	ComponentDescriptorFetchFailedReason = "ComponentDescriptorFetchFailed"

	// PipelineTemplateFetchFailedReason is used when we failed to retrieve the pipeline template.
	PipelineTemplateFetchFailedReason = "PipelineTemplateFetchFailed"

	// PipelineTemplateExecutionFailedReason is used when we failed to execute the pipeline template.
	PipelineTemplateExecutionFailedReason = "PipelineTemplateExecutionFailed"

	// InvalidPipelineTemplateDataReason is used when we can't unmarshal the template data.
	InvalidPipelineTemplateDataReason = "InvalidPipelineTemplateData"

	// SettingDefaultValuesFailedReason is used when we fail to set default values for Kind data.
	SettingDefaultValuesFailedReason = "SettingDefaultValuesFailed"

	// TemplateStepDependencyErrorReason is used when the template steps ordering if invalid and there is a missing
	// step that another step is depending on.
	TemplateStepDependencyErrorReason = "TemplateStepDependencyError"

	// TemplateDataParseFailedReason is used when we fail to parse template data.
	TemplateDataParseFailedReason = "TemplateDataParseFailed"

	// ImpersonatingClientFetchFailedReason is used when we can't create an impersonation client.
	ImpersonatingClientFetchFailedReason = "ImpersonatingClientFetchFailed"

	// ShouldReconcileCheckFailedReason is used when we couldn't determine if the controller should reconcile.
	ShouldReconcileCheckFailedReason = "ShouldReconcileCheckFailed"

	// PatchFailedReason is used when we couldn't patch an object.
	PatchFailedReason = "PatchFailed"

	// ApplyFailedReason is used when we couldn't apply an object.
	ApplyFailedReason = "ApplyFailed"

	// PruneFailedReason is used when we couldn't prune an object.
	PruneFailedReason = "PruneFailed"

	// AddingItemsToInventoryFailedReason is used when we couldn't add any items to the inventory.
	AddingItemsToInventoryFailedReason = "AddingItemsToInventoryFailed"

	// InventoryDiffFailedReason is used when we couldn't diff the inventory.
	InventoryDiffFailedReason = "InventoryDiffFailed"
)
View Source 
const (
	// UnpackerFinalizer is the finalizer key to set on created objects.
	UnpackerFinalizer = "finalizers.ocm.software"
	DisabledValue     = "disabled"
)

Variables

View Source 
var (
	// GroupVersion is group version used to register these objects
	GroupVersion = schema.GroupVersion{Group: "delivery.ocm.software", Version: "v1alpha1"}

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

Functions

This section is empty.

Types

type ComponentRef 

type ComponentRef struct {
	// +required
	Name string `json:"name"`

	// +optional
	Namespace string `json:"namespace,omitempty"`
}

func (*ComponentRef) DeepCopy 

func (in *ComponentRef) DeepCopy() *ComponentRef

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

func (*ComponentRef) DeepCopyInto 

func (in *ComponentRef) DeepCopyInto(out *ComponentRef)

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

type FieldSelector 

type FieldSelector struct {
	// +required
	Field string `json:"field,omitempty"`

	// +required
	Values []string `json:"values,omitempty"`
}

func (*FieldSelector) DeepCopy 

func (in *FieldSelector) DeepCopy() *FieldSelector

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

func (*FieldSelector) DeepCopyInto 

func (in *FieldSelector) DeepCopyInto(out *FieldSelector)

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

type KubeConfig 

type KubeConfig struct {
	// +required
	SecretRef meta.LocalObjectReference `json:"secretRef,omitempty"`
}

func (*KubeConfig) DeepCopy 

func (in *KubeConfig) DeepCopy() *KubeConfig

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

func (*KubeConfig) DeepCopyInto 

func (in *KubeConfig) DeepCopyInto(out *KubeConfig)

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

type PipelineTemplate 

type PipelineTemplate struct {
	// +required
	Kind string `json:"kind"`

	// +required
	Namespace string `json:"namespace"`

	// +required
	Name string `json:"name"`

	// +optional
	Path string `json:"path,omitempty"`

	// +optional
	Resource ocmcontrollerv1.ResourceRef `json:"resource,omitempty"`
}

func (*PipelineTemplate) DeepCopy 

func (in *PipelineTemplate) DeepCopy() *PipelineTemplate

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

func (*PipelineTemplate) DeepCopyInto 

func (in *PipelineTemplate) DeepCopyInto(out *PipelineTemplate)

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

type ResourceInventory 

type ResourceInventory struct {
	// Entries of Kubernetes resource object references.
	Entries []ResourceRef `json:"entries"`
}

ResourceInventory contains a list of Kubernetes resource object references that have been applied by a Kustomization.

func (*ResourceInventory) DeepCopy 

func (in *ResourceInventory) DeepCopy() *ResourceInventory

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

func (*ResourceInventory) DeepCopyInto 

func (in *ResourceInventory) DeepCopyInto(out *ResourceInventory)

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

type ResourceRef 

type ResourceRef struct {
	// ID is the string representation of the Kubernetes resource object's metadata,
	// in the format '<namespace>_<name>_<group>_<kind>'.
	ID string `json:"id"`

	// Version is the API version of the Kubernetes resource object's kind.
	Version string `json:"v"`
}

ResourceRef contains the information necessary to locate a resource within a cluster.

func (*ResourceRef) DeepCopy 

func (in *ResourceRef) DeepCopy() *ResourceRef

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

func (*ResourceRef) DeepCopyInto 

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 

type ResourceSelector struct {
	// +optional
	SkipRoot bool `json:"skipRoot,omitempty"`

	// +optional
	FollowReferences bool `json:"followReferences,omitempty"`

	// +optional
	MatchSelector []FieldSelector `json:"matchSelector,omitempty"`
}

func (*ResourceSelector) DeepCopy 

func (in *ResourceSelector) DeepCopy() *ResourceSelector

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

func (*ResourceSelector) DeepCopyInto 

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

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

type Unpacker 

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

	Spec   UnpackerSpec   `json:"spec,omitempty"`
	Status UnpackerStatus `json:"status,omitempty"`
}

Unpacker is the Schema for the Unpackers API

func (*Unpacker) DeepCopy 

func (in *Unpacker) DeepCopy() *Unpacker

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

func (*Unpacker) DeepCopyInto 

func (in *Unpacker) DeepCopyInto(out *Unpacker)

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

func (*Unpacker) DeepCopyObject 

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

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

func (*Unpacker) GetConditions 

func (in *Unpacker) GetConditions() []metav1.Condition

GetConditions returns the conditions of the ComponentVersion.

func (Unpacker) GetRequeueAfter 

func (in Unpacker) GetRequeueAfter() time.Duration

GetRequeueAfter returns the duration after which the ComponentVersion must be reconciled again.

func (Unpacker) GetTimeout 

func (in Unpacker) GetTimeout() time.Duration

GetTimeout returns the timeout

func (*Unpacker) SetConditions 

func (in *Unpacker) SetConditions(conditions []metav1.Condition)

SetConditions sets the conditions of the ComponentVersion.

type UnpackerList 

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

UnpackerList contains a list of Unpacker

func (*UnpackerList) DeepCopy 

func (in *UnpackerList) DeepCopy() *UnpackerList

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

func (*UnpackerList) DeepCopyInto 

func (in *UnpackerList) DeepCopyInto(out *UnpackerList)

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

func (*UnpackerList) DeepCopyObject 

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

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

type UnpackerSpec 

type UnpackerSpec struct {
	// Interval is the reconciliation interval, i.e. at what interval shall a reconciliation happen.
	// This is used to requeue objects for reconciliation in case of success as well as already reconciling objects.
	// +required
	Interval metav1.Duration `json:"interval"`

	// ComponentVersionRef references a namespaced object. This object must be of Kind ComponentVersion.
	// +required
	ComponentVersionRef meta.NamespacedObjectReference `json:"componentVersionRef"`

	// ResourceSelector identify the unpacker target resource.
	// +required
	ResourceSelector ResourceSelector `json:"resourceSelector"`

	// +optional
	PipelineTemplateRef PipelineTemplate `json:"pipelineTemplateRef,omitempty"`

	// +optional
	ServiceAccountName string `json:"serviceAccountName,omitempty"`

	// +optional
	KubeConfig *KubeConfig `json:"kubeConfig,omitempty"`

	// Timeout for validation, apply and health checking operations.
	// Defaults to 'Interval' duration.
	// +optional
	Timeout *metav1.Duration `json:"timeout,omitempty"`

	// Prune enables garbage collection.
	// +required
	Prune bool `json:"prune"`

	// Suspend tells the controller to suspend subsequent cue executions,
	// it does not apply to already started executions. Defaults to false.
	// +optional
	Suspend bool `json:"suspend,omitempty"`

	// +required
	Values map[string]map[string]map[string]string `json:"values,omitempty"`
}

UnpackerSpec defines the desired state of Unpacker

func (*UnpackerSpec) DeepCopy 

func (in *UnpackerSpec) DeepCopy() *UnpackerSpec

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

func (*UnpackerSpec) DeepCopyInto 

func (in *UnpackerSpec) DeepCopyInto(out *UnpackerSpec)

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

type UnpackerStatus 

type UnpackerStatus struct {
	// ObservedGeneration is the last reconciled generation.
	// +optional
	ObservedGeneration int64 `json:"observedGeneration,omitempty"`

	// +optional
	// +kubebuilder:printcolumn:name="Ready",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].status",description=""
	// +kubebuilder:printcolumn:name="Status",type="string",JSONPath=".status.conditions[?(@.type==\"Ready\")].message",description=""
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// Inventory contains the list of Kubernetes resource object references that have been successfully applied.
	// +optional
	Inventory *ResourceInventory `json:"inventory,omitempty"`

	LastAttemptedRevision string `json:"lastAttemptedRevision,omitempty"`

	// LastAppliedComponentVersion tracks the last applied component version. If there is a change
	// we fire off a reconcile loop to get that new version.
	// +optional
	LastAppliedComponentVersion string `json:"lastAppliedComponentVersion,omitempty"`

	// LastAppliedPipelineTemplateComponentVersion tracks the last applied component version by the pipeline template.
	// If there is a change we fire off a reconcile loop to get that new version.
	// +optional
	LastAppliedPipelineTemplateComponentVersion string `json:"lastAppliedPipelineTemplateComponentVersion,omitempty"`
}

UnpackerStatus defines the observed state of Unpacker

func (*UnpackerStatus) DeepCopy 

func (in *UnpackerStatus) DeepCopy() *UnpackerStatus

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

func (*UnpackerStatus) DeepCopyInto 

func (in *UnpackerStatus) DeepCopyInto(out *UnpackerStatus)

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.