runtime

Documentation

Index

• Constants
• Variables
• func Register(name string, initFn Initializer)
• type ContainerRuntime
• type Initializer
• type RuntimeConfig
• type RuntimeOption
  • func WithConfig(cfg *RuntimeConfig) RuntimeOption
  • func WithKeepMgmtNet() RuntimeOption
  • func WithMgmtNet(mgmt *types.MgmtNet) RuntimeOption

Constants

const (
	DockerRuntime = "docker"
	IgniteRuntime = "ignite"
)

Variables

var ContainerRuntimes = map[string]Initializer{}

Functions

func Register

func Register(name string, initFn Initializer)

Types

type ContainerRuntime

type ContainerRuntime interface {
	// Initializes the Container runtime struct
	Init(...RuntimeOption) error
	// Mgmt return management network configuration of a runtime
	Mgmt() *types.MgmtNet
	// Adds custom configuration items to the container runtime struct
	WithConfig(*RuntimeConfig)
	// Set the network management details (generated by the config.go)
	WithMgmtNet(*types.MgmtNet)
	// Instructs the runtime not to delete the mgmt network on destroy
	WithKeepMgmtNet()
	// 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
	// CreateContainer creates a container, but does not start it
	CreateContainer(context.Context, *types.NodeConfig) (string, error)
	// Start pre-created container by its name. Returns an extra interface that can be used to receive signals
	// about the container life-cycle after it was created, e.g. for post-deploy tasks
	StartContainer(context.Context, string, *types.NodeConfig) (interface{}, error)
	// Stop running container by its name
	StopContainer(context.Context, string) error
	// Pause a container identified by its name
	PauseContainer(context.Context, string) error
	// UnPause / resume a container identified by its name
	UnpauseContainer(context.Context, string) error
	// List all containers matching labels
	ListContainers(context.Context, []*types.GenericFilter) ([]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 stdout/err
	ExecNotWait(context.Context, string, []string) error
	// Delete container by its name
	DeleteContainer(context.Context, string) error
	// Getter for runtime config options
	Config() RuntimeConfig
	GetName() string
}

type Initializer

type Initializer func() ContainerRuntime

type RuntimeConfig

type RuntimeConfig struct {
	Timeout          time.Duration
	GracefulShutdown bool
	Debug            bool
	KeepMgmtNet      bool
}

type RuntimeOption

type RuntimeOption func(ContainerRuntime)

func WithConfig

func WithConfig(cfg *RuntimeConfig) RuntimeOption

func WithKeepMgmtNet

func WithKeepMgmtNet() RuntimeOption

func WithMgmtNet

func WithMgmtNet(mgmt *types.MgmtNet) RuntimeOption