docker

Documentation

Index

• Constants
• type Docker
  • func NewClient(url string, version string) *Docker
  • func (d *Docker) Connect() (err error)
  • func (d *Docker) ContainerCreate(ctx context.Context, config *container.Config, ...) (*container.ContainerCreateCreatedBody, error)
  • func (d *Docker) GetClient() *client.Client
  • func (d *Docker) ImagePull(ctx context.Context, image string) error
  • func (d *Docker) NodeList(ctx context.Context, options types.NodeListOptions) ([]swarm.Node, error)
  • func (d *Docker) StackDeploy(ctx context.Context, stackName string, composeFile []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) (output string, err error)
  • func (d *Docker) TaskList(ctx context.Context, options types.TaskListOptions) ([]swarm.Task, error)

Constants

const (
	//DefaultURL docker default URL
	DefaultURL = "unix:///var/run/docker.sock"
	//DefaultVersion docker default version
	DefaultVersion = "1.27"
)

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) 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) 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) NodeList

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

NodeList list the nodes

func (*Docker) StackDeploy

func (d *Docker) StackDeploy(ctx context.Context, stackName string, composeFile []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) (output string, err error)

StackServices list the services of a stack

func (*Docker) TaskList

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

TaskList list the tasks