docker

Documentation

Overview

Package docker contains the Docker wrapped client for the cat image.

Index

• type DockerClient
  • func NewDockerClient(onPullProgress onPullProgressFunc) (*DockerClient, error)
  • func (client *DockerClient) Close() error
  • func (client *DockerClient) PullCatImage(ctx context.Context, version string) error
  • func (client *DockerClient) RemoveCatContainer(ctx context.Context, containerName string) error
  • func (client *DockerClient) StartCatContainer(ctx context.Context, config StartCatContainerConfig) error
  • func (client *DockerClient) StopCatContainer(ctx context.Context, containerName string) error
• type StartCatContainerConfig

Types

type DockerClient

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

DockerClient is a wrapper around the Docker client to handle the CLI features.

func NewDockerClient

func NewDockerClient(onPullProgress onPullProgressFunc) (*DockerClient, error)

NewDockerClient creates a new DockerClient

func (*DockerClient) Close

func (client *DockerClient) Close() error

Close closes the underlying Docker client

func (*DockerClient) PullCatImage

func (client *DockerClient) PullCatImage(ctx context.Context, version string) error

PullCatImage pulls the specified version of the cat image

func (*DockerClient) RemoveCatContainer

func (client *DockerClient) RemoveCatContainer(ctx context.Context, containerName string) error

RemoveCatContainer removes the specified cat container

func (*DockerClient) StartCatContainer

func (client *DockerClient) StartCatContainer(ctx context.Context, config StartCatContainerConfig) error

StartCatContainer starts the cheshire cat container with the specified config

func (*DockerClient) StopCatContainer

func (client *DockerClient) StopCatContainer(ctx context.Context, containerName string) error

StopCatContainer stops the specified cat container

type StartCatContainerConfig

type StartCatContainerConfig struct {
	CatImage              string
	CatContainerName      string
	CatContainerBoundPort int
	PluginFolderPath      string
	DataFolderPath        string
	StaticFolderPath      string
}