compose

Documentation

Index

• type Builder
  • func NewBuilder() *Builder
  • func (b *Builder) AddNetwork(n *Network) *Builder
  • func (b *Builder) AddService(s ServiceBuilder) *Builder
  • func (b *Builder) Build() (*Compose, error)
  • func (b *Builder) MustBuild() *Compose
• type Compose
  • func (c *Compose) Run(callback func() error, preserve bool) error
• type HealthCheck
• type IPAM
  • func (i *IPAM) Validate() error
• type IPAMConfig
  • func (c *IPAMConfig) Validate() error
• type Network
  • func (n *Network) Validate() error
• type Service
  • func (s *Service) Service() *Service
  • func (s *Service) Validate() error
• type ServiceBuilder
• type ServiceNetwork

Types

type Builder

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

func NewBuilder

func NewBuilder() *Builder

func (*Builder) AddNetwork

func (b *Builder) AddNetwork(n *Network) *Builder

func (*Builder) AddService

func (b *Builder) AddService(s ServiceBuilder) *Builder

func (*Builder) Build

func (b *Builder) Build() (*Compose, error)

func (*Builder) MustBuild

func (b *Builder) MustBuild() *Compose

type Compose

type Compose struct {
	Path     string              `yaml:"-"`
	Version  string              `yaml:"version"`
	Services map[string]*Service `yaml:"services,omitempty"`
	Networks map[string]*Network `yaml:"networks,omitempty"`
}

func (*Compose) Run

func (c *Compose) Run(callback func() error, preserve bool) error

type HealthCheck

type HealthCheck struct {
	Test []string `yaml:"test,omitempty"`
	// Interval between two health checks, the default is 30 seconds.
	Interval time.Duration `yaml:"interval,omitempty"`
	// The health check command runs the timeout period.
	// If this time is exceeded, the health check is regarded as a failure.
	Timeout time.Duration `yaml:"timeout,omitempty"`
	// When the specified number of consecutive failures, the container status is treated as unhealthy, the default is 3 times.
	Retries uint `yaml:"retries,omitempty"`
	// The number of seconds to start the health check after the container starts, the default is 0 seconds.
	StartPeriod time.Duration `yaml:"start_period,omitempty"`
}

type IPAM

type IPAM struct {
	Config []IPAMConfig `yaml:"config"`
}

func (*IPAM) Validate

func (i *IPAM) Validate() error

type IPAMConfig

type IPAMConfig struct {
	Subnet  string `yaml:"subnet"`
	Gateway string `yaml:"gateway"`
	IPRange string `yaml:"ip_range"`
}

func (*IPAMConfig) Validate

func (c *IPAMConfig) Validate() error

type Network

type Network struct {
	Name   string `yaml:"name"`
	Driver string `yaml:"driver"`
	IPAM   IPAM   `yaml:"ipam"`
}

func (*Network) Validate

func (n *Network) Validate() error

type Service

type Service struct {
	Name        string                    `yaml:"-"`
	Image       string                    `yaml:"image,omitempty"`
	Command     string                    `yaml:"command,omitempty"`
	Environment map[string]string         `yaml:"environment,omitempty"`
	Ports       []string                  `yaml:"ports,omitempty"`
	Volumes     []string                  `yaml:"volumes,omitempty"`
	HealthCheck *HealthCheck              `yaml:"healthcheck,omitempty"`
	Network     map[string]ServiceNetwork `yaml:"networks,omitempty"`
	Privileged  bool                      `yaml:"privileged,omitempty"`
}

func (*Service) Service

func (s *Service) Service() *Service

func (*Service) Validate

func (s *Service) Validate() error

type ServiceBuilder

type ServiceBuilder interface {
	Service() *Service
}

type ServiceNetwork

type ServiceNetwork struct {
	IPv4 string `yaml:"ipv4_address,omitempty"`
}