runtime

Documentation

Index

• Constants
• type ContainerRuntime
  • func NewRuntime(name string, d bool, dur time.Duration, gracefulShutdown bool) ContainerRuntime

Constants

const (
	DockerRuntime     = "docker"
	ContainerdRuntime = "containerd"
)

Types

type ContainerRuntime

type ContainerRuntime interface {
	// Set the network management details (generated by the config.go)
	SetMgmtNet(*types.MgmtNet)
	// Create container (bridge) network
	CreateNet(context.Context) error
	// Delete container (bridge) network
	DeleteNet(context.Context) error
	// Pull container image if not present
	PullImageIfRequired(context.Context, string) error
	// Create container
	CreateContainer(context.Context, *types.Node) error
	// Start pre-created container by its name
	StartContainer(context.Context, string) error
	// Stop running container by its name
	StopContainer(context.Context, string, *time.Duration) error
	// List all containers matching labels
	ListContainers(context.Context, []string) ([]types.GenericContainer, error)
	// Inspect container (extract its PID)
	ContainerInspect(context.Context, string) (*types.GenericContainer, error)
	// Get a netns path using the pid of a container
	GetNSPath(context.Context, string) (string, error)
	// Executes cmd on container identified with id and returns stdout, stderr bytes and an error
	Exec(context.Context, string, []string) ([]byte, []byte, error)
	// ExecNotWait executes cmd on container identified with id but doesn't wait for output nor attaches stodout/err
	ExecNotWait(context.Context, string, []string) error
	// Delete container by its name
	DeleteContainer(context.Context, string) error
}

func NewRuntime

func NewRuntime(name string, d bool, dur time.Duration, gracefulShutdown bool) ContainerRuntime