fnruntime

Documentation

Index

• Constants
• func AddDefaultImagePathPrefix(ctx context.Context, image string) string
• func ContainerRuntimeAvailable(runtime ContainerRuntime) error
• func DeleteResourceIds(input []*yaml.RNode) error
• func MergeWithInput(output, selectedInput, input []*yaml.RNode) []*yaml.RNode
• func NewConfigMap(data map[string]string) (*yaml.RNode, error)
• func NewContainerEnvFromStringSlice(envStr []string) *runtimeutil.ContainerEnv
• func SaveResults(fsys filesys.FileSystem, resultsDir string, fnResults *fnresult.ResultList) (string, error)
• func SelectInput(input []*yaml.RNode, selectors, exclusions []kptfilev1.Selector, ...) ([]*yaml.RNode, error)
• func SetResourceIds(input []*yaml.RNode) error
• type ContainerFn
  • func (f *ContainerFn) Run(reader io.Reader, writer io.Writer) error
• type ContainerFnPermission
• type ContainerImageError
  • func (e *ContainerImageError) Error() string
• type ContainerRuntime
  • func StringToContainerRuntime(v string) (ContainerRuntime, error)
  • func (r ContainerRuntime) GetBin() string
• type ExecError
  • func (fe *ExecError) Error() string
  • func (fe *ExecError) String() string
• type ExecFn
  • func (f *ExecFn) Run(r io.Reader, w io.Writer) error
• type FunctionRunner
  • func NewFunctionRunner(ctx context.Context, fltr *runtimeutil.FunctionFilter, ...) (*FunctionRunner, error)
  • func NewRunner(ctx context.Context, fsys filesys.FileSystem, f *kptfilev1.Function, ...) (*FunctionRunner, error)
  • func (fr *FunctionRunner) Filter(input []*yaml.RNode) (output []*yaml.RNode, err error)
  • func (fr *FunctionRunner) SetFnConfig(conf *yaml.RNode)
• type ImagePullPolicy
• type SelectionContext

Constants

const (
	AlwaysPull       ImagePullPolicy = "Always"
	IfNotPresentPull ImagePullPolicy = "IfNotPresent"
	NeverPull        ImagePullPolicy = "Never"

	ContainerRuntimeEnv = "KPT_FN_RUNTIME"

	Docker ContainerRuntime = "docker"
	Podman ContainerRuntime = "podman"
)

const (
	FnExecErrorTruncateLines = 4
	// FnExecErrorIndentation is the number of spaces at the beginning of each
	// line of function failure messages.
	FnExecErrorIndentation = 2
)

const (
	FuncGenPkgContext = "builtins/gen-pkg-context"
)

const ResourceIDAnnotation = "internal.config.k8s.io/kpt-resource-id"

ResourceIDAnnotation is used to uniquely identify the resource during round trip to and from a function execution. This annotation is meant to be consumed by kpt during round trip and should be deleted after that

Functions

func AddDefaultImagePathPrefix

func AddDefaultImagePathPrefix(ctx context.Context, image string) string

AddDefaultImagePathPrefix converts the function short path to the full image url. If the function is Catalog function, it adds "gcr.io/kpt-fn/".e.g. set-namespace:v0.1 --> gcr.io/kpt-fn/set-namespace:v0.1 If the function is porch function, it queries porch to get the function image by name and namespace. e.g. default:set-namespace:v0.1 --> us-west1-docker.pkg.dev/cpa-kit-dev/packages/set-namespace:v0.1

func ContainerRuntimeAvailable

func ContainerRuntimeAvailable(runtime ContainerRuntime) error

func DeleteResourceIds

func DeleteResourceIds(input []*yaml.RNode) error

DeleteResourceIds removes the kpt-resource-id annotation from all resources

func MergeWithInput

func MergeWithInput(output, selectedInput, input []*yaml.RNode) []*yaml.RNode

MergeWithInput merges the transformed output with input resources input: all input resources, selectedInput: selected input resources output: output resources as the result of function on selectedInput resources for input: A,B,C,D; selectedInput: A,B; output: A,E(A transformed, B Deleted, E Added) the result should be A,C,D,E resources are identified by kpt-resource-id annotation

func NewConfigMap

func NewConfigMap(data map[string]string) (*yaml.RNode, error)

func NewContainerEnvFromStringSlice

func NewContainerEnvFromStringSlice(envStr []string) *runtimeutil.ContainerEnv

NewContainerEnvFromStringSlice returns a new ContainerEnv pointer with parsing input envStr. envStr example: ["foo=bar", "baz"] using this instead of runtimeutil.NewContainerEnvFromStringSlice() to avoid default envs LOG_TO_STDERR

func SaveResults

func SaveResults(fsys filesys.FileSystem, resultsDir string, fnResults *fnresult.ResultList) (string, error)

SaveResults saves results gathered from running the pipeline at specified dir in the input FileSystem.

func SelectInput

func SelectInput(input []*yaml.RNode, selectors, exclusions []kptfilev1.Selector, _ *SelectionContext) ([]*yaml.RNode, error)

SelectInput returns the selected resources based on criteria in selectors

func SetResourceIds

func SetResourceIds(input []*yaml.RNode) error

SetResourceIds adds kpt-resource-id annotation to each input resource

Types

type ContainerFn

type ContainerFn struct {
	Ctx  context.Context
	Path types.UniquePath
	// Image is the container image to run
	Image string
	// ImagePullPolicy controls the image pulling behavior.
	ImagePullPolicy ImagePullPolicy
	// Container function will be killed after this timeour.
	// The default value is 5 minutes.
	Timeout time.Duration
	Perm    ContainerFnPermission
	// UIDGID is the os User ID and Group ID that will be
	// used to run the container in format userId:groupId.
	// If it's empty, "nobody" will be used.
	UIDGID string
	// StorageMounts are the storage or directories to mount
	// into the container
	StorageMounts []runtimeutil.StorageMount
	// Env is a slice of env string that will be exposed to container
	Env []string
	// FnResult is used to store the information about the result from
	// the function.
	FnResult *fnresult.Result
}

ContainerFn implements a KRMFn which run a containerized KRM function

func (*ContainerFn) Run

func (f *ContainerFn) Run(reader io.Reader, writer io.Writer) error

Run runs the container function using docker runtime. It reads the input from the given reader and writes the output to the provided writer.

type ContainerFnPermission

type ContainerFnPermission struct {
	AllowNetwork bool
	AllowMount   bool
}

ContainerFnPermission contains the permission of container function such as network access.

type ContainerImageError

type ContainerImageError struct {
	Image  string
	Output string
}

ContainerImageError is an error type which will be returned when the container run time cannot verify docker image.

func (*ContainerImageError) Error

func (e *ContainerImageError) Error() string

type ContainerRuntime

type ContainerRuntime string

func StringToContainerRuntime

func StringToContainerRuntime(v string) (ContainerRuntime, error)

func (ContainerRuntime) GetBin

func (r ContainerRuntime) GetBin() string

type ExecError

type ExecError struct {
	// OriginalErr is the original error returned from function runtime
	OriginalErr error

	// TruncateOutput indicates should error message be truncated
	TruncateOutput bool

	// Stderr is the content written to function stderr
	Stderr string `yaml:"stderr,omitempty"`

	// ExitCode is the exit code returned from function
	ExitCode int `yaml:"exitCode,omitempty"`
}

ExecError implements an error type that stores information about function failure.

func (*ExecError) Error

func (fe *ExecError) Error() string

func (*ExecError) String

func (fe *ExecError) String() string

String returns string representation of the failure.

type ExecFn

type ExecFn struct {
	// Path is the os specific path to the executable
	// file. It can be relative or absolute.
	Path string
	// Args are the arguments to the executable
	Args []string
	// Container function will be killed after this timeour.
	// The default value is 5 minutes.
	Timeout time.Duration
	// FnResult is used to store the information about the result from
	// the function.
	FnResult *fnresult.Result
}

func (*ExecFn) Run

func (f *ExecFn) Run(r io.Reader, w io.Writer) error

Run runs the executable file which reads the input from r and writes the output to w.

type FunctionRunner

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

FunctionRunner wraps FunctionFilter and implements kio.Filter interface.

func NewFunctionRunner

func NewFunctionRunner(ctx context.Context,
	fltr *runtimeutil.FunctionFilter,
	pkgPath types.UniquePath,
	fnResult *fnresult.Result,
	fnResults *fnresult.ResultList,
	setPkgPathAnnotation bool,
	displayResourceCount bool) (*FunctionRunner, error)

NewFunctionRunner returns a FunctionRunner given a specification of a function and it's config.

func NewRunner

func NewRunner(
	ctx context.Context,
	fsys filesys.FileSystem,
	f *kptfilev1.Function,
	pkgPath types.UniquePath,
	fnResults *fnresult.ResultList,
	imagePullPolicy ImagePullPolicy,
	setPkgPathAnnotation, displayResourceCount bool,
	runtime fn.FunctionRuntime,
) (*FunctionRunner, error)

NewRunner returns a FunctionRunner given a specification of a function and it's config.

func (*FunctionRunner) Filter

func (fr *FunctionRunner) Filter(input []*yaml.RNode) (output []*yaml.RNode, err error)

func (*FunctionRunner) SetFnConfig

func (fr *FunctionRunner) SetFnConfig(conf *yaml.RNode)

SetFnConfig updates the functionConfig for the FunctionRunner instance.

type ImagePullPolicy

type ImagePullPolicy string

type SelectionContext

type SelectionContext struct {
	RootPackagePath types.UniquePath
}