compose

Documentation

Index

• func Find(pwd string) string
• type Compose
  • func New(name, user, directory, file, datadirectory string, registries []string, ...) *Compose
  • func (c *Compose) AllowedExternalNetworks() error
  • func (c *Compose) AllowedVolumes() error
  • func (c *Compose) Disallow() error
  • func (c *Compose) Down(args []string) ([]byte, error)
  • func (c *Compose) Exec(args []string) ([]byte, error)
  • func (c *Compose) Extension() *Extension
  • func (c *Compose) Load(args []string) ([]byte, error)
  • func (c *Compose) Login(login string) 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 Extension

Functions

func Find

func Find(pwd string) string

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

Types

type Compose

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

func New

func New(name, user, directory, file, datadirectory string, registries []string, nets, env []string, mount 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) AllowedVolumes

func (c *Compose) AllowedVolumes() error

AllowedVolumes returns an error if any of the volumes reference a directory outside of c.datadir

func (*Compose) Disallow

func (c *Compose) Disallow() error

Disallow parses the compose yaml, and disallows privileged=true, networkmode="host" and ipc="host" It also checks for 'ports' statements as those are _also_ disallowed.

func (*Compose) Down

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

func (*Compose) Exec

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

func (*Compose) Extension

func (c *Compose) Extension() *Extension

func (*Compose) Load

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

Load loads the compose files and returns any errors.

func (*Compose) Login

func (c *Compose) Login(login string) 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 Extension

type Extension struct {
	Reload bool
}

Extension contains the fields of the PGO extensions in the docker compose file.