Documentation ¶
Index ¶
- Constants
- Variables
- func ParseEnvFile(filename string) ([]string, error)
- func ParseHost(defaultHost, val string) (string, error)
- func ValidateAttach(val string) (string, error)
- func ValidateDNSSearch(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 ValidateMACAddress(val string) (string, error)
- type ErrBadEnvVariable
- type IPOpt
- type ListOpts
- func (opts *ListOpts) Delete(key string)
- func (opts *ListOpts) Get(key string) bool
- func (opts *ListOpts) GetAll() []string
- func (opts *ListOpts) GetAllOrEmpty() []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
- type ValidatorFctListType
- type ValidatorFctType
Constants ¶
const DefaultHTTPHost = "localhost"
DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. docker daemon -H tcp://:8080
Variables ¶
var ( // 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 ¶
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 ValidateAttach ¶
ValidateAttach validates that the specified string is a valid attach option.
func ValidateDNSSearch ¶
ValidateDNSSearch validates domain for resolvconf search configuration. A zero length domain is represented by a dot (.).
func ValidateEnv ¶
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 ¶
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 ¶
ValidateHost validates that the specified string is a valid host and returns it.
func ValidateIPAddress ¶
ValidateIPAddress validates an Ip address.
func ValidateLabel ¶
ValidateLabel validates that the specified string is a valid label, and returns it. Labels are in the form on key=value.
func ValidateMACAddress ¶
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 ¶
IPOpt holds an IP. It is used to store values from CLI flags.
func NewIPOpt ¶
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.
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) GetAllOrEmpty ¶
GetAllOrEmpty returns the values of the slice or an empty slice when there are no values.
func (*ListOpts) GetMap ¶
GetMap returns the content of values in a map in order to avoid duplicates.
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.
type ValidatorFctListType ¶
ValidatorFctListType defines a validator function that returns a validated list of string and/or an error
type ValidatorFctType ¶
ValidatorFctType defines a validator function that returns a validated string and/or an error.