Documentation ¶
Index ¶
- Variables
- func DNSSearchListVar(values *[]string, names []string, usage string)
- func HostListVar(values *[]string, names []string, usage string)
- func IPListVar(values *[]string, names []string, usage string)
- func IPVar(value *net.IP, names []string, defaultValue, usage string)
- func LabelListVar(values *[]string, names []string, usage string)
- func ListVar(values *[]string, names []string, usage string)
- func LogOptsVar(values map[string]string, names []string, usage string)
- func MapVar(values map[string]string, names []string, usage string)
- func ParseEnvFile(filename string) ([]string, error)
- func UlimitMapVar(values *map[string]*ulimit.Ulimit, names []string, usage string)
- 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 -d -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 -d -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)
var ( // EnvironmentVariableRegexp 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 DNSSearchListVar ¶ added in v0.327.0
DNSSearchListVar Defines a flag with the specified names and usage and put the value into a ListOpts that will hold the values, validating the DNS search format.
func HostListVar ¶
HostListVar Defines a flag with the specified names and usage and put the value into a ListOpts that will hold the values, validating the Host format.
func IPListVar ¶
IPListVar Defines a flag with the specified names and usage and put the value into a ListOpts that will hold the values, validating the IP format.
func IPVar ¶
IPVar Defines a flag with the specified names and usage for IP and will use the specified defaultValue if the specified value is not valid.
func LabelListVar ¶
LabelListVar Defines a flag with the specified names and usage and put the value into a ListOpts that will hold the values, validating the label format.
func ListVar ¶
ListVar Defines a flag with the specified names and usage, and put the value list into ListOpts that will hold the values.
func LogOptsVar ¶
LogOptsVar Defines a flag with the specified names and usage for --log-opts, and put the value map into MapOpt that will hold the values (key,value).
func MapVar ¶
MapVar Defines a flag with the specified names and usage, and put the value map into MapOpt that will hold the values (key,value).
func ParseEnvFile ¶
ParseEnvFile Read in a line delimited file with environment variables enumerated
func UlimitMapVar ¶
UlimitMapVar Defines a flag with the specified names and usage for --ulimit, and put the value map into a UlimitOpt that will hold the values.
func ValidateAttach ¶
ValidateAttach Validates that the specified string is a valid attach option.
func ValidateDNSSearch ¶ added in v0.327.0
ValidateDNSSearch Validates domain for resolvconf search configuration. A zero length domain is represented by .
func ValidateDevice ¶ added in v0.327.0
ValidateDevice Validate a path for devices It will make sure 'val' is in the form:
[host-dir:]container-path[:mode]
func ValidateEnv ¶
ValidateEnv Validate an environment variable and returns it It will use 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 Validate that the given 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 Validate that the given string is a valid host and returns it
func ValidateIPAddress ¶
ValidateIPAddress Validates an Ip address
func ValidateLabel ¶
ValidateLabel Validate that the given 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 Validate a path for volumes It will make sure 'val' is in the form:
[host-dir:]container-path[:rw|ro]
It will also validate 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 ListOpts ¶
type ListOpts struct {
// contains filtered or unexported fields
}
ListOpts type that hold a list of values and a validation function.
func NewListOpts ¶
func NewListOpts(validator ValidatorFctType) ListOpts
NewListOpts Create a new ListOpts with the specified validator.
func NewListOptsRef ¶ added in v0.327.0
func NewListOptsRef(values *[]string, validator ValidatorFctType) *ListOpts
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 type that holds a map of values and a validation function.
func NewMapOpts ¶ added in v0.327.0
func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts
type ValidatorFctListType ¶
ValidatorFctListType validator that return a validate list of string and/or an error
type ValidatorFctType ¶
ValidatorFctType validator that return a validate string and/or an error