dockerclient

Documentation

Index

• Constants
• Variables
• type DockerVersion
• type Factory
  • func NewFactory(endpoint string) Factory
• type LoggingDriver

Constants

const MinDockerAPIWindows = Version_1_24

Variables

var LoggingDriverMinimumVersion = map[LoggingDriver]DockerVersion{
	JSONFileDriver:   Version_1_18,
	SyslogDriver:     Version_1_18,
	JournaldDriver:   Version_1_19,
	GelfDriver:       Version_1_20,
	FluentdDriver:    Version_1_20,
	AWSLogsDriver:    Version_1_21,
	SplunklogsDriver: Version_1_22,
	LogentriesDriver: Version_1_25,
}

Types

type DockerVersion

type DockerVersion string

const (
	Version_1_17 DockerVersion = "1.17"
	Version_1_18 DockerVersion = "1.18"
	Version_1_19 DockerVersion = "1.19"
	Version_1_20 DockerVersion = "1.20"
	Version_1_21 DockerVersion = "1.21"
	Version_1_22 DockerVersion = "1.22"
	Version_1_23 DockerVersion = "1.23"
	Version_1_24 DockerVersion = "1.24"
	Version_1_25 DockerVersion = "1.25"
	Version_1_26 DockerVersion = "1.26"
	Version_1_27 DockerVersion = "1.27"
	Version_1_28 DockerVersion = "1.28"
)

type Factory

type Factory interface {
	// GetDefaultClient returns a versioned client for the default version
	GetDefaultClient() (dockeriface.Client, error)

	// GetClient returns a client with the specified version or an error
	// if the client doesn't exist.
	GetClient(version DockerVersion) (dockeriface.Client, error)

	// FindSupportedAPIVersions returns a slice of agent-supported Docker API
	// versions. Versions are tested by making calls against the Docker daemon
	// and may occur either at Factory creation time or lazily upon invocation
	// of this function. The slice represents the intersection of
	// agent-supported versions and daemon-supported versions.
	FindSupportedAPIVersions() []DockerVersion

	// FindKnownAPIVersions returns a slice of Docker API versions that are
	// known to the Docker daemon. Versions are tested by making calls against
	// the Docker daemon and may occur either at Factory creation time or
	// lazily upon invocation of this function. The slice represents the
	// intersection of the API versions that the agent knows exist (but does
	// not necessarily fully support) and the versions that result in
	// successful responses by the Docker daemon.
	FindKnownAPIVersions() []DockerVersion
}

Factory provides a collection of docker remote clients that include a recommended client version as well as a set of alternative supported docker clients.

func NewFactory

func NewFactory(endpoint string) Factory

NewFactory initializes a client factory using a specified endpoint.

type LoggingDriver

type LoggingDriver string

const (
	JSONFileDriver   LoggingDriver = "json-file"
	SyslogDriver     LoggingDriver = "syslog"
	JournaldDriver   LoggingDriver = "journald"
	GelfDriver       LoggingDriver = "gelf"
	FluentdDriver    LoggingDriver = "fluentd"
	AWSLogsDriver    LoggingDriver = "awslogs"
	SplunklogsDriver LoggingDriver = "splunk"
	LogentriesDriver LoggingDriver = "logentries"
)