compose

Documentation

Index

• func BuildAllImages(opts BaseOptions) error
• func CreateNewContainer(opts ImageOptions) error
• func KillAllContainers(opts BaseOptions) (*execplus.CmdPlus, error)
• func KillContainer(opts ImageOptions) error
• func PullAllImages(opts BaseOptions) error
• func RestartContainer(opts ImageOptions) error
• func RunImages(opts ImagesOptions) (*execplus.CmdPlus, error)
• type BaseOptions
• type ImageOptions
• type ImagesOptions

Functions

func BuildAllImages

func BuildAllImages(opts BaseOptions) error

BuildAllImages builds all the docker images defined in docker-compose.yml

func CreateNewContainer

func CreateNewContainer(opts ImageOptions) error

CreateNewContainer creates a new docker container for the given service

func KillAllContainers

func KillAllContainers(opts BaseOptions) (*execplus.CmdPlus, error)

KillAllContainers kills all the containers

func KillContainer

func KillContainer(opts ImageOptions) error

KillContainer kills the docker container of the given service

func PullAllImages

func PullAllImages(opts BaseOptions) error

PullAllImages pulls all the docker images defined in docker-compose.yml

func RestartContainer

func RestartContainer(opts ImageOptions) error

RestartContainer starts the docker container of the given service

func RunImages

func RunImages(opts ImagesOptions) (*execplus.CmdPlus, error)

RunImages runs the given docker images

Types

type BaseOptions

type BaseOptions struct {
	DockerComposeDir string
	Env              []string
	LogChannel       chan string
}

BaseOptions are the options passed into docker compose functions

type ImageOptions

type ImageOptions struct {
	DockerComposeDir string
	Env              []string
	LogChannel       chan string
	ImageName        string
}

ImageOptions is the options to compose functions that deal with a single image

type ImagesOptions

type ImagesOptions struct {
	DockerComposeDir string
	Env              []string
	LogChannel       chan string
	ImageNames       []string
}

ImagesOptions is the options to compose functions that deal with multiple images