opts
package
This package is not in the latest version of its module.
Details
Validgo.mod file
The Go module system was introduced in Go 1.11 and is the official dependency management solution for Go.
- Redistributable license
Redistributable licenses place minimal restrictions on how software can be used, modified, and redistributed.
- Tagged version
Modules with tagged versions give importers more predictable builds.
Stable versionWhen a project reaches major version v1 it is considered stable.
- Learn more about best practices
Repository
Links
Open Source Insights
Documentation¶
Index¶
- Constants
- func ParseHost(defaultToTLS, defaultToUnixXDG bool, val string) (string, error)
- func ParseLink(val string) (string, string, error)
- func ParseTCPAddr(tryAddr string, defaultAddr 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 ValidateSingleGenericResource(val string) (string, error)
- 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
- func (opts *ListOpts) Type() string
- func (opts *ListOpts) WithValidator(validator ValidatorFctType) *ListOpts
- type MapMapOpts
- type MapOpts
- type MemBytes
- type NamedListOpts
- type NamedMapMapOpts
- type NamedMapOpts
- type NamedOption
- type NamedUlimitOpt
- type PoolsOpt
- type RuntimeOpt
- type UlimitOpt
- type ValidatorFctListType
- type ValidatorFctType
Constants¶
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// seehttp://www.iana.org/assignments/service-names-port-numbers/service-names-port-numbers.xhtml?search=dockerDefaultHTTPPort = 2375// Default HTTP Port// DefaultTLSHTTPPort Default HTTP Port used when TLS enabledDefaultTLSHTTPPort = 2376// Default TLS encrypted HTTP Port// DefaultUnixSocket Path for the unix socket.// Docker daemon by default always listens on the default unix socketDefaultUnixSocket = "/var/run/docker.sock"// DefaultTCPHost constant defines the default host string used by docker on WindowsDefaultTCPHost = "tcp://" +DefaultHTTPHost + ":2375"// DefaultTLSHost constant defines the default host string used by docker for TLS socketsDefaultTLSHost = "tcp://" +DefaultHTTPHost + ":2376"// DefaultNamedPipe defines the default named pipe used by docker on WindowsDefaultNamedPipe = `//./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 valueHostGatewayName = "host-gateway")
const (// DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. dockerd -H tcp://:8080DefaultHTTPHost = "localhost"// DefaultHost constant defines the default host string used by docker on other hosts than WindowsDefaultHost = "unix://" +DefaultUnixSocket)
Variables¶
This section is empty.
Functions¶
funcParseHost¶
ParseHost and set defaults for a Daemon host string.defaultToTLS is preferred over defaultToUnixXDG.
funcParseTCPAddr¶
ParseTCPAddr parses and validates that the specified address is a valid TCPaddress. It returns a formatted TCP address, either using the address parsedfrom tryAddr, or the contents of defaultAddr if tryAddr is a blank string.tryAddr is expected to have already been Trim()'ddefaultAddr must be in the full `tcp://host:port` form
funcValidateDNSSearch¶
ValidateDNSSearch validates domain for resolvconf search configuration.A zero length domain is represented by a dot (.).
funcValidateEnv¶
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 namesare not validate whatsoever, it's up to application inside dockerto validate them or not.
The only validation here is to check if name is empty, per #25099
funcValidateExtraHost¶
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).
funcValidateHost¶
ValidateHost validates that the specified string is a valid host and returns it.
funcValidateIPAddress¶
ValidateIPAddress validates if the given value is a correctly formattedIP address, and returns the value in normalized form. Leading and trailingwhitespace is allowed, but it does not allow IPv6 addresses surrounded bysquare brackets ("[::1]").
Refer tonet.ParseIP for accepted formats.
funcValidateLabel¶
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.
funcValidateSingleGenericResource¶
ValidateSingleGenericResource validates that a single entry in thegeneric resource list is valid.i.e 'GPU=UID1' is valid however 'GPU:UID1' or 'UID1' isn't
Types¶
typeListOpts¶
type ListOpts struct {// contains filtered or unexported fields}ListOpts holds a list of values and a validation function.
funcNewListOpts¶
func NewListOpts(validatorValidatorFctType)ListOpts
NewListOpts creates a new ListOpts with the specified validator.
funcNewListOptsRef¶
func NewListOptsRef(values *[]string, validatorValidatorFctType) *ListOpts
NewListOptsRef creates a new ListOpts with the specified values and validator.
func (*ListOpts)GetAllOrEmpty¶
GetAllOrEmpty returns the values of the sliceor an empty slice when there are no values.
func (*ListOpts)WithValidator¶
func (opts *ListOpts) WithValidator(validatorValidatorFctType) *ListOpts
WithValidator returns the ListOpts with validator set.
typeMapMapOpts¶
type MapMapOpts struct {// contains filtered or unexported fields}MapMapOpts holds a map of maps of values and a validation function.
funcNewMapMapOpts¶
func NewMapMapOpts(values map[string]map[string]string, validatorValidatorFctType) *MapMapOpts
NewMapMapOpts creates a new MapMapOpts with the specified map of values and a validator.
func (*MapMapOpts)GetAll¶
func (opts *MapMapOpts) GetAll() map[string]map[string]string
GetAll returns the values of MapOpts as a map.
func (*MapMapOpts)Set¶
func (opts *MapMapOpts) Set(valuestring)error
Set validates if needed the input value and add it to theinternal map, by splitting on '='.
func (*MapMapOpts)String¶
func (opts *MapMapOpts) String()string
func (*MapMapOpts)Type¶
func (opts *MapMapOpts) Type()string
Type returns a string name for this Option type
typeMapOpts¶
type MapOpts struct {// contains filtered or unexported fields}MapOpts holds a map of values and a validation function.
funcNewMapOpts¶
func NewMapOpts(values map[string]string, validatorValidatorFctType) *MapOpts
NewMapOpts creates a new MapOpts with the specified map of values and a validator.
typeMemBytes¶
type MemBytesint64
MemBytes is a type for human readable memory bytes (like 128M, 2g, etc)
func (*MemBytes)UnmarshalJSON¶
UnmarshalJSON is the customized unmarshaler for MemBytes
typeNamedListOpts¶
type NamedListOpts struct {ListOpts// contains filtered or unexported fields}NamedListOpts is a ListOpts with a configuration name.This struct is useful to keep reference to the assignedfield name in the internal configuration struct.
funcNewNamedListOptsRef¶
func NewNamedListOptsRef(namestring, values *[]string, validatorValidatorFctType) *NamedListOpts
NewNamedListOptsRef creates a reference to a new NamedListOpts struct.
func (*NamedListOpts)Name¶
func (o *NamedListOpts) Name()string
Name returns the name of the NamedListOpts in the configuration.
typeNamedMapMapOpts¶
type NamedMapMapOpts struct {MapMapOpts// contains filtered or unexported fields}NamedMapMapOpts is a MapMapOpts with a configuration name.This struct is useful to keep reference to the assignedfield name in the internal configuration struct.
funcNewNamedMapMapOpts¶
func NewNamedMapMapOpts(namestring, values map[string]map[string]string, validatorValidatorFctType) *NamedMapMapOpts
NewNamedMapMapOpts creates a reference to a new NamedMapOpts struct.
func (*NamedMapMapOpts)Name¶
func (o *NamedMapMapOpts) Name()string
Name returns the name of the NamedListOpts in the configuration.
typeNamedMapOpts¶
type NamedMapOpts struct {MapOpts// contains filtered or unexported fields}NamedMapOpts is a MapOpts struct with a configuration name.This struct is useful to keep reference to the assignedfield name in the internal configuration struct.
funcNewNamedMapOpts¶
func NewNamedMapOpts(namestring, values map[string]string, validatorValidatorFctType) *NamedMapOpts
NewNamedMapOpts creates a reference to a new NamedMapOpts struct.
func (*NamedMapOpts)Name¶
func (o *NamedMapOpts) Name()string
Name returns the name of the NamedMapOpts in the configuration.
typeNamedOption¶
type NamedOption interface {Name()string}NamedOption is an interface that list and map optionswith names implement.
typeNamedUlimitOpt¶
type NamedUlimitOpt struct {UlimitOpt// contains filtered or unexported fields}NamedUlimitOpt defines a named map of Ulimits
funcNewNamedUlimitOpt¶
func NewNamedUlimitOpt(namestring, ref *map[string]*container.Ulimit) *NamedUlimitOpt
NewNamedUlimitOpt creates a new NamedUlimitOpt
typePoolsOpt¶
type PoolsOpt struct {Values []*ipamutils.NetworkToSplit}PoolsOpt is a Value type for parsing the default address pools definitions
func (*PoolsOpt)UnmarshalJSON¶
UnmarshalJSON fills values structure info from JSON input
func (*PoolsOpt)Value¶
func (p *PoolsOpt) Value() []*ipamutils.NetworkToSplit
Value returns the mounts
typeRuntimeOpt¶
type RuntimeOpt struct {// contains filtered or unexported fields}RuntimeOpt defines a map of Runtimes
funcNewNamedRuntimeOpt¶
NewNamedRuntimeOpt creates a new RuntimeOpt
func (*RuntimeOpt)GetMap¶
func (o *RuntimeOpt) GetMap() map[string]system.Runtime
GetMap returns a map of Runtimes (name: path)
func (*RuntimeOpt)Name¶
func (o *RuntimeOpt) Name()string
Name returns the name of the NamedListOpts in the configuration.
func (*RuntimeOpt)Set¶
func (o *RuntimeOpt) Set(valstring)error
Set validates and updates the list of Runtimes
func (*RuntimeOpt)String¶
func (o *RuntimeOpt) String()string
String returns Runtime values as a string.
typeUlimitOpt¶
type UlimitOpt struct {// contains filtered or unexported fields}UlimitOpt defines a map of Ulimits
funcNewUlimitOpt¶
NewUlimitOpt creates a new UlimitOpt
typeValidatorFctListType¶
ValidatorFctListType defines a validator function that returns a validated list of string and/or an error
typeValidatorFctType¶
ValidatorFctType defines a validator function that returns a validated string and/or an error.
Source Files