k8s

Documentation

Overview

This package converts the output of the compiler into a K8s resource for propeller to execute.

Index

• Constants
• func BuildFlyteWorkflow(wfClosure *core.CompiledWorkflowClosure, inputs *core.LiteralMap, ...) (*v1alpha1.FlyteWorkflow, error)
• func StripInterfaceTypeMetadata(iface *core.TypedInterface) *core.TypedInterface
• func StripTypeMetadata(t *core.LiteralType) *core.LiteralType
• func WorkflowIDAsString(id *core.Identifier) string
• func WorkflowNameFromID(id string) string
• type WfClosureCrdFields
  • func BuildWfClosureCrdFields(wfClosure *core.CompiledWorkflowClosure) (*WfClosureCrdFields, error)

Constants

const (

	// The FlyteWorkflow domain according to registration ownership
	DomainLabel = "domain"
	// A concatenation of project, domain, workflow name, and a unique ID
	ExecutionIDLabel = "execution-id"
	// The FlyteWorkflow project according to registration ownership
	ProjectLabel = "project"
	// Shard keys are used during FlytePropeller sharding, this value is set to a hash of the FlyteWorkflow ExecutionID.
	// The pseudo-random unique ID component means this value is deterministic for the same ExecutionID, but will vary
	// across executions of the same workflow.
	ShardKeyLabel = "shard-key"
	// The fully qualified FlyteWorkflow name
	WorkflowNameLabel = "workflow-name"
)

Functions

func BuildFlyteWorkflow

func BuildFlyteWorkflow(wfClosure *core.CompiledWorkflowClosure, inputs *core.LiteralMap,
	executionID *core.WorkflowExecutionIdentifier, namespace string) (*v1alpha1.FlyteWorkflow, error)

BuildFlyteWorkflow builds v1alpha1.FlyteWorkflow resource. Returned error, if not nil, is of type errors.CompilerErrors.

func StripInterfaceTypeMetadata

func StripInterfaceTypeMetadata(iface *core.TypedInterface) *core.TypedInterface

func StripTypeMetadata

func StripTypeMetadata(t *core.LiteralType) *core.LiteralType

StripTypeMetadata strips the type metadata from the given type.

func WorkflowIDAsString

func WorkflowIDAsString(id *core.Identifier) string

Note: Update WorkflowNameFromID for any change made to WorkflowIDAsString

func WorkflowNameFromID

func WorkflowNameFromID(id string) string

Types

type WfClosureCrdFields

type WfClosureCrdFields struct {
	*v1alpha1.WorkflowSpec `json:"spec"`
	SubWorkflows           map[v1alpha1.WorkflowID]*v1alpha1.WorkflowSpec `json:"subWorkflows,omitempty"`
	Tasks                  map[v1alpha1.TaskID]*v1alpha1.TaskSpec         `json:"tasks"`
}

func BuildWfClosureCrdFields

func BuildWfClosureCrdFields(wfClosure *core.CompiledWorkflowClosure) (*WfClosureCrdFields, error)