Documentation ¶
Index ¶
- Variables
- func ParseEnvFile(filename 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)
- func ValidatePath(val string) (string, error)
- type ErrBadEnvVariable
- type IPOpt
- type ListOpts
- type MapOpts
- type UlimitOpt
- type ValidatorFctListType
- type ValidatorFctType
Constants ¶
This section is empty.
Variables ¶
var ( // DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. docker daemon -H tcp://:8080 DefaultHTTPHost = "127.0.0.1" // 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. DefaultHTTPPort = 2375 // Default HTTP Port // DefaultUnixSocket Path for the unix socket. // Docker daemon by default always listens on the default unix socket DefaultUnixSocket = "/var/run/docker.sock" )
var DefaultHost = fmt.Sprintf("unix://%s", DefaultUnixSocket)
DefaultHost constant defines the default host string used by docker on other hosts than Windows
var ( // EnvironmentVariableRegexp is a regexp to validate correct environment variables // Environment variables set by the user must have a name consisting solely of // alphabetics, numerics, and underscores - the first of which must not be numeric. EnvironmentVariableRegexp = regexp.MustCompile("^[[:alpha:]_][[:alpha:][:digit:]_]*$") )
Functions ¶
func ParseEnvFile ¶
ParseEnvFile reads a file with environment variables enumerated by lines
func ValidDeviceMode ¶
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 ¶
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 ValidateDevice ¶
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 ¶
ValidateEnv validates an environment variable and returns it. It uses EnvironmentVariableRegexp to ensure the name of the environment variable is valid. If no value is specified, it returns the current value using os.Getenv.
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 ValidateLink ¶
ValidateLink validates that the specified string has a valid link format (containerName:alias).
func ValidateMACAddress ¶
ValidateMACAddress validates a MAC address.
func ValidatePath ¶
ValidatePath validates a path for volumes It will make sure 'val' is in the form:
[host-dir:]container-path[:rw|ro]
It also validates the mount mode.
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) GetMap ¶
GetMap returns the content of values in a map in order to avoid duplicates. FIXME: can we remove this?
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 UlimitOpt ¶
type UlimitOpt struct {
// contains filtered or unexported fields
}
UlimitOpt defines a map of Ulimits
func NewUlimitOpt ¶
NewUlimitOpt creates a new UlimitOpt
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.