containers

Documentation

Overview

Package containers is a wrapper around official Docker API.

Index

• Constants
• type Client
  • func New(timeout time.Duration) (*Client, error)
  • func (c Client) Close() error
  • func (c Client) ContainerStatus(ctx context.Context, containerID string) (status string, err error)
  • func (c Client) GetRawClient() *client.Client
  • func (c Client) KillContainer(ctx context.Context, containerID string) (status string, err error)
  • func (c Client) ListContainers(ctx context.Context) (conts []types.Container, err error)
  • func (c Client) PrepareMockContainer(ctx context.Context) (id string, err error)
  • func (c Client) RemoveMockContainer(ctx context.Context, containerID string) (err error)
  • func (c Client) StartContainer(ctx context.Context, containerID string) (status string, err error)
  • func (c Client) StopContainer(ctx context.Context, containerID string) (status string, err error)
• type Opts

Constants

const (
	UNKNOWN = iota
	START   = iota
	STOP    = iota
	KILL    = iota
)

Constatns used inside the DockerCtlMessage struct

const (
	DefaultTimeout = 45 * time.Second
)

Default values for Docker host endpoint

Types

type Client

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

Client structure contains all info about client

func New

func New(timeout time.Duration) (*Client, error)

New creates new client instance according to endpoint url from ENV with default hostconfig

func (Client) Close

func (c Client) Close() error

func (Client) ContainerStatus

func (c Client) ContainerStatus(ctx context.Context, containerID string) (status string, err error)

ContainerStatus gets information about container's status, Can be one of "created", "running", "paused", "restarting", "removing", "exited", or "dead"

func (Client) GetRawClient

func (c Client) GetRawClient() *client.Client

func (Client) KillContainer

func (c Client) KillContainer(ctx context.Context, containerID string) (status string, err error)

KillContainer kills container specified by the containerID string

func (Client) ListContainers

func (c Client) ListContainers(ctx context.Context) (conts []types.Container, err error)

ListContainers lists all containers running and stopped on the machine

func (Client) PrepareMockContainer

func (c Client) PrepareMockContainer(ctx context.Context) (id string, err error)

func (Client) RemoveMockContainer

func (c Client) RemoveMockContainer(ctx context.Context, containerID string) (err error)

func (Client) StartContainer

func (c Client) StartContainer(ctx context.Context, containerID string) (status string, err error)

StartContainer starts container specified by the containerID string

func (Client) StopContainer

func (c Client) StopContainer(ctx context.Context, containerID string) (status string, err error)

StopContainer stops container specified by the containerID string

type Opts

type Opts struct {
	ContainerID string
}