driver

Documentation

Overview

Copyright 2021-2023 The Kubeflow Authors

Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at

https://www.apache.org/licenses/LICENSE-2.0

Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

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

	// optional, allows to specify kubernetes-specific executor config
	KubernetesExecutorConfig *kubernetesplatform.KubernetesExecutorConfig
}

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