driver

Documentation

Index

• type Execution
  • func Container(ctx context.Context, opts Options, mlmd *metadata.Client, ...) (execution *Execution, err error)
  • func DAG(ctx context.Context, opts Options, mlmd *metadata.Client) (execution *Execution, err error)
  • func RootDAG(ctx context.Context, opts Options, mlmd *metadata.Client) (execution *Execution, err error)
  • func (e *Execution) WillTrigger() bool
• type Options

Types

type Execution

type Execution struct {
	ID             int64
	ExecutorInput  *pipelinespec.ExecutorInput
	IterationCount *int  // number of iterations, -1 means not an iterator
	Condition      *bool // true -> trigger the task, false -> not trigger the task, nil -> the task is unconditional

	// only specified when this is a Container execution
	Cached       *bool
	PodSpecPatch string
}

func Container

func Container(ctx context.Context, opts Options, mlmd *metadata.Client, cacheClient *cacheutils.Client) (execution *Execution, err error)

func DAG

func DAG(ctx context.Context, opts Options, mlmd *metadata.Client) (execution *Execution, err error)

TODO(Bobgy): merge DAG driver and container driver, because they are very similar.

func RootDAG

func RootDAG(ctx context.Context, opts Options, mlmd *metadata.Client) (execution *Execution, err error)

func (*Execution) WillTrigger

func (e *Execution) WillTrigger() bool

type Options

type Options struct {
	// required, pipeline context name
	PipelineName string
	// required, KFP run ID
	RunID string
	// required, Component spec
	Component *pipelinespec.ComponentSpec
	// optional, iteration index. -1 means not an iteration.
	IterationIndex int

	// optional, required only by root DAG driver
	RuntimeConfig *pipelinespec.PipelineJob_RuntimeConfig
	Namespace     string

	// optional, required by non-root drivers
	Task           *pipelinespec.PipelineTaskSpec
	DAGExecutionID int64

	// optional, required only by container driver
	Container *pipelinespec.PipelineDeploymentConfig_PipelineContainerSpec
}

TODO(capri-xiyue): Move driver to component package Driver options