runconfig

package
v1.4.2-0...-9ad8752 Latest Latest
Warning

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

 Go to latest Published: Jun 17, 2015 License: Apache-2.0 Imports: 11 Imported by: 0

Documentation

Index

Constants

This section is empty.

Variables

View Source 
var (
	ErrConflictContainerNetworkAndLinks = fmt.Errorf("Conflicting options: --net=container can't be used with links. This would result in undefined behavior")
	ErrConflictNetworkAndDns            = fmt.Errorf("Conflicting options: --dns and the network mode (--net)")
	ErrConflictNetworkHostname          = fmt.Errorf("Conflicting options: -h and the network mode (--net)")
	ErrConflictHostNetworkAndLinks      = fmt.Errorf("Conflicting options: --net=host can't be used with links. This would result in undefined behavior")
	ErrConflictContainerNetworkAndMac   = fmt.Errorf("Conflicting options: --mac-address and the network mode (--net)")
	ErrConflictNetworkHosts             = fmt.Errorf("Conflicting options: --add-host and the network mode (--net)")
	ErrConflictNetworkPublishPorts      = fmt.Errorf("Conflicting options: -p, -P, --publish-all, --publish and the network mode (--net)")
	ErrConflictNetworkExposePorts       = fmt.Errorf("Conflicting options: --expose and the network mode (--expose)")
)

Functions

func Compare 

func Compare(a, b *Config) bool

Compare two Config struct. Do not compare the "Image" nor "Hostname" fields If OpenStdin is set, then it differs

func DecodeContainerConfig 

func DecodeContainerConfig(src io.Reader) (*Config, *HostConfig, error)

DecodeContainerConfig decodes a json encoded config into a ContainerConfigWrapper struct and returns both a Config and an HostConfig struct Be aware this function is not checking whether the resulted structs are nil, it's your business to do so

func Merge 

func Merge(userConf, imageConf *Config) error

func Parse 

func Parse(cmd *flag.FlagSet, args []string) (*Config, *HostConfig, *flag.FlagSet, error)

Types

type Command 

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

func NewCommand 

func NewCommand(parts ...string) *Command

func (*Command) Len 

func (e *Command) Len() int

func (*Command) MarshalJSON 

func (e *Command) MarshalJSON() ([]byte, error)

func (*Command) Slice 

func (e *Command) Slice() []string

func (*Command) ToString 

func (e *Command) ToString() string

func (*Command) UnmarshalJSON 

func (e *Command) UnmarshalJSON(b []byte) error

UnmarshalJSON decoded the entrypoint whether it's a string or an array of strings.

type Config 

type Config struct {
	Hostname        string
	Domainname      string
	User            string
	AttachStdin     bool
	AttachStdout    bool
	AttachStderr    bool
	ExposedPorts    map[nat.Port]struct{}
	Tty             bool // Attach standard streams to a tty, including stdin if it is not closed.
	OpenStdin       bool // Open stdin
	StdinOnce       bool // If true, close stdin after the 1 attached client disconnects.
	Env             []string
	Cmd             *Command
	Image           string // Name of the image as it was passed by the operator (eg. could be symbolic)
	Volumes         map[string]struct{}
	VolumeDriver    string
	WorkingDir      string
	Entrypoint      *Entrypoint
	NetworkDisabled bool
	MacAddress      string
	OnBuild         []string
	Labels          map[string]string
}

Note: the Config structure should hold only portable information about the container. Here, "portable" means "independent from the host we are running on". Non-portable information *should* appear in HostConfig.

type ContainerConfigWrapper 

type ContainerConfigWrapper struct {
	*Config
	// contains filtered or unexported fields
}

func MergeConfigs 

func MergeConfigs(config *Config, hostConfig *HostConfig) *ContainerConfigWrapper

func (ContainerConfigWrapper) GetHostConfig 

func (w ContainerConfigWrapper) GetHostConfig() *HostConfig

func (ContainerConfigWrapper) HostConfig 

func (c ContainerConfigWrapper) HostConfig() *HostConfig

type DeviceMapping 

type DeviceMapping struct {
	PathOnHost        string
	PathInContainer   string
	CgroupPermissions string
}

func ParseDevice 

func ParseDevice(device string) (DeviceMapping, error)

type Entrypoint 

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

Entrypoint encapsulates the container entrypoint. It might be represented as a string or an array of strings. We need to override the json decoder to accept both options. The JSON decoder will fail if the api sends an string and 

we try to decode it into an array of string.

func NewEntrypoint 

func NewEntrypoint(parts ...string) *Entrypoint

func (*Entrypoint) Len 

func (e *Entrypoint) Len() int

func (*Entrypoint) MarshalJSON 

func (e *Entrypoint) MarshalJSON() ([]byte, error)

func (*Entrypoint) Slice 

func (e *Entrypoint) Slice() []string

func (*Entrypoint) UnmarshalJSON 

func (e *Entrypoint) UnmarshalJSON(b []byte) error

UnmarshalJSON decoded the entrypoint whether it's a string or an array of strings.

type ExecConfig 

type ExecConfig struct {
	User         string
	Privileged   bool
	Tty          bool
	Container    string
	AttachStdin  bool
	AttachStderr bool
	AttachStdout bool
	Detach       bool
	Cmd          []string
}

func ParseExec 

func ParseExec(cmd *flag.FlagSet, args []string) (*ExecConfig, error)

type HostConfig 

type HostConfig struct {
	Binds           []string
	ContainerIDFile string
	LxcConf         *LxcConfig
	Memory          int64 // Memory limit (in bytes)
	MemorySwap      int64 // Total memory usage (memory + swap); set `-1` to disable swap
	CpuShares       int64 // CPU shares (relative weight vs. other containers)
	CpuPeriod       int64
	CpusetCpus      string // CpusetCpus 0-2, 0,1
	CpusetMems      string // CpusetMems 0-2, 0,1
	CpuQuota        int64
	BlkioWeight     int64 // Block IO weight (relative weight vs. other containers)
	OomKillDisable  bool  // Whether to disable OOM Killer or not
	Privileged      bool
	PortBindings    nat.PortMap
	Links           []string
	PublishAllPorts bool
	Dns             []string
	DnsSearch       []string
	ExtraHosts      []string
	VolumesFrom     []string
	Devices         []DeviceMapping
	NetworkMode     NetworkMode
	IpcMode         IpcMode
	PidMode         PidMode
	UTSMode         UTSMode
	CapAdd          []string
	CapDrop         []string
	RestartPolicy   RestartPolicy
	SecurityOpt     []string
	ReadonlyRootfs  bool
	Ulimits         []*ulimit.Ulimit
	LogConfig       LogConfig
	CgroupParent    string // Parent cgroup.
}

func DecodeHostConfig 

func DecodeHostConfig(src io.Reader) (*HostConfig, error)

type IpcMode 

type IpcMode string

func (IpcMode) Container 

func (n IpcMode) Container() string

func (IpcMode) IsContainer 

func (n IpcMode) IsContainer() bool

func (IpcMode) IsHost 

func (n IpcMode) IsHost() bool

func (IpcMode) IsPrivate 

func (n IpcMode) IsPrivate() bool

IsPrivate indicates whether container use it's private ipc stack

func (IpcMode) Valid 

func (n IpcMode) Valid() bool

type KeyValuePair 

type KeyValuePair struct {
	Key   string
	Value string
}

type LogConfig 

type LogConfig struct {
	Type   string
	Config map[string]string
}

type LxcConfig 

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

func NewLxcConfig 

func NewLxcConfig(values []KeyValuePair) *LxcConfig

func (*LxcConfig) Len 

func (c *LxcConfig) Len() int

func (*LxcConfig) MarshalJSON 

func (c *LxcConfig) MarshalJSON() ([]byte, error)

func (*LxcConfig) Slice 

func (c *LxcConfig) Slice() []KeyValuePair

func (*LxcConfig) UnmarshalJSON 

func (c *LxcConfig) UnmarshalJSON(b []byte) error

type NetworkMode 

type NetworkMode string

func (NetworkMode) IsBridge 

func (n NetworkMode) IsBridge() bool

func (NetworkMode) IsContainer 

func (n NetworkMode) IsContainer() bool

func (NetworkMode) IsHost 

func (n NetworkMode) IsHost() bool

func (NetworkMode) IsNone 

func (n NetworkMode) IsNone() bool

func (NetworkMode) IsPrivate 

func (n NetworkMode) IsPrivate() bool

IsPrivate indicates whether container use it's private network stack

type PidMode 

type PidMode string

func (PidMode) IsHost 

func (n PidMode) IsHost() bool

func (PidMode) IsPrivate 

func (n PidMode) IsPrivate() bool

IsPrivate indicates whether container use it's private pid stack

func (PidMode) Valid 

func (n PidMode) Valid() bool

type RestartPolicy 

type RestartPolicy struct {
	Name              string
	MaximumRetryCount int
}

func ParseRestartPolicy 

func ParseRestartPolicy(policy string) (RestartPolicy, error)

ParseRestartPolicy returns the parsed policy or an error indicating what is incorrect

func (*RestartPolicy) IsAlways 

func (rp *RestartPolicy) IsAlways() bool

func (*RestartPolicy) IsNone 

func (rp *RestartPolicy) IsNone() bool

func (*RestartPolicy) IsOnFailure 

func (rp *RestartPolicy) IsOnFailure() bool

type UTSMode 

type UTSMode string

func (UTSMode) IsHost 

func (n UTSMode) IsHost() bool

func (UTSMode) IsPrivate 

func (n UTSMode) IsPrivate() bool

IsPrivate indicates whether container use it's private UTS namespace

func (UTSMode) Valid 

func (n UTSMode) Valid() bool

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.