docker

Documentation

Index

• Constants
• func New(cfg map[string]any) (driver.Driver, error)
• type DockerDriver
  • func (d *DockerDriver) Close() error
  • func (d *DockerDriver) Connect(ctx context.Context, id string) (io.ReadWriteCloser, error)
  • func (d *DockerDriver) Create(ctx context.Context, cfg driver.SandboxConfig) (string, error)
  • func (d *DockerDriver) DriverName() string
  • func (d *DockerDriver) GetFile(ctx context.Context, id, path string) (io.ReadCloser, error)
  • func (d *DockerDriver) Healthy(ctx context.Context) error
  • func (d *DockerDriver) Info(ctx context.Context, id string) (*driver.SandboxInfo, error)
  • func (d *DockerDriver) List(ctx context.Context, states []driver.SandboxState) ([]*driver.SandboxInfo, error)
  • func (d *DockerDriver) ListFiles(ctx context.Context, id, path string) ([]*driver.FileEntry, error)
  • func (d *DockerDriver) PutFile(ctx context.Context, id, path string, content io.Reader) error
  • func (d *DockerDriver) Start(ctx context.Context, id string) error
  • func (d *DockerDriver) Stop(ctx context.Context, id string) error
• type DockerStream
  • func NewDockerStream(resp types.HijackedResponse) *DockerStream
  • func (ds *DockerStream) Close() error
  • func (ds *DockerStream) Read(p []byte) (n int, err error)
  • func (ds *DockerStream) Write(p []byte) (n int, err error)

Constants

const (
	DriverName      = "docker"
	AgentBinaryPath = "/usr/local/bin/boxed-agent"
	ManagedLabel    = "xyz.boxed.managed"
)

Functions

func New

func New(cfg map[string]any) (driver.Driver, error)

New creates a new DockerDriver. cfg["agent_path"] can be used to specify the host path to the boxed-agent binary.

Types

type DockerDriver

type DockerDriver struct {
	// contains filtered or unexported fields
}

DockerDriver implements the driver.Driver interface using the Docker engine.

func (*DockerDriver) Close

func (d *DockerDriver) Close() error

func (*DockerDriver) Connect

func (d *DockerDriver) Connect(ctx context.Context, id string) (io.ReadWriteCloser, error)

func (*DockerDriver) Create

func (d *DockerDriver) Create(ctx context.Context, cfg driver.SandboxConfig) (string, error)

func (*DockerDriver) DriverName

func (d *DockerDriver) DriverName() string

func (*DockerDriver) GetFile

func (d *DockerDriver) GetFile(ctx context.Context, id, path string) (io.ReadCloser, error)

GetFile implements driver.Driver.

func (*DockerDriver) Healthy

func (d *DockerDriver) Healthy(ctx context.Context) error

func (*DockerDriver) Info

func (d *DockerDriver) Info(ctx context.Context, id string) (*driver.SandboxInfo, error)

func (*DockerDriver) List

func (d *DockerDriver) List(ctx context.Context, states []driver.SandboxState) ([]*driver.SandboxInfo, error)

func (*DockerDriver) ListFiles

func (d *DockerDriver) ListFiles(ctx context.Context, id, path string) ([]*driver.FileEntry, error)

ListFiles implements driver.Driver.

func (*DockerDriver) PutFile

func (d *DockerDriver) PutFile(ctx context.Context, id, path string, content io.Reader) error

PutFile implements driver.Driver.

func (*DockerDriver) Start

func (d *DockerDriver) Start(ctx context.Context, id string) error

func (*DockerDriver) Stop

func (d *DockerDriver) Stop(ctx context.Context, id string) error

type DockerStream

type DockerStream struct {
	// contains filtered or unexported fields
}

DockerWrapper handles the multiplexed stream from Docker (StdCopy format)

func NewDockerStream

func NewDockerStream(resp types.HijackedResponse) *DockerStream

func (*DockerStream) Close

func (ds *DockerStream) Close() error

func (*DockerStream) Read

func (ds *DockerStream) Read(p []byte) (n int, err error)

func (*DockerStream) Write

func (ds *DockerStream) Write(p []byte) (n int, err error)