docker

Documentation

Index

• Constants
• Variables
• func GetDockerClient() (*command.DockerCli, error)
• func New() install.Driver
• type ConfigurationOption
  • func NetworkModeOpt(mode string) ConfigurationOption
  • func UsernsModeOpt(mode string) ConfigurationOption
• type Driver
  • func (d *Driver) ApplyConfigurationOptions() error
  • func (d *Driver) Exec(op *install.Operation) (*install.OperationResult, error)
  • func (d *Driver) GetContainerConfig() (container.Config, error)
  • func (d *Driver) GetContainerHostConfig() (container.HostConfig, error)
  • func (d *Driver) SetConfig(settings map[string]string) error
  • func (d *Driver) SetContainerErr(w io.Writer)
  • func (d *Driver) SetContainerOut(w io.Writer)
  • func (d *Driver) SetDockerCli(dockerCli command.Cli)

Constants

const (
	// DockerTLSVerifyEnvVar is the Docker environment variable that indicates that
	// Docker socket is protected with TLS.
	DockerTLSVerifyEnvVar = "DOCKER_TLS_VERIFY"

	// DockerCertPathEnvVar is the Docker environment variable that specifies a
	// custom path to the TLS certificates for the Docker socket.
	DockerCertPathEnvVar = "DOCKER_CERT_PATH"
)

const (
	OptionQuiet            = "DOCKER_DRIVER_QUIET"
	OptionCleanup          = "CLEANUP_CONTAINERS"
	OptionPullPolicy       = "PULL_POLICY"
	PullPolicyAlways       = "Always"
	PullPolicyNever        = "Never"
	PullPolicyIfNotPresent = "IfNotPresent"
	OptionNetworkMode      = "NETWORK_MODE"
	OptionUsernsMode       = "USERNS_MODE"
)

Variables

var Options = generics.NewSet[string](
	OptionQuiet,
	OptionCleanup,
	OptionPullPolicy,
	OptionNetworkMode,
	OptionUsernsMode,
)

Functions

func GetDockerClient

func GetDockerClient() (*command.DockerCli, error)

GetDockerClient creates a Docker CLI client that uses the user's Docker configuration such as environment variables and the Docker home directory to initialize the client.

func New

func New() install.Driver

Types

type ConfigurationOption

type ConfigurationOption func(*container.Config, *container.HostConfig) error

ConfigurationOption is an option used to customize docker driver container and host config.

func NetworkModeOpt

func NetworkModeOpt(mode string) ConfigurationOption

func UsernsModeOpt

func UsernsModeOpt(mode string) ConfigurationOption

type Driver

type Driver struct {

	// If true, this will not actually run Docker
	Simulate bool
	// contains filtered or unexported fields
}

Driver is capable of running Docker invocation images using Docker itself.

func (*Driver) ApplyConfigurationOptions

func (d *Driver) ApplyConfigurationOptions() error

ApplyConfigurationOptions applies the configuration options set on the driver by the user.

func (*Driver) Exec

func (d *Driver) Exec(op *install.Operation) (*install.OperationResult, error)

func (*Driver) GetContainerConfig

func (d *Driver) GetContainerConfig() (container.Config, error)

GetContainerConfig returns a copy of the container configuration used by the driver during container exec.

func (*Driver) GetContainerHostConfig

func (d *Driver) GetContainerHostConfig() (container.HostConfig, error)

GetContainerHostConfig returns a copy of the container host configuration used by the driver during container exec.

func (*Driver) SetConfig

func (d *Driver) SetConfig(settings map[string]string) error

SetConfig sets Docker driver configuration.

func (*Driver) SetContainerErr

func (d *Driver) SetContainerErr(w io.Writer)

SetContainerErr sets the container error stream.

func (*Driver) SetContainerOut

func (d *Driver) SetContainerOut(w io.Writer)

SetContainerOut sets the container output stream.

func (*Driver) SetDockerCli

func (d *Driver) SetDockerCli(dockerCli command.Cli)

SetDockerCli makes the driver use an already initialized cli.