docker

Documentation

Index

• Constants
• func BuildContainerConfig(opts *ContainerConfigOpts) (*container.Config, error)
• func BuildHostConfig(opts *ContainerHostConfigOpts) (*container.HostConfig, error)
• func BuildNetworkingConfig(networkName, networkId string) *network.NetworkingConfig
• func BuildVpnHostConfig(opts *ContainerPortConfigOpts) (*container.HostConfig, error)
• func ContainerNetworkMode(idOrName string) string
• func DefaultNetworkMode() string
• type ContainerConfigOpts
• type ContainerCreateOpts
• type ContainerDetails
• type ContainerEnv
• type ContainerExecOpts
• type ContainerHostConfigOpts
• type ContainerInfo
• type ContainerLogsOpts
• type ContainerPort
• type ContainerPortConfigOpts
• type ContainerRestartOpts
• type ContainerVolume
• type DockerClient
  • func NewDockerClient() (*DockerClient, error)
  • func (client *DockerClient) Close() error
  • func (client *DockerClient) ContainerCreate(opts *ContainerCreateOpts) (string, error)
  • func (client *DockerClient) ContainerExec(opts *ContainerExecOpts) error
  • func (client *DockerClient) ContainerInspect(containerId string) (ContainerDetails, error)
  • func (client *DockerClient) ContainerList(namePrefix string, label string) ([]ContainerInfo, error)
  • func (client *DockerClient) ContainerLogs(opts *ContainerLogsOpts) error
  • func (client *DockerClient) ContainerLogsStd(containerId string) error
  • func (client *DockerClient) ContainerLogsTee(containerId string, logFileName string) error
  • func (client *DockerClient) ContainerRemove(containerId string) error
  • func (client *DockerClient) ContainerRestart(opts *ContainerRestartOpts) error
  • func (client *DockerClient) CopyFileToContainer(containerId string, localPath string, containerPath string) error
  • func (client *DockerClient) ImagePull(opts *ImagePullOpts) error
  • func (client *DockerClient) ImageRemoveDangling(opts *ImageRemoveOpts) error
  • func (client *DockerClient) NetworkUpsert(networkName string) (string, error)
• type ImagePullOpts
• type ImageRemoveOpts
• type NetworkInfo

Constants

const (
	ContainerStatusRunning = "running"
)

Functions

func BuildContainerConfig

func BuildContainerConfig(opts *ContainerConfigOpts) (*container.Config, error)

func BuildHostConfig

func BuildHostConfig(opts *ContainerHostConfigOpts) (*container.HostConfig, error)

func BuildNetworkingConfig

func BuildNetworkingConfig(networkName, networkId string) *network.NetworkingConfig

func BuildVpnHostConfig

func BuildVpnHostConfig(opts *ContainerPortConfigOpts) (*container.HostConfig, error)

func ContainerNetworkMode

func ContainerNetworkMode(idOrName string) string

func DefaultNetworkMode

func DefaultNetworkMode() string

Types

type ContainerConfigOpts

type ContainerConfigOpts struct {
	ImageName  string
	Hostname   string
	Env        []ContainerEnv
	Ports      []ContainerPort
	Tty        bool
	Entrypoint []string
	Cmd        []string
	Labels     commonModel.Labels
}

type ContainerCreateOpts

type ContainerCreateOpts struct {
	ContainerName                string
	ContainerConfig              *container.Config
	HostConfig                   *container.HostConfig
	NetworkingConfig             *network.NetworkingConfig
	WaitStatus                   bool
	CaptureInterrupt             bool
	OnContainerInterruptCallback func(containerId string)
	OnContainerCreateCallback    func(containerId string) error
	OnContainerWaitCallback      func(containerId string) error
	OnContainerStatusCallback    func(status string)
	OnContainerStartCallback     func()
}

type ContainerDetails

type ContainerDetails struct {
	Info    ContainerInfo
	Created time.Time
	Labels  map[string]string
	Env     []ContainerEnv
	Ports   []ContainerPort
	Network NetworkInfo
}

type ContainerEnv

type ContainerEnv struct {
	Key   string
	Value string
}

type ContainerExecOpts

type ContainerExecOpts struct {
	ContainerId             string
	Commands                []string
	InStream                io.ReadCloser
	OutStream               io.Writer
	ErrStream               io.Writer
	IsTty                   bool
	OnContainerExecCallback func()
	OnStreamCloseCallback   func()
	OnStreamErrorCallback   func(error)
}

type ContainerHostConfigOpts

type ContainerHostConfigOpts struct {
	NetworkMode string
	PortConfig  *ContainerPortConfigOpts
	Volumes     []ContainerVolume
}

type ContainerInfo

type ContainerInfo struct {
	ContainerId   string
	ContainerName string
	Healthy       bool
}

type ContainerLogsOpts

type ContainerLogsOpts struct {
	ContainerId           string
	OutStream             io.Writer
	ErrStream             io.Writer
	OnStreamCloseCallback func()
	OnStreamErrorCallback func(error)
}

type ContainerPort

type ContainerPort struct {
	Local  string
	Remote string
}

type ContainerPortConfigOpts

type ContainerPortConfigOpts struct {
	Ports              []ContainerPort
	OnPortBindCallback func(port ContainerPort)
}

type ContainerRestartOpts

type ContainerRestartOpts struct {
	ContainerId       string
	OnRestartCallback func(string)
}

type ContainerVolume

type ContainerVolume struct {
	HostDir      string
	ContainerDir string
}

type DockerClient

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

func NewDockerClient

func NewDockerClient() (*DockerClient, error)

func (*DockerClient) Close

func (client *DockerClient) Close() error

func (*DockerClient) ContainerCreate

func (client *DockerClient) ContainerCreate(opts *ContainerCreateOpts) (string, error)

func (*DockerClient) ContainerExec

func (client *DockerClient) ContainerExec(opts *ContainerExecOpts) error

func (*DockerClient) ContainerInspect

func (client *DockerClient) ContainerInspect(containerId string) (ContainerDetails, error)

func (*DockerClient) ContainerList

func (client *DockerClient) ContainerList(namePrefix string, label string) ([]ContainerInfo, error)

func (*DockerClient) ContainerLogs

func (client *DockerClient) ContainerLogs(opts *ContainerLogsOpts) error

func (*DockerClient) ContainerLogsStd

func (client *DockerClient) ContainerLogsStd(containerId string) error

func (*DockerClient) ContainerLogsTee

func (client *DockerClient) ContainerLogsTee(containerId string, logFileName string) error

func (*DockerClient) ContainerRemove

func (client *DockerClient) ContainerRemove(containerId string) error

func (*DockerClient) ContainerRestart

func (client *DockerClient) ContainerRestart(opts *ContainerRestartOpts) error

func (*DockerClient) CopyFileToContainer

func (client *DockerClient) CopyFileToContainer(containerId string, localPath string, containerPath string) error

func (*DockerClient) ImagePull

func (client *DockerClient) ImagePull(opts *ImagePullOpts) error

func (*DockerClient) ImageRemoveDangling

func (client *DockerClient) ImageRemoveDangling(opts *ImageRemoveOpts) error

func (*DockerClient) NetworkUpsert

func (client *DockerClient) NetworkUpsert(networkName string) (string, error)

type ImagePullOpts

type ImagePullOpts struct {
	ImageName           string
	OnImagePullCallback func()
}

type ImageRemoveOpts

type ImageRemoveOpts struct {
	OnImageRemoveCallback      func(imageId string)
	OnImageRemoveErrorCallback func(imageId string, err error)
}

type NetworkInfo

type NetworkInfo struct {
	Id         string
	Name       string
	IpAddress  string
	MacAddress string
}