opts

package
Version: v0.19.4 Latest Latest
Warning

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

Go to latest
Published: Nov 27, 2015 License: BSD-2-Clause, Apache-2.0 Imports: 10 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source
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"
)
View Source
var DefaultHost = fmt.Sprintf("unix://%s", DefaultUnixSocket)
View Source
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 ParseEnvFile

func ParseEnvFile(filename string) ([]string, error)

ParseEnvFile Read in a line delimited file with environment variables enumerated

func ValidateAttach

func ValidateAttach(val string) (string, error)

ValidateAttach Validates that the specified string is a valid attach option.

func ValidateDNSSearch

func ValidateDNSSearch(val string) (string, error)

ValidateDNSSearch Validates domain for resolvconf search configuration. A zero length domain is represented by .

func ValidateDevice

func ValidateDevice(val string) (string, error)

ValidateDevice Validate a path for devices It will make sure 'val' is in the form:

[host-dir:]container-path[:mode]

func ValidateEnv

func ValidateEnv(val string) (string, error)

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

func ValidateExtraHost(val string) (string, error)

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

func ValidateHost(val string) (string, error)

ValidateHost Validate that the given string is a valid host and returns it

func ValidateIPAddress

func ValidateIPAddress(val string) (string, error)

ValidateIPAddress Validates an Ip address

func ValidateLabel

func ValidateLabel(val string) (string, error)

ValidateLabel Validate that the given string is a valid label, and returns it Labels are in the form on key=value

func ValidateLink(val string) (string, error)

ValidateLink Validates that the specified string has a valid link format (containerName:alias).

func ValidateMACAddress

func ValidateMACAddress(val string) (string, error)

ValidateMACAddress Validates a MAC address

func ValidatePath

func ValidatePath(val string) (string, error)

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 IpOpt

type IpOpt struct {
	*net.IP
}

IpOpt type that hold an IP

func NewIpOpt

func NewIpOpt(ref *net.IP, defaultVal string) *IpOpt

func (*IpOpt) Set

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

func (*IpOpt) String

func (o *IpOpt) String() 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

func NewListOptsRef(values *[]string, validator ValidatorFctType) *ListOpts

func (*ListOpts) Delete

func (opts *ListOpts) Delete(key string)

Delete remove the given element from the slice.

func (*ListOpts) Get

func (opts *ListOpts) Get(key string) bool

Get checks the existence of the given key.

func (*ListOpts) GetAll

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

GetAll returns the values' slice. FIXME: Can we remove this?

func (*ListOpts) GetMap

func (opts *ListOpts) GetMap() map[string]struct{}

GetMap returns the content of values in a map in order to avoid duplicates. FIXME: can we remove this?

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

func (*ListOpts) String

func (opts *ListOpts) String() string

type MapOpts

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

MapOpts type that holds a map of values and a validation function.

func NewMapOpts

func NewMapOpts(values map[string]string, validator ValidatorFctType) *MapOpts

func (*MapOpts) Set

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

func (opts *MapOpts) String() string

type UlimitOpt

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

func NewUlimitOpt

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

func (*UlimitOpt) GetList

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

func (*UlimitOpt) Set

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

func (*UlimitOpt) String

func (o *UlimitOpt) String() string

type ValidatorFctListType

type ValidatorFctListType func(val string) ([]string, error)

ValidatorFctListType validator that return a validate list of string and/or an error

type ValidatorFctType

type ValidatorFctType func(val string) (string, error)

ValidatorFctType validator that return a validate string and/or an error

Jump to

Keyboard shortcuts

? : This menu
/ : Search site
f or F : Jump to
y or Y : Canonical URL