runtime

package

Go to main page

Versions in this module

v0

v0.11.0

Nov 20, 2025

v0.10.1

Nov 20, 2025

Changes in this version

type Client

+ func (c *Client) ListVolumes() ([]string, error)

type ContainerRuntime

+ ListVolumes func() ([]string, error)

type Server

+ func (s *Server) ListVolumes(_ context.Context, _ *empty.Empty) (*api.ListVolumesResponse, error)

v0.10.0

May 9, 2025

Changes in this version

+ var ErrDeviceFormat = errors.New("invalid device format")

+ var ErrEnvironmentFormat = errors.New("invalid environment format")

+ var ErrPortFormat = errors.New("invalid publish format")

+ var ErrVolumeFormat = errors.New("invalid volume format")

+ type BindMount struct

+ ContainerPath string

+ HostPath string

+ Readonly bool

+ func BindMountFromProto(m *api.BindMount) BindMount

+ func (BindMount) Type() MountType

+ func (m BindMount) ToProto() *api.Mount

+ type CapabilityConfig []string

+ func MergeCapabilityConfig(first, second CapabilityConfig) CapabilityConfig

+ type Client struct

+ func (c *Client) Cleanup()

+ func (c *Client) CreateContainer(config ContainerConfig) (string, error)

+ func (c *Client) CreateVolume(name string) error

+ func (c *Client) DeleteContainer(id string) error

+ func (c *Client) DeleteVolume(name string) error

+ func (c *Client) Init() (plugin.Config, error)

+ func (c *Client) KillContainer(id string, signal os.Signal) error

+ func (c *Client) Metadata() plugin.Metadata

+ func (c *Client) ResizeContainer(id string, height, width uint32) error

+ func (c *Client) ResolveImage(spec string) (string, error)

+ func (c *Client) StartContainer(id string) error

+ func (c *Client) StreamContainer(id string, stream *plugin.StreamConfig) (*Result, error)

+ func (c *Client) Type() plugin.Type

+ func (c *Client) WriteFile(containerID, path string, contents []byte) error

+ type Command []string

+ type ContainerConfig struct

+ Capabilities CapabilityConfig

+ Environment EnvironmentConfig

+ Image string

+ Mounts MountConfig

+ Name string

+ Ports PortConfig

+ Process Process

+ Terminal TerminalConfig

+ func ContainerConfigFromProto(c *api.ContainerConfig) ContainerConfig

+ func EmptyContainerConfig() ContainerConfig

+ func MergeContainerConfig(first, second ContainerConfig) ContainerConfig

+ func (c ContainerConfig) ToProto() *api.ContainerConfig

+ type DeviceMount struct

+ CGroupRule string

+ ContainerPath string

+ HostPath string

+ Permissions string

+ func DeviceMountFromProto(m *api.DeviceMount) DeviceMount

+ func (DeviceMount) Type() MountType

+ func (m DeviceMount) ToProto() *api.Mount

+ type Entrypoint []string

+ type EnvironmentConfig []EnvironmentVariable

+ func EnvironmentConfigFromProto(e []*api.EnvironmentVariable) EnvironmentConfig

+ func MergeEnvironmentConfig(first, second EnvironmentConfig) EnvironmentConfig

+ func (e EnvironmentConfig) ToProto() []*api.EnvironmentVariable

+ type EnvironmentVariable struct

+ Key string

+ Value string

+ func EnvironmentVariableFromProto(e *api.EnvironmentVariable) EnvironmentVariable

+ func EnvironmentVariableFromSpec(spec string) (EnvironmentVariable, error)

+ func (e EnvironmentVariable) String() string

+ func (e EnvironmentVariable) ToProto() *api.EnvironmentVariable

+ type ImageMount struct

+ ContainerPath string

+ Image string

+ Readonly bool

+ Subpath string

+ func ImageMountFromProto(m *api.ImageMount) ImageMount

+ func (ImageMount) Type() MountType

+ func (m ImageMount) ToProto() *api.Mount

+ type Mount interface

+ ToProto func() *api.Mount

+ Type func() MountType

+ func BindMountFromSpec(spec string) (Mount, error)

+ func DeviceMountFromSpec(spec string) (Mount, error)

+ func MountFromProto(m *api.Mount) Mount

+ type MountConfig []Mount

+ func MergeMountConfig(first, second MountConfig) MountConfig

+ func MountConfigFromProto(m []*api.Mount) MountConfig

+ func (m MountConfig) ToProto() []*api.Mount

+ type MountType string

+ const TypeBind

+ const TypeDevice

+ const TypeImage

+ const TypeTmpfs

+ const TypeVolume

+ type PortBinding struct

+ ContainerPort string

+ HostIP string

+ HostPort string

+ Protocol string

+ func PortBindingFromProto(p *api.PortBinding) PortBinding

+ func PortBindingFromSpec(spec string) (PortBinding, error)

+ func (p PortBinding) ToProto() *api.PortBinding

+ type PortConfig []PortBinding

+ func MergePortConfig(first, second PortConfig) PortConfig

+ func PortConfigFromProto(p []*api.PortBinding) PortConfig

+ func (p PortConfig) ToProto() []*api.PortBinding

+ type Process struct

+ Command Command

+ Entrypoint Entrypoint

+ User string

+ WorkingDir string

+ func MergeProcess(first, second Process) Process

+ func ProcessFromProto(p *api.Process) Process

+ func (p Process) ToProto() *api.Process

+ type Server struct

+ func (s *Server) CreateContainer(_ context.Context, config *api.CreateContainerRequest) (*api.CreateContainerResponse, error)

+ func (s *Server) CreateVolume(_ context.Context, request *api.CreateVolumeRequest) (*empty.Empty, error)

+ func (s *Server) DeleteContainer(_ context.Context, request *api.DeleteContainerRequest) (*empty.Empty, error)

+ func (s *Server) DeleteVolume(_ context.Context, request *api.DeleteVolumeRequest) (*empty.Empty, error)

+ func (s *Server) GetImage(_ context.Context, request *api.GetImageRequest) (*api.GetImageResponse, error)

+ func (s *Server) GetPluginMetadata(_ context.Context, _ *empty.Empty) (*pluginapi.PluginMetadata, error)

+ func (s *Server) InitPlugin(_ context.Context, _ *empty.Empty) (*pluginapi.InitPluginResponse, error)

+ func (s *Server) KillContainer(_ context.Context, request *api.KillContainerRequest) (*empty.Empty, error)

+ func (s *Server) ResetPlugin(_ context.Context, _ *empty.Empty) (*empty.Empty, error)

+ func (s *Server) ResizeContainer(_ context.Context, request *api.ResizeContainerRequest) (*empty.Empty, error)

+ func (s *Server) StartContainer(_ context.Context, request *api.StartContainerRequest) (*empty.Empty, error)

+ func (s *Server) StreamContainer(_ context.Context, request *api.StreamContainerRequest) (*api.StreamContainerResponse, error)

+ func (s *Server) StreamInput(srv api.Plugin_StreamInputServer) error

+ func (s *Server) StreamOutput(request *pluginapi.StreamOutputRequest, srv api.Plugin_StreamOutputServer) error

+ func (s *Server) WriteFile(_ context.Context, request *api.WriteFileRequest) (*empty.Empty, error)

+ type TerminalConfig struct

+ ConsoleHeight int

+ ConsoleWidth int

+ StdIO bool

+ TTY bool

+ func MergeTerminalConfig(first, second TerminalConfig) TerminalConfig

+ func TerminalConfigFromProto(t *api.TerminalConfig) TerminalConfig

+ func (t TerminalConfig) ToProto() *api.TerminalConfig

+ type TmpfsMount struct

+ ContainerPath string

+ Mode os.FileMode

+ Size int

+ func TmpfsMountFromProto(m *api.TmpfsMount) TmpfsMount

+ func (TmpfsMount) Type() MountType

+ func (m TmpfsMount) ToProto() *api.Mount

+ type VolumeMount struct

+ ContainerPath string

+ Readonly bool

+ Subpath string

+ VolumeName string

+ func VolumeMountFromProto(m *api.VolumeMount) VolumeMount

+ func (VolumeMount) Type() MountType

+ func (m VolumeMount) ToProto() *api.Mount

v0.9.0

Jan 9, 2025

Changes in this version

type ContainerRuntime

+ CreateVolume func(name string) error

+ DeleteVolume func(name string) error

+ WriteFile func(name, path string, contents []byte) error

v0.8.1

Sep 19, 2024

v0.8.0

Mar 21, 2023

v0.7.4

Oct 6, 2022

v0.7.3

Sep 25, 2022

v0.7.2

Sep 21, 2022

Changes in this version

+ var ErrUnexpectedMapType = errors.New("unexpected map type for stdio streaming server")

v0.7.1

Aug 30, 2022

v0.7.0

Jul 22, 2022

v0.6.0

Jun 21, 2022

Changes in this version

+ const Type

+ func NewGRPCServer(impl ContainerRuntime) api.RuntimePluginServer

+ type ContainerRuntime interface

+ CreateContainer func(*api.Backdrop, bool, bool) (string, error)

+ DeleteContainer func(string) error

+ KillContainer func(string, os.Signal) error

+ ResizeContainer func(string, uint32, uint32) error

+ ResolveImage func(string) (string, error)

+ StartContainer func(string) error

+ StreamContainer func(string, *dodo.StreamConfig) (*Result, error)

+ func GetByName(m plugin.Manager, name string) (ContainerRuntime, error)

+ func NewGRPCClient(c api.RuntimePluginClient) ContainerRuntime

+ type Result struct

+ ExitCode int

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL