opts

Documentation

Index

• Variables
• func ParseEnvFile(filename string) ([]string, error)
• func ParseHost(defaultHost, val string) (string, error)
• func ValidDeviceMode(mode string) bool
• func ValidateAttach(val string) (string, error)
• func ValidateDNSSearch(val string) (string, error)
• func ValidateDevice(val string) (string, error)
• func ValidateEnv(val string) (string, error)
• func ValidateExtraHost(val string) (string, error)
• func ValidateHost(val string) (string, error)
• func ValidateIPAddress(val string) (string, error)
• func ValidateLabel(val string) (string, error)
• func ValidateLink(val string) (string, error)
• func ValidateMACAddress(val string) (string, error)
• type ErrBadEnvVariable
  • func (e ErrBadEnvVariable) Error() string
• type IPOpt
  • func NewIPOpt(ref *net.IP, defaultVal string) *IPOpt
  • func (o *IPOpt) Set(val string) error
  • func (o *IPOpt) String() string
• type ListOpts
  • func NewListOpts(validator ValidatorFctType) ListOpts
  • func NewListOptsRef(values *[]string, validator ValidatorFctType) *ListOpts
  • func (opts *ListOpts) Delete(key string)
  • func (opts *ListOpts) Get(key string) bool
  • func (opts *ListOpts) GetAll() []string
  • func (opts *ListOpts) GetMap() map[string]struct{}
  • func (opts *ListOpts) Len() int
  • func (opts *ListOpts) Set(value string) error
  • func (opts *ListOpts) String() string
• type MapOpts
  • func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts
  • func (opts *MapOpts) GetAll() map[string]string
  • func (opts *MapOpts) Set(value string) error
  • func (opts *MapOpts) String() string
• type UlimitOpt
  • func NewUlimitOpt(ref *map[string]*ulimit.Ulimit) *UlimitOpt
  • func (o *UlimitOpt) GetList() []*ulimit.Ulimit
  • func (o *UlimitOpt) Set(val string) error
  • func (o *UlimitOpt) String() string
• type ValidatorFctListType
• type ValidatorFctType

Variables

var (

	// DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. docker daemon -H tcp://:8080
	DefaultHTTPHost = "localhost"

	// DefaultHTTPPort Default HTTP Port used if only the protocol is provided to -H flag e.g. docker daemon -H tcp://
	// TODO Windows. DefaultHTTPPort is only used on Windows if a -H parameter
	// is not supplied. A better longer term solution would be to use a named
	// pipe as the default on the Windows daemon.
	// 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 = fmt.Sprintf("tcp://%s:%d", DefaultHTTPHost, DefaultHTTPPort)
	// DefaultTLSHost constant defines the default host string used by docker for TLS sockets
	DefaultTLSHost = fmt.Sprintf("tcp://%s:%d", DefaultHTTPHost, DefaultTLSHTTPPort)
)

var DefaultHost = fmt.Sprintf("unix://%s", DefaultUnixSocket)

DefaultHost constant defines the default host string used by docker on other hosts than Windows

Functions

func ParseEnvFile

func ParseEnvFile(filename string) ([]string, error)

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. *But*, other characters may be permitted by an implementation; applications shall tolerate the presence of such names.” -- http://pubs.opengroup.org/onlinepubs/009695399/basedefs/xbd_chap08.html

As of #16585, it's up to application inside docker to validate or not environment variables, that's why we just strip leading whitespace and nothing more.

func ParseHost

func ParseHost(defaultHost, val string) (string, error)

ParseHost and set defaults for a Daemon host string

func ValidDeviceMode

func ValidDeviceMode(mode string) bool

ValidDeviceMode checks if the mode for device is valid or not. Valid mode is a composition of r (read), w (write), and m (mknod).

func ValidateAttach

func ValidateAttach(val string) (string, error)

ValidateAttach validates that the specified string is a valid attach option.

func ValidateDNSSearch

func ValidateDNSSearch(val string) (string, error)

ValidateDNSSearch validates domain for resolvconf search configuration. A zero length domain is represented by a dot (.).

func ValidateDevice

func ValidateDevice(val string) (string, error)

ValidateDevice validates a path for devices It will make sure 'val' is in the form:

[host-dir:]container-path[:mode]

It also validates the device mode.

func ValidateEnv

func ValidateEnv(val string) (string, error)

ValidateEnv validates an environment variable and returns it. If no value is specified, it returns the current value using os.Getenv.

As on ParseEnvFile and related to #16585, environment variable names are not validate what so ever, it's up to application inside docker to validate them or not.

func ValidateExtraHost

func ValidateExtraHost(val string) (string, error)

ValidateExtraHost validates that the specified string is a valid extrahost and returns it. ExtraHost are in the form of name:ip where the ip has to be a valid ip (ipv4 or ipv6).

func ValidateHost

func ValidateHost(val string) (string, error)

ValidateHost validates that the specified string is a valid host and returns it.

func ValidateIPAddress

func ValidateIPAddress(val string) (string, error)

ValidateIPAddress validates an Ip address.

func ValidateLabel

func ValidateLabel(val string) (string, error)

ValidateLabel validates that the specified string is a valid label, and returns it. Labels are in the form on key=value.

func ValidateLink

func ValidateLink(val string) (string, error)

ValidateLink validates that the specified string has a valid link format (containerName:alias).

func ValidateMACAddress

func ValidateMACAddress(val string) (string, error)

ValidateMACAddress validates a MAC address.

Types

type ErrBadEnvVariable

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

ErrBadEnvVariable typed error for bad environment variable

func (ErrBadEnvVariable) Error

func (e ErrBadEnvVariable) Error() string

type IPOpt

type IPOpt struct {
	*net.IP
}

IPOpt holds an IP. It is used to store values from CLI flags.

func NewIPOpt

func NewIPOpt(ref *net.IP, defaultVal string) *IPOpt

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.

func (*IPOpt) Set

func (o *IPOpt) Set(val string) error

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.

func (*IPOpt) String

func (o *IPOpt) String() string

String returns the IP address stored in the IPOpt. If stored IP is a nil pointer, it returns an empty string.

type ListOpts

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

ListOpts holds a list of values and a validation function.

func NewListOpts

func NewListOpts(validator ValidatorFctType) ListOpts

NewListOpts creates a new ListOpts with the specified validator.

func NewListOptsRef

func NewListOptsRef(values *[]string, validator ValidatorFctType) *ListOpts

NewListOptsRef creates a new ListOpts with the specified values and validator.

func (*ListOpts) Delete

func (opts *ListOpts) Delete(key string)

Delete removes the specified element from the slice.

func (*ListOpts) Get

func (opts *ListOpts) Get(key string) bool

Get checks the existence of the specified key.

func (*ListOpts) GetAll

func (opts *ListOpts) GetAll() []string

GetAll returns the values of slice.

func (*ListOpts) GetMap

func (opts *ListOpts) GetMap() map[string]struct{}

GetMap returns the content of values in a map in order to avoid duplicates.

func (*ListOpts) Len

func (opts *ListOpts) Len() int

Len returns the amount of element in the slice.

func (*ListOpts) Set

func (opts *ListOpts) Set(value string) error

Set validates if needed the input value and add it to the internal slice.

func (*ListOpts) String

func (opts *ListOpts) String() string

type MapOpts

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

MapOpts holds a map of values and a validation function.

func NewMapOpts

func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts

NewMapOpts creates a new MapOpts with the specified map of values and a validator.

func (*MapOpts) GetAll

func (opts *MapOpts) GetAll() map[string]string

GetAll returns the values of MapOpts as a map.

func (*MapOpts) Set

func (opts *MapOpts) Set(value string) error

Set validates if needed the input value and add it to the internal map, by splitting on '='.

func (*MapOpts) String

func (opts *MapOpts) String() string

type UlimitOpt

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

UlimitOpt defines a map of Ulimits

func NewUlimitOpt

func NewUlimitOpt(ref *map[string]*ulimit.Ulimit) *UlimitOpt

NewUlimitOpt creates a new UlimitOpt

func (*UlimitOpt) GetList

func (o *UlimitOpt) GetList() []*ulimit.Ulimit

GetList returns a slice of pointers to Ulimits.

func (*UlimitOpt) Set

func (o *UlimitOpt) Set(val string) error

Set validates a Ulimit and sets its name as a key in UlimitOpt

func (*UlimitOpt) String

func (o *UlimitOpt) String() string

String returns Ulimit values as a string.

type ValidatorFctListType

type ValidatorFctListType func(val string) ([]string, error)

ValidatorFctListType defines a validator function that returns a validated list of string and/or an error

type ValidatorFctType

type ValidatorFctType func(val string) (string, error)

ValidatorFctType defines a validator function that returns a validated string and/or an error.