import "github.com/docker/docker/opts"
address_pools.go env.go hosts.go hosts_unix.go ip.go opts.go quotedstring.go runtime.go ulimit.go
const (
// DefaultHTTPPort Default HTTP Port used if only the protocol is provided to -H flag e.g. dockerd -H tcp://
// These are the IANA registered port numbers for use with Docker
// see http://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=docker
DefaultHTTPPort = 2375 // Default HTTP Port
// DefaultTLSHTTPPort Default HTTP Port used when TLS enabled
DefaultTLSHTTPPort = 2376 // Default TLS encrypted HTTP Port
// DefaultUnixSocket Path for the unix socket.
// Docker daemon by default always listens on the default unix socket
DefaultUnixSocket = "/var/run/docker.sock"
// DefaultTCPHost constant defines the default host string used by docker on Windows
DefaultTCPHost = "tcp://" + DefaultHTTPHost + ":2375"
// DefaultTLSHost constant defines the default host string used by docker for TLS sockets
DefaultTLSHost = "tcp://" + DefaultHTTPHost + ":2376"
// DefaultNamedPipe defines the default named pipe used by docker on Windows
DefaultNamedPipe = `//./pipe/docker_engine`
// HostGatewayName is the string value that can be passed
// to the IPAddr section in --add-host that is replaced by
// the value of HostGatewayIP daemon config value
HostGatewayName = "host-gateway"
)const (
// DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. dockerd -H tcp://:8080
DefaultHTTPHost = "localhost"
// DefaultHost constant defines the default host string used by docker on other hosts than Windows
DefaultHost = "unix://" + DefaultUnixSocket
)ParseHost and set defaults for a Daemon host string. defaultToTLS is preferred over defaultToUnixXDG.
ParseLink parses and validates the specified string as a link format (name:alias)
ParseTCPAddr parses and validates that the specified address is a valid TCP address. It returns a formatted TCP address, either using the address parsed from tryAddr, or the contents of defaultAddr if tryAddr is a blank string. tryAddr is expected to have already been Trim()'d defaultAddr must be in the full `tcp://host:port` form
ValidateDNSSearch validates domain for resolvconf search configuration. A zero length domain is represented by a dot (.).
ValidateEnv validates an environment variable and returns it. If no value is specified, it obtains its value from the current environment
As on ParseEnvFile and related to #16585, environment variable names are not validate whatsoever, it's up to application inside docker to validate them or not.
The only validation here is to check if name is empty, per #25099
ValidateExtraHost validates that the specified string is a valid extrahost and returns it. ExtraHost is in the form of name:ip where the ip has to be a valid ip (IPv4 or IPv6).
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, it does not use the reserved namespaces com.docker.*, io.docker.*, org.dockerproject.* and returns it. Labels are in the form on key=value.
ValidateSingleGenericResource validates that a single entry in the generic resource list is valid. i.e 'GPU=UID1' is valid however 'GPU:UID1' or 'UID1' isn't
IPOpt holds an IP. It is used to store values from CLI flags.
NewIPOpt creates a new IPOpt from a reference net.IP and a string representation of an IP. If the string is not a valid IP it will fallback to the specified reference.
Set sets an IPv4 or IPv6 address from a given string. If the given string is not parsable as an IP address it returns an error.
String returns the IP address stored in the IPOpt. If stored IP is a nil pointer, it returns an empty string.
Type returns the type of the option
type ListOpts struct {
// contains filtered or unexported fields
}ListOpts holds a list of values and a validation function.
func NewListOpts(validator ValidatorFctType) ListOpts
NewListOpts creates a new ListOpts with the specified validator.
func NewListOptsRef(values *[]string, validator ValidatorFctType) *ListOpts
NewListOptsRef creates a new ListOpts with the specified values and validator.
Delete removes the specified element from the slice.
Get checks the existence of the specified key.
GetAll returns the values of slice.
GetAllOrEmpty returns the values of the slice or an empty slice when there are no values.
GetMap returns the content of values in a map in order to avoid duplicates.
Len returns the amount of element in the slice.
Set validates if needed the input value and adds it to the internal slice.
Type returns a string name for this Option type
func (opts *ListOpts) WithValidator(validator ValidatorFctType) *ListOpts
WithValidator returns the ListOpts with validator set.
type MapOpts struct {
// contains filtered or unexported fields
}MapOpts holds a map of values and a validation function.
func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts
NewMapOpts creates a new MapOpts with the specified map of values and a validator.
GetAll returns the values of MapOpts as a map.
Set validates if needed the input value and add it to the internal map, by splitting on '='.
Type returns a string name for this Option type
MemBytes is a type for human readable memory bytes (like 128M, 2g, etc)
Set sets the value of the MemBytes by passing a string
String returns the string format of the human readable memory bytes
Type returns the type
UnmarshalJSON is the customized unmarshaler for MemBytes
Value returns the value in int64
NamedListOpts is a ListOpts with a configuration name. This struct is useful to keep reference to the assigned field name in the internal configuration struct.
func NewNamedListOptsRef(name string, values *[]string, validator ValidatorFctType) *NamedListOpts
NewNamedListOptsRef creates a reference to a new NamedListOpts struct.
func (o *NamedListOpts) Name() string
Name returns the name of the NamedListOpts in the configuration.
NamedMapOpts is a MapOpts struct with a configuration name. This struct is useful to keep reference to the assigned field name in the internal configuration struct.
func NewNamedMapOpts(name string, values map[string]string, validator ValidatorFctType) *NamedMapOpts
NewNamedMapOpts creates a reference to a new NamedMapOpts struct.
func (o *NamedMapOpts) Name() string
Name returns the name of the NamedMapOpts in the configuration.
NamedOption is an interface that list and map options with names implement.
NamedUlimitOpt defines a named map of Ulimits
NewNamedUlimitOpt creates a new NamedUlimitOpt
func (o *NamedUlimitOpt) Name() string
Name returns the option name
type PoolsOpt struct {
Values []*types.NetworkToSplit
}PoolsOpt is a Value type for parsing the default address pools definitions
Name returns the flag name of this option
Set predefined pools
String returns a string repr of this option
Type returns the type of this option
UnmarshalJSON fills values structure info from JSON input
func (p *PoolsOpt) Value() []*types.NetworkToSplit
Value returns the mounts
type QuotedString struct {
// contains filtered or unexported fields
}QuotedString is a string that may have extra quotes around the value. The quotes are stripped from the value.
func NewQuotedString(value *string) *QuotedString
NewQuotedString returns a new quoted string option
func (s *QuotedString) Set(val string) error
Set sets a new value
func (s *QuotedString) String() string
func (s *QuotedString) Type() string
Type returns the type of the value
type RuntimeOpt struct {
// contains filtered or unexported fields
}RuntimeOpt defines a map of Runtimes
func NewNamedRuntimeOpt(name string, ref *map[string]types.Runtime, stockRuntime string) *RuntimeOpt
NewNamedRuntimeOpt creates a new RuntimeOpt
func (o *RuntimeOpt) GetMap() map[string]types.Runtime
GetMap returns a map of Runtimes (name: path)
func (o *RuntimeOpt) Name() string
Name returns the name of the NamedListOpts in the configuration.
func (o *RuntimeOpt) Set(val string) error
Set validates and updates the list of Runtimes
func (o *RuntimeOpt) String() string
String returns Runtime values as a string.
func (o *RuntimeOpt) Type() string
Type returns the type of the option
type UlimitOpt struct {
// contains filtered or unexported fields
}UlimitOpt defines a map of Ulimits
NewUlimitOpt creates a new UlimitOpt
GetList returns a slice of pointers to Ulimits.
Set validates a Ulimit and sets its name as a key in UlimitOpt
String returns Ulimit values as a string.
Type returns the option type
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.
Package opts imports 16 packages (graph) and is imported by 6803 packages. Updated 2020-11-09. Refresh now. Tools for package owners.