Documentation
¶
Index ¶
Constants ¶
This section is empty.
Variables ¶
This section is empty.
Functions ¶
This section is empty.
Types ¶
type Build ¶
type Build struct {
Context string
Dockerfile string
Args map[string]*string
CacheFrom []*string
Labels map[string]*string
// TODO: ShmSize (can be a string or int?) for v3.5
Target string
// Note: as of Sep 2018 this is undocumented but supported by docker-compose
Network string
}
Build represents a build element in compose file. It can take multiple form in the compose file, hence this special type
func (Build) MarshalYAML ¶
MarshalYAML implements the Marshaller interface.
func (*Build) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type Command ¶
Command represents a docker command, can be a string or an array of strings.
func (*Command) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type External ¶
External represents an external network entry in compose file. It can be a boolean (true|false) or have a name
func (External) MarshalYAML ¶
MarshalYAML implements the Marshaller interface.
func (*External) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type MaporColonSlice ¶
type MaporColonSlice []string
MaporColonSlice represents a slice of strings that gets unmarshal from a YAML map into 'key:value' string.
func (*MaporColonSlice) ToMap ¶
func (s *MaporColonSlice) ToMap() map[string]string
ToMap returns the list of string as a map splitting using = the key=value
func (*MaporColonSlice) UnmarshalYAML ¶
func (s *MaporColonSlice) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type MaporEqualSlice ¶
type MaporEqualSlice []string
MaporEqualSlice represents a slice of strings that gets unmarshal from a YAML map into 'key=value' string.
func (*MaporEqualSlice) ToMap ¶
func (s *MaporEqualSlice) ToMap() map[string]string
ToMap returns the list of string as a map splitting using = the key=value
func (*MaporEqualSlice) UnmarshalYAML ¶
func (s *MaporEqualSlice) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type MaporSpaceSlice ¶
type MaporSpaceSlice []string
MaporSpaceSlice represents a slice of strings that gets unmarshal from a YAML map into 'key value' string.
func (*MaporSpaceSlice) ToMap ¶
func (s *MaporSpaceSlice) ToMap() map[string]string
ToMap returns the list of string as a map splitting using = the key=value
func (*MaporSpaceSlice) UnmarshalYAML ¶
func (s *MaporSpaceSlice) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type MemStringorInt ¶
type MemStringorInt int64
MemStringorInt represents a string or an integer the String supports notations like 10m for then Megabyte of memory
func (*MemStringorInt) UnmarshalYAML ¶
func (s *MemStringorInt) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type Network ¶
type Network struct {
Name string `yaml:"-"`
RealName string `yaml:"-"`
Aliases []string `yaml:"aliases,omitempty"`
IPv4Address string `yaml:"ipv4_address,omitempty"`
IPv6Address string `yaml:"ipv6_address,omitempty"`
}
Network represents a service network in compose file.
func (*Network) HashString ¶
Generate a hash string to detect service network config changes
type Networks ¶
type Networks struct {
Networks []*Network
}
Networks represents a list of service networks in compose file. It has several representation, hence this specific struct.
func (*Networks) HashString ¶
Generate a hash string to detect service network config changes
func (Networks) MarshalYAML ¶
MarshalYAML implements the Marshaller interface.
func (*Networks) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type SliceorMap ¶
SliceorMap represents a slice or a map of strings.
func (*SliceorMap) UnmarshalYAML ¶
func (s *SliceorMap) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type StringorInt ¶
type StringorInt int64
StringorInt represents a string or an integer.
func (*StringorInt) UnmarshalYAML ¶
func (s *StringorInt) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type Stringorslice ¶
Stringorslice represents Using engine-api Strslice and augment it with YAML marshalling stuff. a string or an array of strings.
func (*Stringorslice) UnmarshalYAML ¶
func (s *Stringorslice) UnmarshalYAML(unmarshal func(interface{}) error) error
UnmarshalYAML implements the Unmarshaller interface.
type Ulimit ¶
type Ulimit struct {
Name string
// contains filtered or unexported fields
}
Ulimit represents ulimit information.
func (Ulimit) MarshalYAML ¶
MarshalYAML implements the Marshaller interface.
type Ulimits ¶
type Ulimits struct {
Elements []Ulimit
}
Ulimits represents a list of Ulimit. It is, however, represented in yaml as keys (and thus map in Go)
func (Ulimits) MarshalYAML ¶
MarshalYAML implements the Marshaller interface.
func (*Ulimits) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
type Volume ¶
type Volume struct {
Source string `yaml:"-"`
Destination string `yaml:"-"`
AccessMode string `yaml:"-"`
}
Volume represent a service volume
type Volumes ¶
type Volumes struct {
Volumes []*Volume
}
Volumes represents a list of service volumes in compose file. It has several representation, hence this specific struct.
func (*Volumes) HashString ¶
Generate a hash string to detect service volume config changes
func (Volumes) MarshalYAML ¶
MarshalYAML implements the Marshaller interface.
func (*Volumes) UnmarshalYAML ¶
UnmarshalYAML implements the Unmarshaller interface.
Source Files