docker

Documentation

Index

• func Secret(server, user, pass, email string) ([]byte, error)
• type Client
• type Docker
  • func New(ctx context.Context) (*Docker, error)
  • func (d *Docker) Port(ctx context.Context, container string) (int, error)
  • func (d *Docker) Version(ctx context.Context) (Version, error)
• type Version

Functions

func Secret

func Secret(server, user, pass, email string) ([]byte, error)

Secret generates a docker registry secret that can be stored as a k8s secret and used to pull images from docker hub (or any other registry) in an authenticated manner. The format if the []byte in string form will be

{
  "auths": {
    "[SERVER]": {
      "username": "[USER]",
      "password": "[PASS]",
      "email": "[EMAIL]",
      "auth"; "[base64 encoding of 'user:pass']"
    }
  }
}

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, container.PathStat, error)

	ContainerExecCreate(ctx context.Context, container string, config container.ExecOptions) (types.IDResponse, error)
	ContainerExecInspect(ctx context.Context, execID string) (container.ExecInspect, error)
	ContainerExecStart(ctx context.Context, execID string, config container.ExecStartOptions) error

	ImageList(ctx context.Context, options image.ListOptions) ([]image.Summary, error)
	ImagePull(ctx context.Context, refStr string, options image.PullOptions) (io.ReadCloser, 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) 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.