runner

Documentation

Index

• type Args
• type Option
  • func WithContainerImage(o string) Option
  • func WithContainerOpts(o ...containerd.NewContainerOpts) Option
  • func WithContainerdAddress(a string) Option
  • func WithEnv(o []string) Option
  • func WithGracefulShutdownTimeout(timeout time.Duration) Option
  • func WithLogPath(path string) Option
  • func WithNamespace(o string) Option
  • func WithOCISpecOpts(o ...oci.SpecOpts) 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 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 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 WithLogPath

func WithLogPath(path string) Option

WithLogPath sets the log path root

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.

type Options

type Options struct {
	// 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
	// LogPath is the root path to store logs
	LogPath string
	// GracefulShutdownTimeout is the time to wait for process to exit after SIGTERM
	// before sending SIGKILL
	GracefulShutdownTimeout time.Duration
}

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(ctx context.Context) error
	Run(events.Recorder) error
	Stop() error
	Close() error
}

Runner describes the requirements for running a process.