runtime

Documentation

Overview

Package runtime defines the interface between the GCS and an OCI container runtime.

Index

• type ContainerProcessState
• type ContainerState
• type Runtime
• type StdioOptions
• type StdioPipes

Types

type ContainerProcessState

type ContainerProcessState struct {
	Pid              int
	Command          []string
	CreatedByRuntime bool
	IsZombie         bool
}

ContainerProcessState gives information about a process created by a Runtime.

type ContainerState

type ContainerState struct {
	OCIVersion string
	ID         string
	Pid        int
	BundlePath string
	RootfsPath string
	Status     string
	Created    string
}

ContainerState gives information about a container created by a Runtime.

type Runtime

type Runtime interface {
	CreateContainer(id string, bundlePath string, stdioOptions StdioOptions) (pid int, err error)
	StartContainer(id string) error
	ExecProcess(id string, process oci.Process, stdioOptions StdioOptions) (pid int, err error)
	KillContainer(id string, signal oslayer.Signal) error
	DeleteContainer(id string) error
	DeleteProcess(id string, pid int) error
	PauseContainer(id string) error
	ResumeContainer(id string) error
	GetContainerState(id string) (*ContainerState, error)
	ContainerExists(id string) (bool, error)
	ListContainerStates() ([]ContainerState, error)
	GetRunningContainerProcesses(id string) ([]ContainerProcessState, error)
	GetAllContainerProcesses(id string) ([]ContainerProcessState, error)
	WaitOnProcess(id string, pid int) (oslayer.ProcessExitState, error)
	WaitOnContainer(id string) (oslayer.ProcessExitState, error)

	GetInitPid(id string) (pid int, err error)
	GetStdioPipes(id string, pid int) (*StdioPipes, error)
}

Runtime is the interface defining commands over an OCI container runtime, such as runC.

type StdioOptions

type StdioOptions struct {
	CreateIn  bool
	CreateOut bool
	CreateErr bool
}

StdioOptions specify how the runtime should handle stdio for the process.

type StdioPipes

type StdioPipes struct {
	In  io.WriteCloser
	Out io.ReadCloser
	Err io.ReadCloser
}

StdioPipes contain the interfaces for reading from and writing to a process's stdio.