compose

Documentation

Index

• func Find(pwd string) string
• func LoadExternalNetworks(file string) ([]string, error)
• func LoadPorts(file string) ([]int, error)
• type Compose
  • func New(user, directory, file string, ports []PortRange, nets []string) *Compose
  • func (c *Compose) AllowedExternalNetworks() error
  • func (c *Compose) AllowedPorts() (int, error)
  • func (c *Compose) Build(args []string) ([]byte, error)
  • func (c *Compose) Down(args []string) ([]byte, error)
  • func (c *Compose) Exec(args []string) ([]byte, error)
  • func (c *Compose) Logs(args []string) ([]byte, error)
  • func (c *Compose) Ps(args []string) ([]byte, error)
  • func (c *Compose) Pull(args []string) ([]byte, error)
  • func (c *Compose) ReStart(args []string) ([]byte, error)
  • func (c *Compose) Start(args []string) ([]byte, error)
  • func (c *Compose) Stop(args []string) ([]byte, error)
  • func (c *Compose) Up(args []string) ([]byte, error)
• type PortRange

Functions

func Find

func Find(pwd string) string

Find finds the first compose* file according the default file names of docker-compose.

func LoadExternalNetworks

func LoadExternalNetworks(file string) ([]string, error)

mayby make it have an io.reader instead, of just the yaml?

func LoadPorts

func LoadPorts(file string) ([]int, error)

Types

type Compose

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

func New

func New(user, directory, file string, ports []PortRange, nets []string) *Compose

New returns a pointer to an intialized Compose.

func (*Compose) AllowedExternalNetworks

func (c *Compose) AllowedExternalNetworks() error

AllowedExternalNetworks returns an error if any of the external networks are not allowed.

func (*Compose) AllowedPorts

func (c *Compose) AllowedPorts() (int, error)

AllowedPorts checks if ports are allowed in the compose file. It returns the first port that is denied, or 0 if they are all OK. Any other error is reported via the returned error.

func (*Compose) Build

func (c *Compose) Build(args []string) ([]byte, error)

func (*Compose) Down

func (c *Compose) Down(args []string) ([]byte, error)

func (*Compose) Exec

func (c *Compose) Exec(args []string) ([]byte, error)

func (*Compose) Logs

func (c *Compose) Logs(args []string) ([]byte, error)

func (*Compose) Ps

func (c *Compose) Ps(args []string) ([]byte, error)

func (*Compose) Pull

func (c *Compose) Pull(args []string) ([]byte, error)

func (*Compose) ReStart

func (c *Compose) ReStart(args []string) ([]byte, error)

func (*Compose) Start

func (c *Compose) Start(args []string) ([]byte, error)

func (*Compose) Stop

func (c *Compose) Stop(args []string) ([]byte, error)

func (*Compose) Up

func (c *Compose) Up(args []string) ([]byte, error)

type PortRange

type PortRange struct {
	Lo int
	Hi int
}