interfaces

Documentation

Index

• type AbortData
• type Compiler
• type ExecutionData
• type ExecutionParameters
• type ExecutionResponse
• type FlyteWorkflowBuilder
• type TaskResources
• type WorkflowExecutor
• type WorkflowExecutorRegistry

Types

type AbortData

type AbortData struct {
	// Execution namespace.
	Namespace string
	// Execution identifier.
	ExecutionID *core.WorkflowExecutionIdentifier
	// Cluster identifier where the execution was created
	Cluster string
}

AbortData includes all parameters required to abort an execution CRD object.

type Compiler

type Compiler interface {
	CompileTask(task *core.TaskTemplate) (*core.CompiledTask, error)
	GetRequirements(fg *core.WorkflowTemplate, subWfs []*core.WorkflowTemplate) (
		compiler.WorkflowExecutionRequirements, error)
	CompileWorkflow(primaryWf *core.WorkflowTemplate, subworkflows []*core.WorkflowTemplate, tasks []*core.CompiledTask,
		launchPlans []common.InterfaceProvider) (*core.CompiledWorkflowClosure, error)
}

Workflow compiler interface.

type ExecutionData

type ExecutionData struct {
	// Execution namespace.
	Namespace string
	// Execution identifier.
	ExecutionID *core.WorkflowExecutionIdentifier
	// Underlying workflow name for the execution.
	ReferenceWorkflowName string
	// Launch plan name used to trigger the execution.
	ReferenceLaunchPlanName string
	// Compiled workflow closure used to build the flyte workflow
	WorkflowClosure *core.CompiledWorkflowClosure
	// Additional parameters used to build a workflow execution
	ExecutionParameters ExecutionParameters
}

ExecutionData includes all parameters required to create an execution CRD object.

type ExecutionParameters

type ExecutionParameters struct {
	Inputs              *core.LiteralMap
	AcceptedAt          time.Time
	Labels              map[string]string
	Annotations         map[string]string
	TaskPluginOverrides []*admin.PluginOverride
	ExecutionConfig     *admin.WorkflowExecutionConfig
	SecurityContext     *core.SecurityContext
	RecoveryExecution   *core.WorkflowExecutionIdentifier
	TaskResources       *TaskResources
	EventVersion        int
	RoleNameKey         string
	RawOutputDataConfig *admin.RawOutputDataConfig
}

type ExecutionResponse

type ExecutionResponse struct {
	// Cluster identifier where the execution was created
	Cluster string
}

ExecutionResponse is returned when a Flyte workflow execution is successfully created.

type FlyteWorkflowBuilder

type FlyteWorkflowBuilder interface {
	Build(
		wfClosure *core.CompiledWorkflowClosure, inputs *core.LiteralMap, executionID *core.WorkflowExecutionIdentifier,
		namespace string) (*v1alpha1.FlyteWorkflow, error)
}

FlyteWorkflowBuilder produces a v1alpha1.FlyteWorkflow definition from a compiled workflow closure and execution inputs

type TaskResources

type TaskResources struct {
	Defaults runtime.TaskResourceSet
	Limits   runtime.TaskResourceSet
}

type WorkflowExecutor

type WorkflowExecutor interface {
	// ID returns the unique name of this executor implementation.
	ID() string
	// Execute creates a Flyte workflow execution CRD object.
	Execute(ctx context.Context, data ExecutionData) (ExecutionResponse, error)
	// Abort aborts a running Flyte workflow execution CRD object.
	Abort(ctx context.Context, data AbortData) error
}

WorkflowExecutor is a client interface used to create and delete Flyte workflow CRD objects.

type WorkflowExecutorRegistry

type WorkflowExecutorRegistry interface {
	// Register registers a new WorkflowExecutor to handle creating and aborting Flyte workflow executions.
	Register(executor WorkflowExecutor)
	// RegisterDefault registers the default WorkflowExecutor to handle creating and aborting Flyte workflow executions.
	RegisterDefault(executor WorkflowExecutor)
	// GetExecutor resolves the definitive WorkflowExecutor implementation to be used for creating and aborting Flyte workflow executions.
	GetExecutor() WorkflowExecutor
}

WorkflowExecutorRegistry is a singleton provider of a WorkflowExecutor implementation to use for creating and deleting Flyte workflow CRD objects.