docker_compose

Documentation

Index

• func CheckError(err error)
• type Aliases
• type Build
  • func (b *Build) UnmarshalYAML(unmarshal func(interface{}) error) error
• type BuildAux
• type Command
  • func (c *Command) UnmarshalYAML(unmarshal func(interface{}) error) error
• type CpusMem
• type Deploy
• type Dns
  • func (c *Dns) UnmarshalYAML(unmarshal func(interface{}) error) error
• type DnsSearch
  • func (c *DnsSearch) UnmarshalYAML(unmarshal func(interface{}) error) error
• type DockerCompose
  • func (d DockerCompose) MarshalToFile(path string) error
  • func (d *DockerCompose) UnmarshalFromFile(path string) error
• type Entrypoint
  • func (c *Entrypoint) UnmarshalYAML(unmarshal func(interface{}) error) error
• type EnvFile
  • func (ef *EnvFile) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Environment
  • func (e *Environment) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Healthcheck
• type Limits
  • func (s *Limits) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Logging
• type Networks
• type Placement
• type Port
• type Ports
  • func (p *Ports) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Resources
• type RestartPolicy
• type Secret
• type Secrets
  • func (s *Secrets) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Service
• type Tmpfs
  • func (c *Tmpfs) UnmarshalYAML(unmarshal func(interface{}) error) error
• type Ulimits
• type UpdateConfig
• type Volume
• type Volumes
  • func (v *Volumes) UnmarshalYAML(unmarshal func(interface{}) error) error

Functions

func CheckError

func CheckError(err error)

Types

type Aliases

type Aliases struct {
	Aliases []string `yaml:"aliases,omitempty"`
}

type Build

type Build struct {
	Context    string            `yaml:"context,omitempty"`
	Dockerfile string            `yaml:"dockerfile,omitempty"`
	Args       map[string]string `yaml:"args,omitempty"`
	CacheFrom  []string          `yaml:"cache_from,omitempty"`
	Labels     []string          `yaml:"labels,omitempty"`
}

func (*Build) UnmarshalYAML

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

type BuildAux

type BuildAux struct {
	Context    string            `yaml:"context,omitempty"`
	Dockerfile string            `yaml:"dockerfile,omitempty"`
	Args       map[string]string `yaml:"args,omitempty"`
	CacheFrom  []string          `yaml:"cache_from,omitempty"`
	Labels     []string          `yaml:"labels,omitempty"`
}

type Command

type Command []string

func (*Command) UnmarshalYAML

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

type CpusMem

type CpusMem struct {
	Cpus   string `yaml:"cpus,omitempty"`
	Memory string `yaml:"memory,omitempty"`
}

type Deploy

type Deploy struct {
	Replicas      int               `yaml:"replicas,omitempty"`
	UpdateConfig  UpdateConfig      `yaml:"update_config,omitempty"`
	RestartPolicy RestartPolicy     `yaml:"restart_policy,omitempty"`
	Mode          string            `yaml:"mode,omitempty"`
	Placement     Placement         `yaml:"placement,omitempty"`
	Resources     Resources         `yaml:"resources,omitempty"`
	Labels        map[string]string `yaml:"labels,omitempty"`
}

type Dns

type Dns []string

func (*Dns) UnmarshalYAML

func (c *Dns) UnmarshalYAML(unmarshal func(interface{}) error) error

type DnsSearch

type DnsSearch []string

func (*DnsSearch) UnmarshalYAML

func (c *DnsSearch) UnmarshalYAML(unmarshal func(interface{}) error) error

type DockerCompose

type DockerCompose struct {
	Services map[string]Service
	Version  string
}

func (DockerCompose) MarshalToFile

func (d DockerCompose) MarshalToFile(path string) error

func (*DockerCompose) UnmarshalFromFile

func (d *DockerCompose) UnmarshalFromFile(path string) error

type Entrypoint

type Entrypoint []string

func (*Entrypoint) UnmarshalYAML

func (c *Entrypoint) UnmarshalYAML(unmarshal func(interface{}) error) error

type EnvFile

type EnvFile []string

func (*EnvFile) UnmarshalYAML

func (ef *EnvFile) UnmarshalYAML(unmarshal func(interface{}) error) error

type Environment

type Environment map[string]string

func (*Environment) UnmarshalYAML

func (e *Environment) UnmarshalYAML(unmarshal func(interface{}) error) error

type Healthcheck

type Healthcheck struct {
	Test     []string
	Interval string
	Timeout  string
	Retries  string
	Disable  bool
}

type Limits

type Limits struct {
	Soft int
	Hard int
}

func (*Limits) UnmarshalYAML

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

type Logging

type Logging struct {
	Driver  string            `yaml:"driver,omitempty"`
	Options map[string]string `yaml:"options,omitempty"`
}

type Networks

type Networks struct {
	ShortSyntax []string
	Aliases     map[string]Aliases
}

type Placement

type Placement struct {
	Constraints []string
}

type Port

type Port struct {
	Target    int    `yaml:"target,omitempty"`
	Published int    `yaml:"published,omitempty"`
	Protocol  string `yaml:"protocol,omitempty"`
	Mode      string `yaml:"mode,omitempty"`
}

type Ports

type Ports []Port

func (*Ports) UnmarshalYAML

func (p *Ports) UnmarshalYAML(unmarshal func(interface{}) error) error

type Resources

type Resources struct {
	Limits       CpusMem `yaml:"limits,omitempty"`
	Reservations CpusMem `yaml:reservations",omitempty"`
}

type RestartPolicy

type RestartPolicy struct {
	Condition   string `yaml:"condition,omitempty"`
	Delay       string `yaml:"delay,omitempty"`
	MaxAttempts int    `yaml:"max_attempts,omitempty"`
	Window      string `yaml:"window,omitempty"`
}

type Secret

type Secret struct {
	Source string `yaml:"source,omitempty"`
	Target string `yaml:"target,omitempty"`
	Uid    string `yaml:"uid,omitempty"`
	Gid    string `yaml:"gid,omitempty"`
	Mode   string `yaml:"mode,omitempty"`
}

type Secrets

type Secrets []Secret

func (*Secrets) UnmarshalYAML

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

type Service

type Service struct {
	Command           Command           `yaml:"command,omitempty"`
	Ports             Ports             `yaml:"ports,omitempty"`
	Build             Build             `yaml:"build,omitempty"`
	Image             string            `yaml:"image,omitempty"`
	Depends_on        []string          `yaml:"depends_on,omitempty"`
	Environment       Environment       `yaml:"environment,omitempty"`
	Deploy            Deploy            `yaml:"deploy,omitempty"`
	Volumes           Volumes           `yaml:"volumes,omitempty"`
	Stop_grace_period string            `yaml:"stop_grace_period,omitempty"`
	Working_dir       string            `yaml:"working_dir,omitempty"`
	Privileged        bool              `yaml:"privileged,omitempty"`
	Labels            map[string]string `yaml:"labels,omitempty"`
	Expose            []int             `yaml:"expose,omitempty"`
	EnvFile           EnvFile           `yaml:"env_file,omitempty"`
	CpuShares         int               `yaml:"cpu_shares,omitempty"`
	MemLimit          string            `yaml:"mem_limit,omitempty"`
	Links             []string          `yaml:"links,omitempty"`
	CapAdd            []string          `yaml:"cap_add,omitempty"`
	CapDrop           []string          `yaml:"cap_drop,omitempty"`
	Logging           Logging           `yaml:"logging,omitempty"`
	CgroupParent      string            `yaml:"cgroup_parent,omitempty"`
	ContainerName     string            `yaml:"container_name,omitempty"`
	Devices           []string          `yaml:"devices,omitempty"`
	Dns               Dns               `yaml:"dns,omitempty"`
	DnsSearch         DnsSearch         `yaml:"dns_search,omitempty"`
	Entrypoint        Entrypoint        `yaml:"entrypoint,omitempty"`
	ExternalLinks     []string          `yaml:"external_links,omitempty"`
	ExtraHosts        []string          `yaml:"extra_hosts,omitempty"`
	Isolation         string            `yaml:"isolation,omitempty"`
	Networks          Networks          `yaml:"networks,omitempty"`
	Pid               string            `yaml:"pid,omitempty"`
	Secrets           Secrets           `yaml:"secrets,omitempty"`
	SecurityOpt       []string          `yaml:"security_opt,omitempty"`
	StopSignal        string            `yaml:"stop_signal,omitempty"`
	Sysctls           map[string]string `yaml:"sysctls,omitempty"`
	Tmpfs             Tmpfs             `yaml:"tmpfs,omitempty"`
	UsernsMode        string            `yaml:"userns_mode,omitempty"`
	Ulimits           Ulimits           `yaml:"ulimits,omitempty"`
	Healthcheck       Healthcheck       `yaml:"healthcheck,omitempty"`
}

type Tmpfs

type Tmpfs []string

func (*Tmpfs) UnmarshalYAML

func (c *Tmpfs) UnmarshalYAML(unmarshal func(interface{}) error) error

type Ulimits

type Ulimits struct {
	Nproc  Limits
	Nofile Limits
}

type UpdateConfig

type UpdateConfig struct {
	Parallelism int
	Delay       string
}

type Volume

type Volume struct {
	Type     string `yaml:"type,omitempty"`
	Source   string `yaml:"source,omitempty"`
	Target   string `yaml:"target,omitempty"`
	ReadOnly bool   `yaml:"read_only,omitempty"`
}

type Volumes

type Volumes []Volume

func (*Volumes) UnmarshalYAML

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