dockerx

package

v0.1.19 Latest Latest Go to latest Published: Apr 10, 2024 License: Apache-2.0 Imports: 9 Imported by: 0

Details

Valid go.mod file

The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
Redistributable license

Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
Tagged version

Modules with tagged versions give importers more predictable builds.
Stable version

When a project reaches major version v1 it is considered stable.
Learn more about best practices

Repository

github.com/mmihic/golib

Links

Open Source Insights

Documentation ¶

Overview ¶

Package dockerx contains utilities for working with docker.

Index ¶

func ContainerPortToHostPort(ctx context.Context, cli client.APIClient, containerID string, ...) (int, error)
func MakeSystemAssignedPortMap(ports ...nat.Port) nat.PortMap
func MustMakeNATPort(protocol, portRange string) nat.Port
func StreamContainerLogs(ctx context.Context, cli client.APIClient, containerID string, log Logger, ...) (io.Closer, error)
type Logger
- func ZapLogger(log *zap.Logger) Logger

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func ContainerPortToHostPort ¶

func ContainerPortToHostPort(
	ctx context.Context,
	cli client.APIClient,
	containerID string,
	containerPort nat.Port,
) (int, error)

ContainerPortToHostPort finds the host port to which the given container port has been bound. Useful when starting test containers and allowing them to choose their own host port.

func MakeSystemAssignedPortMap ¶

func MakeSystemAssignedPortMap(ports ...nat.Port) nat.PortMap

MakeSystemAssignedPortMap creates a port map for the given list of nat Ports, using system assigned ports for the host side of the port binding.

func MustMakeNATPort ¶

func MustMakeNATPort(protocol, portRange string) nat.Port

MustMakeNATPort creates a new nat.Port, panicking rather than returning an error if the port is malformed. Useful for constants and tests.

func StreamContainerLogs ¶

func StreamContainerLogs(ctx context.Context,
	cli client.APIClient, containerID string, log Logger,
	opts types.ContainerLogsOptions) (io.Closer, error)

StreamContainerLogs streams container logs in a background goroutine.

Types ¶

type Logger ¶

type Logger func(msg string)

A Logger logs output from the container.

func ZapLogger ¶

func ZapLogger(log *zap.Logger) Logger

ZapLogger returns an adapter that passes container logs to a zap logger.

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL