docker

Documentation

Index

• Constants
• func NewClient() (*ispDockerClient, error)
• type ContainerContext
  • func (ctx *ContainerContext) Close() error
  • func (ctx *ContainerContext) ForceRemoveContainer() error
  • func (ctx *ContainerContext) ForceRemoveImage() error
• type NetworkContext
  • func (ctx *NetworkContext) Close() error
• type Option
  • func PullImage(registryLogin string, registryPassword string) Option
  • func WithEnv(vars map[string]string) Option
  • func WithLogger(logger io.Writer) Option
  • func WithName(containerName string) Option
  • func WithNetwork(ctx *NetworkContext) Option
  • func WithPortBindings(mapping map[string]string) Option

Constants

const (
	DefaultPGImage     = "docker.io/library/postgres:11.1-alpine"
	DefaultRabbitImage = "docker.io/library/rabbitmq:alpine"
)

Functions

func NewClient

func NewClient() (*ispDockerClient, error)

Types

type ContainerContext

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

func (*ContainerContext) Close

func (ctx *ContainerContext) Close() error

force delete container and image

func (*ContainerContext) ForceRemoveContainer

func (ctx *ContainerContext) ForceRemoveContainer() error

func (*ContainerContext) ForceRemoveImage

func (ctx *ContainerContext) ForceRemoveImage() error

type NetworkContext

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

func (*NetworkContext) Close

func (ctx *NetworkContext) Close() error

type Option

type Option func(opts *options)

func PullImage

func PullImage(registryLogin string, registryPassword string) Option

if set image pulls first, registryLogin and registryPassword are optional

func WithEnv

func WithEnv(vars map[string]string) Option

set environments variables

func WithLogger

func WithLogger(logger io.Writer) Option

redirect docker container runtime logs

func WithName

func WithName(containerName string) Option

set container name and hostname in docker network by default

func WithNetwork

func WithNetwork(ctx *NetworkContext) Option

if set, container joins to specified network

func WithPortBindings

func WithPortBindings(mapping map[string]string) Option

bind ports host_machine_port -> container_exposed_port