docker

package
v0.0.95 Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Sep 29, 2025 License: MPL-2.0 Imports: 36 Imported by: 0

Documentation

Overview

docker holds useful things for interacting with docker

Index

Constants

This section is empty.

Variables

This section is empty.

Functions

func GetFile added in v0.0.76 

func GetFile(ctx context.Context, cli *Client, cid string, path string) (io.ReadCloser, error)

Types

type Client added in v0.0.32 

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

func New 

func New(opts ...Option) (*Client, error)

func (*Client) Connect added in v0.0.32 

func (d *Client) Connect(ctx context.Context, cid string) (*Response, error)

Connect returns a response for a container that is already running.

func (*Client) CreateNetwork added in v0.0.32 

func (d *Client) CreateNetwork(ctx context.Context, req *NetworkRequest) (*NetworkAttachment, error)

func (*Client) CreateVolume added in v0.0.32 

func (d *Client) CreateVolume(ctx context.Context, req *VolumeRequest) (mount.Mount, error)

func (*Client) IsSSH added in v0.0.95 

func (c *Client) IsSSH() bool

func (*Client) Remove added in v0.0.32 

func (d *Client) Remove(ctx context.Context, resp *Response) error

Remove forcibly removes all the resources associated with the given request.

func (*Client) RemoveNetwork added in v0.0.32 

func (d *Client) RemoveNetwork(ctx context.Context, nw *NetworkAttachment) error

func (*Client) RemoveVolume added in v0.0.32 

func (d *Client) RemoveVolume(ctx context.Context, v mount.Mount) error

func (*Client) Run added in v0.0.41 

func (d *Client) Run(ctx context.Context, req *Request) (string, error)

func (*Client) Start added in v0.0.32 

func (d *Client) Start(ctx context.Context, req *Request) (*Response, error)

Start starts a container with the given request.

type Content 

type Content struct {
	Target string
	Dir    string
	// contains filtered or unexported fields
}

func NewContent 

func NewContent(r io.Reader, target string, size int64) *Content

func NewContentFromFile 

func NewContentFromFile(f *os.File, target string) (*Content, error)

func NewContentFromString 

func NewContentFromString(s string, target string) *Content

func (Content) Read 

func (c Content) Read(p []byte) (n int, err error)

Read implements io.Reader.

type DockerAuthConfig added in v0.0.86 

type DockerAuthConfig struct {
	Username string `json:"username,omitempty"`
	Password string `json:"password,omitempty"`
	Auth     string `json:"auth,omitempty"`
}

type DockerConfig added in v0.0.86 

type DockerConfig struct {
	Auths map[string]DockerAuthConfig `json:"auths,omitempty"`
}

DockerConfig is the structure of the config file used at ~/.docker/config.json.

func (*DockerConfig) Content added in v0.0.86 

func (d *DockerConfig) Content() (*Content, error)

type NetworkAttachment 

type NetworkAttachment struct {
	Name string
	ID   string
}

type NetworkRequest 

type NetworkRequest struct {
	// Name is the name of the network to create. If empty, a random name will be
	// generated.
	Name string
	// IPAM is the IP Address Management configuration for the network. Most of
	// the time this can be left empty and set by the daemon.
	IPAM       *network.IPAM
	Labels     map[string]string
	EnableIPv6 bool
}

type Option 

type Option func(*Client) error

func WithClient 

func WithClient(cli *client.Client) Option

func WithClientOpts 

func WithClientOpts(opts ...client.Opt) Option

type Request 

type Request struct {
	Ref          name.Reference
	Name         string
	Entrypoint   []string
	User         string // uid:gid
	Env          []string
	Cmd          []string
	Labels       map[string]string
	Privileged   bool
	Resources    ResourcesRequest
	Mounts       []mount.Mount
	Networks     []NetworkAttachment
	Timeout      time.Duration
	HealthCheck  *container.HealthConfig
	Contents     []*Content
	PortBindings nat.PortMap
	CgroupnsMode container.CgroupnsMode
	PidMode      string
	ExtraHosts   []string
	AutoRemove   bool
	Logger       io.Writer
	Init         bool
}

type ResourcesRequest 

type ResourcesRequest struct {
	CpuRequest resource.Quantity
	CpuLimit   resource.Quantity

	MemoryRequest resource.Quantity
	MemoryLimit   resource.Quantity
}

type Response 

type Response struct {
	types.ContainerJSON
	ID   string
	Name string
	// contains filtered or unexported fields
}

Response is returned from a Start() request.

func (*Response) GetFile added in v0.0.32 

func (r *Response) GetFile(ctx context.Context, path string) (io.Reader, error)

func (*Response) PortBinding added in v0.0.95 

func (r *Response) PortBinding(port nat.Port) (nat.PortBinding, func(), error)

PortBinding returns the host port binding for a container port. For SSH connections, it creates a tunnel and returns a cleanup function. For local connections, it returns the local port and cleanup is a no-op.

func (*Response) ReadFile added in v0.0.50 

func (r *Response) ReadFile(ctx context.Context, path string) ([]byte, error)

ReadFile is a helper method over GetFile() that returns the raw contents.

func (*Response) Run 

func (r *Response) Run(ctx context.Context, cmd harness.Command) error

type RunError added in v0.0.67 

type RunError struct {
	ExitCode int64
	Message  string
}

func (*RunError) Error added in v0.0.67 

func (e *RunError) Error() string

type VolumeRequest 

type VolumeRequest struct {
	// Name is the name of the volume to create, if empty a random name will be
	// generated by the daemon
	Name   string
	Target string
	Labels map[string]string
}

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.