component

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

http://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

• Constants
• func CopyThisBinary(destination string) (err error)
• type ImportLauncher
  • func NewImporterLauncher(ctx context.Context, componentSpecJSON, importerSpecJSON, taskSpecJSON string, ...) (l *ImportLauncher, err error)
  • func (l *ImportLauncher) Execute(ctx context.Context) (err error)
  • func (l *ImportLauncher) ImportSpecToMLMDArtifact(ctx context.Context) (artifact *pb.Artifact, err error)
• type ImporterLauncherOptions
• type LauncherV2
  • func NewLauncherV2(ctx context.Context, executionID int64, ...) (l *LauncherV2, err error)
  • func (l *LauncherV2) Execute(ctx context.Context) (err error)
  • func (l *LauncherV2) Info() string
• type LauncherV2Options

Constants

const (
	VolumePathKFPLauncher = "/kfp-launcher"
	KFPLauncherPath       = VolumePathKFPLauncher + "/launch"

	// Env var names
	EnvPodName = "KFP_POD_NAME"
	EnvPodUID  = "KFP_POD_UID"

	// Env vars in metadata-grpc-configmap
	EnvMetadataHost = "METADATA_GRPC_SERVICE_HOST"
	EnvMetadataPort = "METADATA_GRPC_SERVICE_PORT"
)

const OutputMetadataFilepath = "/tmp/kfp_outputs/output_metadata.json"

Functions

func CopyThisBinary

func CopyThisBinary(destination string) (err error)

CopyThisBinary copies the running binary into destination path.

Types

type ImportLauncher

type ImportLauncher struct {
	// contains filtered or unexported fields
}

func NewImporterLauncher

func NewImporterLauncher(ctx context.Context, componentSpecJSON, importerSpecJSON, taskSpecJSON string, launcherV2Opts *LauncherV2Options, importerLauncherOpts *ImporterLauncherOptions) (l *ImportLauncher, err error)

func (*ImportLauncher) Execute

func (l *ImportLauncher) Execute(ctx context.Context) (err error)

func (*ImportLauncher) ImportSpecToMLMDArtifact

func (l *ImportLauncher) ImportSpecToMLMDArtifact(ctx context.Context) (artifact *pb.Artifact, err error)

type ImporterLauncherOptions

type ImporterLauncherOptions struct {
	// required, pipeline context name
	PipelineName string
	// required, KFP run ID
	RunID string
	// required, parent DAG execution ID
	ParentDagID int64
}

type LauncherV2

type LauncherV2 struct {
	// contains filtered or unexported fields
}

func NewLauncherV2

func NewLauncherV2(ctx context.Context, executionID int64, executorInputJSON, componentSpecJSON string, cmdArgs []string, opts *LauncherV2Options) (l *LauncherV2, err error)

func (*LauncherV2) Execute

func (l *LauncherV2) Execute(ctx context.Context) (err error)

func (*LauncherV2) Info

func (l *LauncherV2) Info() string

type LauncherV2Options

type LauncherV2Options struct {
	Namespace,
	PodName,
	PodUID,
	MLMDServerAddress,
	MLMDServerPort,
	PipelineName,
	RunID string
}