yaml

Documentation

Index

• type Build
  • func (b Build) MarshalYAML() (interface{}, error)
  • func (b *Build) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Command
  • func (s *Command) UnmarshalYAML(unmarshal func(interface{}) error) error
• type External
  • func (n External) MarshalYAML() (interface{}, error)
  • func (n *External) UnmarshalYAML(unmarshal func(interface{}) error) error
• type MaporColonSlice
  • func (s *MaporColonSlice) ToMap() map[string]string
  • func (s *MaporColonSlice) UnmarshalYAML(unmarshal func(interface{}) error) error
• type MaporEqualSlice
  • func (s *MaporEqualSlice) ToMap() map[string]string
  • func (s *MaporEqualSlice) UnmarshalYAML(unmarshal func(interface{}) error) error
• type MaporSpaceSlice
  • func (s *MaporSpaceSlice) ToMap() map[string]string
  • func (s *MaporSpaceSlice) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Network
• type Networks
  • func (n Networks) MarshalYAML() (interface{}, error)
  • func (n *Networks) UnmarshalYAML(unmarshal func(interface{}) error) error
• type SliceorMap
  • func (s *SliceorMap) UnmarshalYAML(unmarshal func(interface{}) error) error
• type StringorInt
  • func (s *StringorInt) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Stringorslice
  • func (s *Stringorslice) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Ulimit
  • func NewUlimit(name string, soft int64, hard int64) Ulimit
  • func (u Ulimit) MarshalYAML() (interface{}, error)
• type Ulimits
  • func (u Ulimits) MarshalYAML() (interface{}, error)
  • func (u *Ulimits) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Volume
  • func (v *Volume) String() string
• type Volumes
  • func (v Volumes) MarshalYAML() (interface{}, error)
  • func (v *Volumes) UnmarshalYAML(unmarshal func(interface{}) error) error

Types

type Build

type Build struct {
	Context    string
	Dockerfile string
	Args       map[string]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

func (b Build) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface.

func (*Build) UnmarshalYAML

func (b *Build) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaller interface.

type Command

type Command strslice.StrSlice

Command represents a docker command, can be a string or an array of strings.

func (*Command) UnmarshalYAML

func (s *Command) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaller interface.

type External

type External struct {
	External bool
	Name     string
}

External represents an external network entry in compose file. It can be a boolean (true|false) or have a name

func (External) MarshalYAML

func (n External) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface.

func (*External) UnmarshalYAML

func (n *External) UnmarshalYAML(unmarshal func(interface{}) error) error

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

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

func (n Networks) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface.

func (*Networks) UnmarshalYAML

func (n *Networks) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaller interface.

type SliceorMap

type SliceorMap map[string]string

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

type Stringorslice strslice.StrSlice

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 NewUlimit

func NewUlimit(name string, soft int64, hard int64) Ulimit

NewUlimit creates a Ulimit based on the specified parts.

func (Ulimit) MarshalYAML

func (u Ulimit) MarshalYAML() (interface{}, error)

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

func (u Ulimits) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface.

func (*Ulimits) UnmarshalYAML

func (u *Ulimits) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaller interface.

type Volume

type Volume struct {
	Source      string `yaml:"-"`
	Destination string `yaml:"-"`
	AccessMode  string `yaml:"-"`
}

Volume represent a service volume

func (*Volume) String

func (v *Volume) String() string

String implements the Stringer interface.

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

func (v Volumes) MarshalYAML() (interface{}, error)

MarshalYAML implements the Marshaller interface.

func (*Volumes) UnmarshalYAML

func (v *Volumes) UnmarshalYAML(unmarshal func(interface{}) error) error

UnmarshalYAML implements the Unmarshaller interface.