runfn

Documentation

Index

• type RunFns
  • func (r RunFns) Execute() error

Types

type RunFns

type RunFns struct {
	Ctx context.Context

	StorageMounts []runtimeutil.StorageMount

	// Path is the path to the directory containing functions
	Path string

	// FnConfigPath specifies a config file which contains the configs used in
	// function input. It can be absolute or relative to kpt working directory.
	// The exact format depends on the OS.
	FnConfigPath string

	// Function is an function to run against the input.
	Function *runtimeutil.FunctionSpec

	// FnConfig is the configurations passed from command line
	FnConfig *yaml.RNode

	// Input can be set to read the Resources from Input rather than from a directory
	Input io.Reader

	// Network enables network access for functions that declare it
	Network bool

	// Output can be set to write the result to Output rather than back to the directory
	Output io.Writer

	// ResultsDir is where to write each functions results
	ResultsDir string

	// AsCurrentUser is a boolean to indicate whether docker container should use
	// the uid and gid that run the command
	AsCurrentUser bool

	// Env contains environment variables that will be exported to container
	Env []string

	// ContinueOnEmptyResult configures what happens when the underlying pipeline
	// returns an empty result.
	// If it is false (default), subsequent functions will be skipped and the
	// result will be returned immediately.
	// If it is true, the empty result will be provided as input to the next
	// function in the list.
	ContinueOnEmptyResult bool

	// IncludeMetaResources indicates will kpt add pkg meta resources such as
	// Kptfile to the input resources to the function.
	IncludeMetaResources bool

	// ExecArgs are the arguments for exec commands
	ExecArgs []string

	// OriginalExec is the original exec commands
	OriginalExec string

	ImagePullPolicy fnruntime.ImagePullPolicy

	Selector kptfile.Selector
	// contains filtered or unexported fields
}

RunFns runs the set of configuration functions in a local directory against the Resources in that directory

func (RunFns) Execute

func (r RunFns) Execute() error

Execute runs the command