package
17.12.1-ce-rc2+incompatible
Repository: https://github.com/docker-archive/docker-ce.git
Documentation: pkg.go.dev

# Functions

ConvertKVStringsToMap converts ["key=value"] to {"key":"value"}.
ConvertKVStringsToMapWithNil converts ["key=value"] to {"key":"value"} but set unset keys to nil - meaning the ones with no "=" in them.
ConvertPortToPortConfig converts ports to the swarm type.
NewDurationOpt creates a DurationOpt with the specified duration.
NewFilterOpt returns a new FilterOpt.
NewIPOpt creates a new IPOpt from a reference net.IP and a string representation of an IP.
NewListOpts creates a new ListOpts with the specified validator.
NewListOptsRef creates a new ListOpts with the specified values and validator.
NewMapOpts creates a new MapOpts with the specified map of values and a validator.
NewNamedListOptsRef creates a reference to a new NamedListOpts struct.
NewNamedMapOpts creates a reference to a new NamedMapOpts struct.
NewNamedRuntimeOpt creates a new RuntimeOpt.
NewQuotedString returns a new quoted string option.
NewThrottledeviceOpt creates a new ThrottledeviceOpt.
NewUlimitOpt creates a new UlimitOpt.
NewWeightdeviceOpt creates a new WeightdeviceOpt.
ParseCPUs takes a string ratio and returns an integer value of nano cpus.
ParseEnvFile reads a file with environment variables enumerated by lines ``Environment variable names used by the utilities in the Shell and Utilities volume of IEEE Std 1003.1-2001 consist solely of uppercase letters, digits, and the '_' (underscore) from the characters defined in Portable Character Set and do not begin with a digit.
ParseHost and set defaults for a Daemon host string.
ParseLink parses and validates the specified string as a link format (name:alias).
ParseRestartPolicy returns the parsed policy or an error indicating what is incorrect.
ParseTCPAddr parses and validates that the specified address is a valid TCP address.
ReadKVStrings reads a file of line terminated key=value pairs, and overrides any keys present in the file with additional pairs specified in the override parameter.
ValidateDNSSearch validates domain for resolvconf search configuration.
ValidateEnv validates an environment variable and returns it.
ValidateExtraHost validates that the specified string is a valid extrahost and returns it.
ValidateHost validates that the specified string is a valid host and returns it.
ValidateIPAddress validates an Ip address.
ValidateLabel validates that the specified string is a valid label, and returns it.
ValidateLink validates that the specified string has a valid link format (containerName:alias).
ValidateMACAddress validates a MAC address.
ValidateSysctl validates a sysctl and returns it.
ValidateThrottleBpsDevice validates that the specified string has a valid device-rate format.
ValidateThrottleIOpsDevice validates that the specified string has a valid device-rate format.
ValidateWeightDevice validates that the specified string has a valid device-weight format.

# Constants

DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g.

# Variables

DefaultHost constant defines the default host string used by docker on other hosts than Windows.
Default HTTP Port.
DefaultNamedPipe defines the default named pipe used by docker on Windows.
DefaultTCPHost constant defines the default host string used by docker on Windows.
DefaultTLSHost constant defines the default host string used by docker for TLS sockets.
Default TLS encrypted HTTP Port.
DefaultUnixSocket Path for the unix socket.

# Structs

ConfigOpt is a Value type for parsing configs.
DurationOpt is an option type for time.Duration that uses a pointer.
ErrBadEnvVariable typed error for bad environment variable.
FilterOpt is a flag type for validating filters.
IPOpt holds an IP.
ListOpts holds a list of values and a validation function.
MapOpts holds a map of values and a validation function.
MountOpt is a Value type for parsing mounts.
NamedListOpts is a ListOpts with a configuration name.
NamedMapOpts is a MapOpts struct with a configuration name.
NetworkAttachmentOpts represents the network options for endpoint creation.
NetworkOpt represents a network config in swarm mode.
PortOpt represents a port config in swarm mode.
PositiveDurationOpt is an option type for time.Duration that uses a pointer.
QuotedString is a string that may have extra quotes around the value.
RuntimeOpt defines a map of Runtimes.
SecretOpt is a Value type for parsing secrets.
ThrottledeviceOpt defines a map of ThrottleDevices.
UlimitOpt defines a map of Ulimits.
WeightdeviceOpt defines a map of WeightDevices.

# Interfaces

NamedOption is an interface that list and map options with names implement.

# Type aliases

MemBytes is a type for human readable memory bytes (like 128M, 2g, etc).
MemSwapBytes is a type for human readable memory bytes (like 128M, 2g, etc).
NanoCPUs is a type for fixed point fractional number.
ValidatorFctListType defines a validator function that returns a validated list of string and/or an error.
ValidatorFctType defines a validator function that returns a validated string and/or an error.
ValidatorThrottleFctType defines a validator function that returns a validated struct and/or an error.
ValidatorWeightFctType defines a validator function that returns a validated struct and/or an error.