opts

package
v20.10.0+incompatible Latest Latest
Warning

This package is not in the latest version of its module.

 Go to latest Published: Dec 7, 2020 License: Apache-2.0 Imports: 16 Imported by: 0

Documentation

Index

Constants

View Source 
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
	// 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 = "tcp://" + DefaultHTTPHost + ":2375"
	// DefaultTLSHost constant defines the default host string used by docker for TLS sockets
	DefaultTLSHost = "tcp://" + DefaultHTTPHost + ":2376"
	// DefaultNamedPipe defines the default named pipe used by docker on Windows
	DefaultNamedPipe = `//./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 value
	HostGatewayName = "host-gateway"
)
View Source 
const (
	// DefaultHTTPHost Default HTTP Host used if only port is provided to -H flag e.g. dockerd -H tcp://:8080
	DefaultHTTPHost = "localhost"

	// DefaultHost constant defines the default host string used by docker on other hosts than Windows
	DefaultHost = "unix://" + DefaultUnixSocket
)

Variables

This section is empty.

Functions

func ParseHost added in v1.9.0 

func ParseHost(defaultToTLS, defaultToUnixXDG bool, val string) (string, error)

ParseHost and set defaults for a Daemon host string. defaultToTLS is preferred over defaultToUnixXDG. 

func ParseLink(val string) (string, string, error)

ParseLink parses and validates the specified string as a link format (name:alias)

func ParseTCPAddr added in v1.12.0 

func ParseTCPAddr(tryAddr string, defaultAddr string) (string, error)

ParseTCPAddr parses and validates that the specified address is a valid TCP address. It returns a formatted TCP address, either using the address parsed from tryAddr, or the contents of defaultAddr if tryAddr is a blank string. tryAddr is expected to have already been Trim()'d defaultAddr must be in the full `tcp://host:port` form

func ValidateDNSSearch added in v1.8.0 

func ValidateDNSSearch(val string) (string, error)

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

func ValidateEnv 

func ValidateEnv(val string) (string, error)

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 names are not validate whatsoever, it's up to application inside docker to validate them or not.

The only validation here is to check if name is empty, per #25099

func ValidateExtraHost added in v1.3.0 

func ValidateExtraHost(val string) (string, error)

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).

func ValidateHost added in v1.7.0 

func ValidateHost(val string) (string, error)

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

func ValidateIPAddress added in v1.2.0 

func ValidateIPAddress(val string) (string, error)

ValidateIPAddress validates an Ip address.

func ValidateLabel added in v1.4.0 

func ValidateLabel(val string) (string, error)

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.

func ValidateSingleGenericResource 

func ValidateSingleGenericResource(val string) (string, error)

ValidateSingleGenericResource validates that a single entry in the generic resource list is valid. i.e 'GPU=UID1' is valid however 'GPU:UID1' or 'UID1' isn't

Types

type IPOpt added in v1.9.0 

type IPOpt struct {
	*net.IP
}

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

func NewIPOpt added in v1.9.0 

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 added in v1.9.0 

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 added in v1.9.0 

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.

func (*IPOpt) Type added in v1.13.0 

func (o *IPOpt) Type() string

Type returns the type of the option

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 added in v1.8.0 

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) GetAllOrEmpty added in v1.9.1 

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

GetAllOrEmpty returns the values of the slice or an empty slice when there are no values.

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 adds it to the internal slice.

func (*ListOpts) String 

func (opts *ListOpts) String() string

func (*ListOpts) Type added in v1.12.0 

func (opts *ListOpts) Type() string

Type returns a string name for this Option type

func (*ListOpts) WithValidator 

func (opts *ListOpts) WithValidator(validator ValidatorFctType) *ListOpts

WithValidator returns the ListOpts with validator set.

type MapOpts added in v1.7.0 

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

MapOpts holds a map of values and a validation function.

func NewMapOpts added in v1.8.0 

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 added in v1.9.0 

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

GetAll returns the values of MapOpts as a map.

func (*MapOpts) Set added in v1.7.0 

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 added in v1.7.0 

func (opts *MapOpts) String() string

func (*MapOpts) Type added in v1.12.0 

func (opts *MapOpts) Type() string

Type returns a string name for this Option type

type MemBytes 

type MemBytes int64

MemBytes is a type for human readable memory bytes (like 128M, 2g, etc)

func (*MemBytes) Set 

func (m *MemBytes) Set(value string) error

Set sets the value of the MemBytes by passing a string

func (*MemBytes) String 

func (m *MemBytes) String() string

String returns the string format of the human readable memory bytes

func (*MemBytes) Type 

func (m *MemBytes) Type() string

Type returns the type

func (*MemBytes) UnmarshalJSON 

func (m *MemBytes) UnmarshalJSON(s []byte) error

UnmarshalJSON is the customized unmarshaler for MemBytes

func (*MemBytes) Value 

func (m *MemBytes) Value() int64

Value returns the value in int64

type NamedListOpts added in v1.10.0 

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 assigned field name in the internal configuration struct.

func NewNamedListOptsRef added in v1.10.0 

func NewNamedListOptsRef(name string, values *[]string, validator ValidatorFctType) *NamedListOpts

NewNamedListOptsRef creates a reference to a new NamedListOpts struct.

func (*NamedListOpts) Name added in v1.10.0 

func (o *NamedListOpts) Name() string

Name returns the name of the NamedListOpts in the configuration.

type NamedMapOpts added in v1.10.0 

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 assigned field name in the internal configuration struct.

func NewNamedMapOpts added in v1.10.0 

func NewNamedMapOpts(name string, values map[string]string, validator ValidatorFctType) *NamedMapOpts

NewNamedMapOpts creates a reference to a new NamedMapOpts struct.

func (*NamedMapOpts) Name added in v1.10.0 

func (o *NamedMapOpts) Name() string

Name returns the name of the NamedMapOpts in the configuration.

type NamedOption added in v1.10.0 

type NamedOption interface {
	Name() string
}

NamedOption is an interface that list and map options with names implement.

type NamedUlimitOpt 

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

NamedUlimitOpt defines a named map of Ulimits

func NewNamedUlimitOpt 

func NewNamedUlimitOpt(name string, ref *map[string]*units.Ulimit) *NamedUlimitOpt

NewNamedUlimitOpt creates a new NamedUlimitOpt

func (*NamedUlimitOpt) Name 

func (o *NamedUlimitOpt) Name() string

Name returns the option name

type PoolsOpt 

type PoolsOpt struct {
	Values []*types.NetworkToSplit
}

PoolsOpt is a Value type for parsing the default address pools definitions

func (*PoolsOpt) Name 

func (p *PoolsOpt) Name() string

Name returns the flag name of this option

func (*PoolsOpt) Set 

func (p *PoolsOpt) Set(value string) error

Set predefined pools

func (*PoolsOpt) String 

func (p *PoolsOpt) String() string

String returns a string repr of this option

func (*PoolsOpt) Type 

func (p *PoolsOpt) Type() string

Type returns the type of this option

func (*PoolsOpt) UnmarshalJSON 

func (p *PoolsOpt) UnmarshalJSON(raw []byte) error

UnmarshalJSON fills values structure info from JSON input

func (*PoolsOpt) Value 

func (p *PoolsOpt) Value() []*types.NetworkToSplit

Value returns the mounts

type QuotedString added in v1.13.0 

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

QuotedString is a string that may have extra quotes around the value. The quotes are stripped from the value.

func NewQuotedString added in v1.13.0 

func NewQuotedString(value *string) *QuotedString

NewQuotedString returns a new quoted string option

func (*QuotedString) Set added in v1.13.0 

func (s *QuotedString) Set(val string) error

Set sets a new value

func (*QuotedString) String added in v1.13.0 

func (s *QuotedString) String() string

func (*QuotedString) Type added in v1.13.0 

func (s *QuotedString) Type() string

Type returns the type of the value

type RuntimeOpt 

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

RuntimeOpt defines a map of Runtimes

func NewNamedRuntimeOpt 

func NewNamedRuntimeOpt(name string, ref *map[string]types.Runtime, stockRuntime string) *RuntimeOpt

NewNamedRuntimeOpt creates a new RuntimeOpt

func (*RuntimeOpt) GetMap 

func (o *RuntimeOpt) GetMap() map[string]types.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(val string) error

Set validates and updates the list of Runtimes

func (*RuntimeOpt) String 

func (o *RuntimeOpt) String() string

String returns Runtime values as a string.

func (*RuntimeOpt) Type 

func (o *RuntimeOpt) Type() string

Type returns the type of the option

type UlimitOpt added in v1.6.0 

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

UlimitOpt defines a map of Ulimits

func NewUlimitOpt added in v1.6.0 

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

NewUlimitOpt creates a new UlimitOpt

func (*UlimitOpt) GetList added in v1.6.0 

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

GetList returns a slice of pointers to Ulimits.

func (*UlimitOpt) Set added in v1.6.0 

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

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

func (*UlimitOpt) String added in v1.6.0 

func (o *UlimitOpt) String() string

String returns Ulimit values as a string.

func (*UlimitOpt) Type 

func (o *UlimitOpt) Type() string

Type returns the option type

type ValidatorFctListType added in v1.5.0 

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.

Source Files

View all Source files

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL
go.dev uses cookies from Google to deliver and enhance the quality of its services and to analyze traffic. Learn more.