sandbox

Documentation

Overview

Package sandbox implements the runtime provisioner for runtimes in sandboxed processes.

Index

• func New(cfg Config) (host.Provisioner, error)
• type Config
• type HostInitializerParams

Functions

func New

func New(cfg Config) (host.Provisioner, error)

New creates a new runtime provisioner that uses a local process sandbox.

Types

type Config

type Config struct {
	// GetSandboxConfig is a function that generates the sandbox configuration. In case it is not
	// specified a default function is used.
	GetSandboxConfig func(cfg host.Config, socketPath, runtimeDir string) (process.Config, error)

	// HostInfo provides information about the host environment.
	HostInfo *protocol.HostInfo

	// HostInitializer is a function that additionally initializes the runtime host. In case it is
	// not specified a default function is used.
	HostInitializer func(context.Context, *HostInitializerParams) (*host.StartedEvent, error)

	// Logger is an optional logger to use with this provisioner. In case it is not specified a
	// default logger will be created.
	Logger *logging.Logger

	// SandboxBinaryPath is the path to the sandbox support binary.
	SandboxBinaryPath string

	// InsecureNoSandbox disables the sandbox and runs the runtime binary directly.
	InsecureNoSandbox bool
}

Config contains the sandbox provisioner configuration options.

type HostInitializerParams

type HostInitializerParams struct {
	Runtime    host.Runtime
	Version    version.Version
	Process    process.Process
	Connection protocol.Connection

	NotifyUpdateCapabilityTEE <-chan struct{}
}

HostInitializerParams contains parameters for the HostInitializer function.