Documentation ¶
Index ¶
- func ReadLinesAsBytes(reader io.Reader) <-chan []byte
- func SetLogger(newLogger *zap.Logger)
- type Container
- type ContainerError
- type DockerController
- func (controller *DockerController) CleanupNetworks(ctx context.Context) error
- func (controller *DockerController) EnsureImage(ctx context.Context, image string) error
- func (controller *DockerController) EnsureNetwork(ctx context.Context, name string) error
- func (controller DockerController) GetContainerHostPath(ctx context.Context, name string, path string) (string, error)
- func (controller *DockerController) Remove(ctx context.Context, c Container) error
- func (controller *DockerController) Shutdown(ctx context.Context, c Container) error
- func (controller *DockerController) ShutdownAll(ctx context.Context) error
- func (controller *DockerController) Start(ctx context.Context, c *Container, ready string) (chan bool, error)
- func (controller *DockerController) WaitForShutdown(ctx context.Context, c Container, timeout time.Duration) error
- type DockerError
- type EnsureImageProgress
- type EnsureImageProgressDetail
- type NetworkError
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
func ReadLinesAsBytes ¶ added in v1.2.1
Types ¶
type Container ¶
type Container struct { Name string Image string ID string Mounts []mount.Mount Ports map[int]int Command []string Environment []string Network []string }
Container represents a simplified interface for starting a Docker container
func (Container) PortBindings ¶
PortBindings Helper method to return the structs required to start a Docker container, or any error
type ContainerError ¶
type ContainerError struct {
// contains filtered or unexported fields
}
func (ContainerError) Error ¶
func (e ContainerError) Error() string
type DockerController ¶
type DockerController struct {
// contains filtered or unexported fields
}
DockerController is a concrete type that can be used to control Docker containers using its SDK.
func NewDockerController ¶
func NewDockerController() (*DockerController, error)
NewDockerController is a helper method to create a new instance of a DockerController.
func (*DockerController) CleanupNetworks ¶ added in v1.0.0
func (controller *DockerController) CleanupNetworks(ctx context.Context) error
func (*DockerController) EnsureImage ¶ added in v0.9.1
func (controller *DockerController) EnsureImage(ctx context.Context, image string) error
EnsureImage is a helper method to pull the specified image to the local machine running Docker.
func (*DockerController) EnsureNetwork ¶ added in v1.0.0
func (controller *DockerController) EnsureNetwork(ctx context.Context, name string) error
EnsureNetwork Creates a bridge network for the given name if it doesn't already exist.
func (DockerController) GetContainerHostPath ¶ added in v1.3.0
func (*DockerController) Remove ¶ added in v1.1.0
func (controller *DockerController) Remove(ctx context.Context, c Container) error
Remove removes the specified (stopped) container based on its ID.
func (*DockerController) Shutdown ¶
func (controller *DockerController) Shutdown(ctx context.Context, c Container) error
Shutdown terminates the specified running Container based on its ID.
func (*DockerController) ShutdownAll ¶
func (controller *DockerController) ShutdownAll(ctx context.Context) error
ShutdownAll terminates and removes all running containers
func (*DockerController) Start ¶
func (controller *DockerController) Start(ctx context.Context, c *Container, ready string) (chan bool, error)
Start is the method used to Start a Docker container using the specified Container c. It also automatically follows logs and creates a channel that is used to indicate when a running container is ready according to the provided ready string.
func (*DockerController) WaitForShutdown ¶ added in v1.2.0
func (controller *DockerController) WaitForShutdown(ctx context.Context, c Container, timeout time.Duration) error
WaitForShutdown blocks until the specified Container has shutdown or errors within given timeout.
type DockerError ¶
type DockerError struct {
// contains filtered or unexported fields
}
func (DockerError) Error ¶
func (e DockerError) Error() string
type EnsureImageProgress ¶
type EnsureImageProgress struct { Status string ProgressDetail EnsureImageProgressDetail Progress string ID string }
EnsureImageProgress is an object to unmarshall JSON returned from Docker during a pull.
func (EnsureImageProgress) String ¶
func (p EnsureImageProgress) String() string
type EnsureImageProgressDetail ¶
EnsureImageProgressDetail is an object to help unmarshall JSON returned from Docker during a pull.
type NetworkError ¶ added in v1.0.0
type NetworkError struct {
// contains filtered or unexported fields
}
func (NetworkError) Error ¶ added in v1.0.0
func (e NetworkError) Error() string