dockercompose

Documentation

Index

• type Compose
  • func NewCompose(compose ComposeConfig) *Compose
  • func (c *Compose) AddNetwork(name string, networkConfig NetworkConfig) *Network
  • func (c *Compose) AddService(name string, serviceConfig ServiceConfig, networks []ServiceNetworkConfig) *Service
  • func (c *Compose) BuildDocker(name, script string) (string, error)
  • func (c *Compose) BuildDockerPath(name, path string) (string, error)
  • func (c *Compose) Clear() error
  • func (c *Compose) Logs(machine ...string) (string, error)
  • func (c *Compose) Start() error
  • func (c *Compose) Stop() error
• type ComposeConfig
• type Network
  • func (n *Network) GetCIDR() (string, error)
• type NetworkConfig
• type Service
  • func (s *Service) Exec(path string, args ...string) exec.Cmd
  • func (s *Service) GetIPAddressForNetwork(network *Network) (string, error)
  • func (s *Service) SetNetworks(serviceNetworksConfig []ServiceNetworkConfig)
  • func (s *Service) SudoExec(path string, args ...string) exec.Cmd
• type ServiceConfig
• type ServiceNetworkConfig

Types

type Compose

type Compose struct {
	ComposeConfig `yaml:",inline"`

	Services map[string]*Service
	Networks map[string]*Network
	// contains filtered or unexported fields
}

func NewCompose

func NewCompose(compose ComposeConfig) *Compose

func (*Compose) AddNetwork

func (c *Compose) AddNetwork(name string, networkConfig NetworkConfig) *Network

func (*Compose) AddService

func (c *Compose) AddService(name string, serviceConfig ServiceConfig, networks []ServiceNetworkConfig) *Service

func (*Compose) BuildDocker

func (c *Compose) BuildDocker(name, script string) (string, error)

func (*Compose) BuildDockerPath

func (c *Compose) BuildDockerPath(name, path string) (string, error)

func (*Compose) Clear

func (c *Compose) Clear() error

func (*Compose) Logs

func (c *Compose) Logs(machine ...string) (string, error)

func (*Compose) Start

func (c *Compose) Start() error

func (*Compose) Stop

func (c *Compose) Stop() error

type ComposeConfig

type ComposeConfig struct {
	Version string
}

type Network

type Network struct {
	NetworkConfig `yaml:",inline"`
	// contains filtered or unexported fields
}

func (*Network) GetCIDR

func (n *Network) GetCIDR() (string, error)

type NetworkConfig

type NetworkConfig struct {
}

type Service

type Service struct {
	ServiceConfig `yaml:",inline"`
	ContainerName string `yaml:"container_name"`

	Networks map[string]ServiceNetworkConfig `yaml:"networks"`
	// contains filtered or unexported fields
}

func (*Service) Exec

func (s *Service) Exec(path string, args ...string) exec.Cmd

func (*Service) GetIPAddressForNetwork

func (s *Service) GetIPAddressForNetwork(network *Network) (string, error)

func (*Service) SetNetworks

func (s *Service) SetNetworks(serviceNetworksConfig []ServiceNetworkConfig)

func (*Service) SudoExec

func (s *Service) SudoExec(path string, args ...string) exec.Cmd

type ServiceConfig

type ServiceConfig struct {
	Image      string
	Command    []string `yaml:"command,omitempty"`
	Privileged bool
}

type ServiceNetworkConfig

type ServiceNetworkConfig struct {
	Network *Network `yaml:"-"`
	Aliases []string `yaml:"aliases,omitempty"`
}