sandbox

Documentation

Index

• func ParseDNSOptions(servers, searches, options []string, path string) (retErr error)
• func PauseCommand(cfg *libconfig.Config, image *v1.Image) ([]string, error)
• func SetupShm(podSandboxRunDir, mountLabel string, shmSize int64) (shmPath string, _ error)
• type Sandbox
  • func New() Sandbox

Functions

func ParseDNSOptions

func ParseDNSOptions(servers, searches, options []string, path string) (retErr error)

func PauseCommand

func PauseCommand(cfg *libconfig.Config, image *v1.Image) ([]string, error)

PauseCommand returns the pause command for the provided image configuration.

func SetupShm

func SetupShm(podSandboxRunDir, mountLabel string, shmSize int64) (shmPath string, _ error)

SetupShim mounts a path to pod sandbox's shared memory

Types

type Sandbox

type Sandbox interface {
	// SetConfig sets the sandbox configuration and validates it
	SetConfig(*types.PodSandboxConfig) error

	// SetNameAndID sets the sandbox name and ID
	SetNameAndID() error

	// Config returns the sandbox configuration
	Config() *types.PodSandboxConfig

	// ID returns the id of the pod sandbox
	ID() string

	// Name returns the id of the pod sandbox
	Name() string

	// InitInfraContainer initializes the sandbox's infra container
	InitInfraContainer(*libconfig.Config, *storage.ContainerInfo, *idtools.IDMappings) error

	// Spec returns the infra container's generator
	// Must be called after InitInfraContainer
	Spec() *generate.Generator

	// ResolvPath returns the sandbox's resolvPath
	ResolvPath() string
}

Sandbox is the interface for managing pod sandboxes

func New

func New() Sandbox

New creates a new, empty Sandbox instance