v1

package
v2.0.7 Latest Latest
Warning

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

Go to latest
Published: Mar 2, 2026 License: Apache-2.0 Imports: 6 Imported by: 0

Documentation

Overview

Package v1 contains API Schema definitions for the flyte.org v1 API group. +kubebuilder:object:generate=true +groupName=flyte.org

Index

Constants

This section is empty.

Variables

View Source
var (
	// GroupVersion is group version used to register these objects.
	GroupVersion = schema.GroupVersion{Group: "flyte.org", 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
)

Functions

This section is empty.

Types

type PhaseTransition added in v2.0.7

type PhaseTransition struct {
	// Phase is the phase that was entered (e.g. "Queued", "Initializing", "Executing", "Succeeded", "Failed").
	Phase string `json:"phase"`

	// OccurredAt is when this phase transition happened.
	OccurredAt metav1.Time `json:"occurredAt"`

	// Message is an optional human-readable message about the transition.
	// +optional
	Message string `json:"message,omitempty"`
}

PhaseTransition records a phase change with its timestamp.

func (*PhaseTransition) DeepCopy added in v2.0.7

func (in *PhaseTransition) DeepCopy() *PhaseTransition

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

func (*PhaseTransition) DeepCopyInto added in v2.0.7

func (in *PhaseTransition) DeepCopyInto(out *PhaseTransition)

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

type TaskAction

type TaskAction struct {
	metav1.TypeMeta `json:",inline"`

	// metadata is a standard object metadata
	// +optional
	metav1.ObjectMeta `json:"metadata,omitempty,omitzero"`

	// spec defines the desired state of TaskAction
	// +required
	Spec TaskActionSpec `json:"spec"`

	// status defines the observed state of TaskAction
	// +optional
	Status TaskActionStatus `json:"status,omitempty,omitzero"`
}

TaskAction is the Schema for the taskactions API

func (*TaskAction) DeepCopy

func (in *TaskAction) DeepCopy() *TaskAction

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

func (*TaskAction) DeepCopyInto

func (in *TaskAction) DeepCopyInto(out *TaskAction)

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

func (*TaskAction) DeepCopyObject

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

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

type TaskActionConditionReason added in v2.0.1

type TaskActionConditionReason string
const (
	// ConditionReasonQueued indicates the TaskAction is queued and waiting for resources
	ConditionReasonQueued TaskActionConditionReason = "Queued"

	// ConditionReasonInitializing indicates the TaskAction is being initialized
	ConditionReasonInitializing TaskActionConditionReason = "Initializing"

	// ConditionReasonExecuting indicates the TaskAction is actively executing
	ConditionReasonExecuting TaskActionConditionReason = "Executing"

	// ConditionReasonCompleted indicates the TaskAction has completed successfully
	ConditionReasonCompleted TaskActionConditionReason = "Completed"

	// ConditionReasonRetryableFailure indicates the TaskAction experienced a retryable failure
	ConditionReasonRetryableFailure TaskActionConditionReason = "RetryableFailure"

	// ConditionReasonPermanentFailure indicates the TaskAction experienced a permanent failure
	ConditionReasonPermanentFailure TaskActionConditionReason = "PermanentFailure"

	// ConditionReasonAborted indicates the TaskAction was aborted
	ConditionReasonAborted TaskActionConditionReason = "Aborted"

	// ConditionReasonPluginNotFound indicates no plugin was found for the task type
	ConditionReasonPluginNotFound TaskActionConditionReason = "PluginNotFound"

	// ConditionReasonInvalidSpec indicates the TaskAction spec is missing required fields
	ConditionReasonInvalidSpec TaskActionConditionReason = "InvalidSpec"
)

Condition reason constants Reasons explain why a condition has a particular status. These are used in the Reason field of conditions to provide detailed sub-state information.

type TaskActionConditionType added in v2.0.1

type TaskActionConditionType string
const (
	// ConditionTypeProgressing indicates whether the TaskAction is actively progressing.
	// This is True when the TaskAction is queued, initializing, or executing.
	// This is False when the TaskAction has completed or failed.
	ConditionTypeProgressing TaskActionConditionType = "Progressing"

	// ConditionTypeSucceeded indicates whether the TaskAction has completed successfully.
	// This is a terminal condition. Once True, the TaskAction will not be reconciled further.
	ConditionTypeSucceeded TaskActionConditionType = "Succeeded"

	// ConditionTypeFailed indicates whether the TaskAction has failed.
	// This is a terminal condition. Once True, the TaskAction will not be reconciled further.
	ConditionTypeFailed TaskActionConditionType = "Failed"
)

Condition type constants Following Kubernetes API conventions: - Condition types describe the current observed state - Use Reason field to track sub-states (like Queued, Initializing, Executing)

type TaskActionList

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

TaskActionList contains a list of TaskAction

func (*TaskActionList) DeepCopy

func (in *TaskActionList) DeepCopy() *TaskActionList

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

func (*TaskActionList) DeepCopyInto

func (in *TaskActionList) DeepCopyInto(out *TaskActionList)

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

func (*TaskActionList) DeepCopyObject

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

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

type TaskActionSpec

type TaskActionSpec struct {
	// RunName is the name of the run this action belongs to
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=30
	RunName string `json:"runName"`

	// Org this action belongs to
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	Org string `json:"org"`

	// Project this action belongs to
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	Project string `json:"project"`

	// Domain this action belongs to
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	Domain string `json:"domain"`

	// ActionName is the unique name of this action within the run
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=30
	ActionName string `json:"actionName"`

	// ParentActionName is the optional name of the parent action
	// +optional
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=30
	ParentActionName *string `json:"parentActionName,omitempty"`

	// InputURI is the path to the input data for this action
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	InputURI string `json:"inputUri"`

	// RunOutputBase is the base path where this action should write its output
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	RunOutputBase string `json:"runOutputBase"`

	// TaskType identifies which plugin handles this task (e.g. "container", "spark", "ray")
	// +kubebuilder:validation:Required
	// +kubebuilder:validation:MinLength=1
	// +kubebuilder:validation:MaxLength=63
	TaskType string `json:"taskType"`

	// ShortName is the human-readable display name for this task
	// +optional
	// +kubebuilder:validation:MaxLength=63
	ShortName string `json:"shortName,omitempty"`

	// TaskTemplate is the proto-serialized core.TaskTemplate stored inline in etcd
	// +kubebuilder:validation:Required
	TaskTemplate []byte `json:"taskTemplate"`
}

TaskActionSpec defines the desired state of TaskAction

func (*TaskActionSpec) DeepCopy

func (in *TaskActionSpec) DeepCopy() *TaskActionSpec

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

func (*TaskActionSpec) DeepCopyInto

func (in *TaskActionSpec) DeepCopyInto(out *TaskActionSpec)

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

func (*TaskActionSpec) GetActionSpec

func (in *TaskActionSpec) GetActionSpec() (*workflow.ActionSpec, error)

func (*TaskActionSpec) SetActionSpec

func (in *TaskActionSpec) SetActionSpec(spec *workflow.ActionSpec) error

type TaskActionStatus

type TaskActionStatus struct {

	// StateJSON is the JSON serialized NodeStatus that was last sent to the State Service
	// +optional
	StateJSON string `json:"stateJson,omitempty"`

	// PluginState is the Gob-encoded plugin state from the last reconciliation round.
	// +optional
	PluginState []byte `json:"pluginState,omitempty"`

	// PluginStateVersion tracks the version of the plugin state schema for compatibility.
	// +optional
	PluginStateVersion uint8 `json:"pluginStateVersion,omitempty"`

	// PluginPhase is a human-readable representation of the plugin's current phase.
	// +optional
	PluginPhase string `json:"pluginPhase,omitempty"`

	// PluginPhaseVersion is the version of the current plugin phase.
	// +optional
	PluginPhaseVersion uint32 `json:"pluginPhaseVersion,omitempty"`

	// conditions represent the current state of the TaskAction resource.
	// Each condition has a unique type and reflects the status of a specific aspect of the resource.
	//
	// Standard condition types include:
	// - "Available": the resource is fully functional
	// - "Progressing": the resource is being created or updated
	// - "Degraded": the resource failed to reach or maintain its desired state
	//
	// The status of each condition is one of True, False, or Unknown.
	// +listType=map
	// +listMapKey=type
	// +optional
	Conditions []metav1.Condition `json:"conditions,omitempty"`

	// PhaseHistory is an append-only log of phase transitions. Unlike conditions
	// (which are updated in-place by type), this preserves the full timeline:
	// Queued → Initializing → Executing → Succeeded/Failed, each with a timestamp.
	// +optional
	PhaseHistory []PhaseTransition `json:"phaseHistory,omitempty"`
}

TaskActionStatus defines the observed state of TaskAction.

func (*TaskActionStatus) DeepCopy

func (in *TaskActionStatus) DeepCopy() *TaskActionStatus

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

func (*TaskActionStatus) DeepCopyInto

func (in *TaskActionStatus) DeepCopyInto(out *TaskActionStatus)

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