docker

Documentation

Index

• type Client
• type Docker
  • func New(ctx context.Context) (*Docker, error)
  • func (d *Docker) MigrateComposeDB(ctx context.Context, volume string) error
  • func (d *Docker) Port(ctx context.Context, container string) (int, error)
  • func (d *Docker) Version(ctx context.Context) (Version, error)
• type Version

Types

type Client

type Client interface {
	ContainerCreate(ctx context.Context, config *container.Config, hostConfig *container.HostConfig, networkingConfig *network.NetworkingConfig, platform *ocispec.Platform, containerName string) (container.CreateResponse, error)
	ContainerInspect(ctx context.Context, containerID string) (types.ContainerJSON, error)
	ContainerRemove(ctx context.Context, container string, options container.RemoveOptions) error
	ContainerStart(ctx context.Context, container string, options container.StartOptions) error
	ContainerStop(ctx context.Context, container string, options container.StopOptions) error
	CopyFromContainer(ctx context.Context, container, srcPath string) (io.ReadCloser, types.ContainerPathStat, error)

	ContainerExecCreate(ctx context.Context, container string, config types.ExecConfig) (types.IDResponse, error)
	ContainerExecInspect(ctx context.Context, execID string) (types.ContainerExecInspect, error)
	ContainerExecStart(ctx context.Context, execID string, config types.ExecStartCheck) error

	ServerVersion(ctx context.Context) (types.Version, error)
	VolumeInspect(ctx context.Context, volumeID string) (volume.Volume, error)
}

Client interface for testing purposes. Includes only the methods used by the underlying docker package.

type Docker

type Docker struct {
	Client Client
}

Docker for handling communication with the docker processes. Can be created with default settings by calling New or with a custom Client by manually instantiating this type.

func New

func New(ctx context.Context) (*Docker, error)

New returns a new Docker type with a default Client implementation.

func (*Docker) MigrateComposeDB

func (d *Docker) MigrateComposeDB(ctx context.Context, volume string) error

MigrateComposeDB handles migrating the existing docker compose database into the abctl managed k8s cluster. TODO: move this method out of the the docker class?

func (*Docker) Port

func (d *Docker) Port(ctx context.Context, container string) (int, error)

Port returns the host-port the underlying docker process is currently bound to, for the given container. It determines this by walking through all the ports on the container and finding the one that is bound to ip 0.0.0.0.

func (*Docker) Version

func (d *Docker) Version(ctx context.Context) (Version, error)

Version returns the version information from the underlying docker process.

type Version

type Version struct {
	// Version is the platform version
	Version string
	// Arch is the platform architecture
	Arch string
	// Platform is the platform name
	Platform string
}

Version contains al the version information that is being tracked.