docker

Documentation

Index

• Constants
• type Docker
  • func NewClient(url string, version string) *Docker
  • func (d *Docker) ComposeIsAuthorized(compose *types2.Config) bool
  • func (d *Docker) ComposeParse(ctx context.Context, composeFile []byte) (*types2.Config, error)
  • func (d *Docker) Connect() (err error)
  • func (d *Docker) ContainerCreate(ctx context.Context, config *container.Config, ...) (*container.ContainerCreateCreatedBody, error)
  • func (d *Docker) ExpectedNumberOfTasks(ctx context.Context, serviceID string) (int, error)
  • func (d *Docker) GetClient() *client.Client
  • func (d *Docker) ImagePull(ctx context.Context, image string) error
  • func (d *Docker) NodeInspect(ctx context.Context, nodeID string) (swarm.Node, error)
  • func (d *Docker) NodeList(ctx context.Context, options types.NodeListOptions) ([]swarm.Node, error)
  • func (d *Docker) ServiceInspect(ctx context.Context, service string) (swarm.Service, error)
  • func (d *Docker) ServiceScale(ctx context.Context, service string, scale uint64) error
  • func (d *Docker) ServiceStatus(ctx context.Context, service string) (*ServiceStatus, error)
  • func (d *Docker) ServicesList(ctx context.Context, options types.ServiceListOptions) ([]swarm.Service, error)
  • func (d *Docker) StackDeploy(ctx context.Context, stackName string, composeFile []byte, configFile []byte) (output string, err error)
  • func (d *Docker) StackList(ctx context.Context) (output string, err error)
  • func (d *Docker) StackRemove(ctx context.Context, stackName string) (output string, err error)
  • func (d *Docker) StackServices(ctx context.Context, stackName string, quietOption bool) (output string, err error)
  • func (d *Docker) StackStatus(ctx context.Context, stackName string) (*StackStatus, error)
  • func (d *Docker) TaskList(ctx context.Context, options types.TaskListOptions) ([]swarm.Task, error)
• type ServiceStatus
• type StackStatus

Constants

const (
	DefaultURL          = "unix:///var/run/docker.sock"
	DefaultVersion      = "1.27"
	StateStarting       = "STARTING"
	StateRunning        = "RUNNING"
	StateError          = "ERROR"
	StateNoMatchingNode = "NO MATCHING NODE"
)

Docker constants

Types

type Docker

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

Docker wrapper

func NewClient

func NewClient(url string, version string) *Docker

NewClient instantiates a new Docker wrapper

func (*Docker) ComposeIsAuthorized

func (d *Docker) ComposeIsAuthorized(compose *types2.Config) bool

ComposeIsAuthorized checks if the given compose file is authorized

func (*Docker) ComposeParse

func (d *Docker) ComposeParse(ctx context.Context, composeFile []byte) (*types2.Config, error)

ComposeParse parses a compose file

func (*Docker) Connect

func (d *Docker) Connect() (err error)

Connect to the docker API

func (*Docker) ContainerCreate

func (d *Docker) ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, name string) (*container.ContainerCreateCreatedBody, error)

ContainerCreate creates a container and pulls the image if needed

func (*Docker) ExpectedNumberOfTasks

func (d *Docker) ExpectedNumberOfTasks(ctx context.Context, serviceID string) (int, error)

ExpectedNumberOfTasks returns expected number of tasks of a service

func (*Docker) GetClient

func (d *Docker) GetClient() *client.Client

GetClient returns the native docker client

func (*Docker) ImagePull

func (d *Docker) ImagePull(ctx context.Context, image string) error

ImagePull pulls a docker image

func (*Docker) NodeInspect

func (d *Docker) NodeInspect(ctx context.Context, nodeID string) (swarm.Node, error)

NodeInspect inspects a node

func (*Docker) NodeList

func (d *Docker) NodeList(ctx context.Context, options types.NodeListOptions) ([]swarm.Node, error)

NodeList list the nodes

func (*Docker) ServiceInspect

func (d *Docker) ServiceInspect(ctx context.Context, service string) (swarm.Service, error)

ServiceInspect inspects a service

func (*Docker) ServiceScale

func (d *Docker) ServiceScale(ctx context.Context, service string, scale uint64) error

ServiceScale scales a service

func (*Docker) ServiceStatus

func (d *Docker) ServiceStatus(ctx context.Context, service string) (*ServiceStatus, error)

ServiceStatus returns service status

func (*Docker) ServicesList

func (d *Docker) ServicesList(ctx context.Context, options types.ServiceListOptions) ([]swarm.Service, error)

ServiceList list the services

func (*Docker) StackDeploy

func (d *Docker) StackDeploy(ctx context.Context, stackName string, composeFile []byte, configFile []byte) (output string, err error)

StackDeploy deploy a stack

func (*Docker) StackList

func (d *Docker) StackList(ctx context.Context) (output string, err error)

StackList list the stacks

func (*Docker) StackRemove

func (d *Docker) StackRemove(ctx context.Context, stackName string) (output string, err error)

StackRemove remove a stack

func (*Docker) StackServices

func (d *Docker) StackServices(ctx context.Context, stackName string, quietOption bool) (output string, err error)

StackServices list the services of a stack

func (*Docker) StackStatus

func (d *Docker) StackStatus(ctx context.Context, stackName string) (*StackStatus, error)

StackStatus returns stack status

func (*Docker) TaskList

func (d *Docker) TaskList(ctx context.Context, options types.TaskListOptions) ([]swarm.Task, error)

TaskList list the tasks

type ServiceStatus

type ServiceStatus struct {
	RunningTasks int32
	FailedTasks  int32
	TotalTasks   int32
	Status       string
}

type StackStatus

type StackStatus struct {
	RunningServices int32
	FailedServices  int32
	TotalServices   int32
	Status          string
}