runner

Documentation

Overview

Package runner provides a runner for running services.

Index

• type Args
• type Option
  • func WithCgroupPath(path string) Option
  • func WithContainerImage(o string) Option
  • func WithContainerOpts(o ...containerd.NewContainerOpts) Option
  • func WithContainerdAddress(a string) Option
  • func WithCtty(ctty int) Option
  • func WithCustomSeccompProfile(override func(*specs.LinuxSeccomp)) Option
  • func WithDroppedCapabilities(caps map[string]struct{}) Option
  • func WithEnv(o []string) Option
  • func WithGracefulShutdownTimeout(timeout time.Duration) Option
  • func WithLoggingManager(manager runtime.LoggingManager) Option
  • func WithNamespace(o string) Option
  • func WithOCISpecOpts(o ...oci.SpecOpts) Option
  • func WithOOMScoreAdj(score int) Option
  • func WithStderrFile(path string) Option
  • func WithStdin(stdin io.ReadSeeker) Option
  • func WithStdinFile(path string) Option
  • func WithStdoutFile(path string) Option
  • func WithUID(uid uint32) Option
• type Options
  • func DefaultOptions() *Options
• type Runner

Types

type Args

type Args struct {
	ID          string
	ProcessArgs []string
}

Args represents the required options for services.

type Option

type Option func(*Options)

Option is the functional option func.

func WithCgroupPath

func WithCgroupPath(path string) Option

WithCgroupPath sets the cgroup path.

func WithContainerImage

func WithContainerImage(o string) Option

WithContainerImage sets the image ref.

func WithContainerOpts

func WithContainerOpts(o ...containerd.NewContainerOpts) Option

WithContainerOpts sets the containerd container options.

func WithContainerdAddress

func WithContainerdAddress(a string) Option

WithContainerdAddress sets the containerd socket path.

func WithCtty

func WithCtty(ctty int) Option

WithCtty sets the controlling tty.

func WithCustomSeccompProfile

func WithCustomSeccompProfile(override func(*specs.LinuxSeccomp)) Option

WithCustomSeccompProfile sets the function to override seccomp profile.

func WithDroppedCapabilities

func WithDroppedCapabilities(caps map[string]struct{}) Option

WithDroppedCapabilities sets the list of capabilities to drop.

func WithEnv

func WithEnv(o []string) Option

WithEnv sets the environment variables of a service.

func WithGracefulShutdownTimeout

func WithGracefulShutdownTimeout(timeout time.Duration) Option

WithGracefulShutdownTimeout sets the timeout for the task to terminate before sending SIGKILL.

func WithLoggingManager

func WithLoggingManager(manager runtime.LoggingManager) Option

WithLoggingManager sets the LoggingManager option.

func WithNamespace

func WithNamespace(o string) Option

WithNamespace sets the tar file to load.

func WithOCISpecOpts

func WithOCISpecOpts(o ...oci.SpecOpts) Option

WithOCISpecOpts sets the OCI spec options.

func WithOOMScoreAdj

func WithOOMScoreAdj(score int) Option

WithOOMScoreAdj sets the oom_score_adj.

func WithStderrFile

func WithStderrFile(path string) Option

WithStderrFile sets the path to the file to use as stderr.

func WithStdin

func WithStdin(stdin io.ReadSeeker) Option

WithStdin sets the standard input.

func WithStdinFile

func WithStdinFile(path string) Option

WithStdinFile sets the path to the file to use as stdin.

func WithStdoutFile

func WithStdoutFile(path string) Option

WithStdoutFile sets the path to the file to use as stdout.

func WithUID

func WithUID(uid uint32) Option

WithUID sets the user id of the process.

type Options

type Options struct {
	// LoggingManager provides service log handling.
	LoggingManager runtime.LoggingManager
	// Env describes the service's environment variables. Elements should be in
	// the format <key=<value>
	Env []string
	// ContainerdAddress is containerd socket address.
	ContainerdAddress string
	// ContainerOpts describes the container options.
	ContainerOpts []containerd.NewContainerOpts
	// OCISpecOpts describes the OCI spec options.
	OCISpecOpts []oci.SpecOpts
	// ContainerImage is the container's image.
	ContainerImage string
	// Namespace is the containerd namespace.
	Namespace string
	// GracefulShutdownTimeout is the time to wait for process to exit after SIGTERM
	// before sending SIGKILL
	GracefulShutdownTimeout time.Duration
	// Stdin is the process standard input.
	Stdin io.ReadSeeker
	// Specify an oom_score_adj for the process.
	OOMScoreAdj int
	// CgroupPath (optional) sets the cgroup path to use
	CgroupPath string
	// OverrideSeccompProfile default Linux seccomp profile.
	OverrideSeccompProfile func(*specs.LinuxSeccomp)
	// DroppedCapabilities is the list of capabilities to drop.
	DroppedCapabilities []string
	// StdinFile is the path to the file to use as stdin.
	StdinFile string
	// StdoutFile is the path to the file to use as stdout.
	StdoutFile string
	// StderrFile is the path to the file to use as stderr.
	StderrFile string
	// Ctty is the controlling tty.
	Ctty optional.Optional[int]
	// UID is the user id of the process.
	UID uint32
}

Options is the functional options struct.

func DefaultOptions

func DefaultOptions() *Options

DefaultOptions describes the default options to a runner.

type Runner

type Runner interface {
	fmt.Stringer
	Open() error
	Run(events.Recorder) error
	Stop() error
	Close() error
}

Runner describes the requirements for running a process.