fnruntime

type ContainerFn struct {
	Ctx context.Context

	// Image is the container image to run
	Image string
	// ImagePullPolicy controls the image pulling behavior.
	ImagePullPolicy fnlib.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 *fnresultv1alpha1.Result
}

type ContainerFnPermission struct {
	AllowNetwork bool
	AllowMount   bool
}

type ContainerImageError struct {
	Image  string
	Output string
}

type ContainerRuntime string

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"`
}

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

	Env map[string]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 *fnresultv1alpha1.Result
}

type FunctionKind string

type FunctionRunner interface {
	FnRun(ctx context.Context, reader io.Reader, writer io.Writer) error
	SvcRun(ctx context.Context) error
}

type ImageResolveFunc func(ctx context.Context, image string) (string, error)

type Runner interface {
	Run(ctx context.Context, rCtx *fn.ResourceContext) (*fn.ResourceContext, error)
}

type RunnerOptions struct {
	Kind FunctionKind

	// only used for kind =service, exposes the port used by the service in the container
	ServicePort int

	// ImagePullPolicy controls the image pulling behavior before running the container.
	ImagePullPolicy fnlib.ImagePullPolicy

	// allowExec determines if function binary executable are allowed
	// to be run during execution. Running function binaries is a
	// privileged operation, so explicit permission is required.
	AllowExec bool

	// allowWasm determines if function wasm are allowed to be run during
	// execution. Running wasm function is an alpha feature, so it needs to be
	// enabled explicitly.
	AllowWasm bool

	// ResolveToImage will resolve a partial image to a fully-qualified one
	ResolveToImage ImageResolveFunc
}