compose

package

v0.29.0 Latest Latest Go to latest Published: Nov 6, 2017 License: MIT Imports: 2 Imported by: 3

Details

Valid go.mod file
Redistributable license
Tagged version
Stable version
Learn more about best practices

Repository

github.com/Originate/exosphere

Links

Open Source Insights

Documentation ¶

Index ¶

func BuildAllImages(opts BaseOptions) error
func BuildImage(opts ImageOptions) error
func KillAllContainers(opts BaseOptions) error
func PullAllImages(opts BaseOptions) error
func PullImage(opts ImageOptions) error
func RunImage(opts ImagesOptions, imageName string) error
func RunImages(opts ImagesOptions) error
type BaseOptions
type ImageOptions
type ImagesOptions

Constants ¶

This section is empty.

Variables ¶

This section is empty.

Functions ¶

func BuildAllImages ¶

func BuildAllImages(opts BaseOptions) error

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

func BuildImage ¶ added in v0.28.1

func BuildImage(opts ImageOptions) error

BuildImage builds the given docker image

func KillAllContainers ¶

func KillAllContainers(opts BaseOptions) error

KillAllContainers kills all the containers

func PullAllImages ¶

func PullAllImages(opts BaseOptions) error

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

func PullImage ¶ added in v0.28.1

func PullImage(opts ImageOptions) error

PullImage builds the given docker image

func RunImage ¶ added in v0.29.0

func RunImage(opts ImagesOptions, imageName string) error

RunImage runs a given image

func RunImages ¶

func RunImages(opts ImagesOptions) error

RunImages runs the given docker images

Types ¶

type BaseOptions ¶

type BaseOptions struct {
	DockerComposeDir      string
	DockerComposeFileName string
	Env                   []string
	Writer                io.Writer
}

BaseOptions are the options passed into docker compose functions

type ImageOptions ¶

type ImageOptions struct {
	DockerComposeDir      string
	DockerComposeFileName string
	Env                   []string
	ImageName             string
	Writer                io.Writer
}

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

type ImagesOptions ¶

type ImagesOptions struct {
	DockerComposeDir      string
	DockerComposeFileName string
	Env                   []string
	ImageNames            []string
	Writer                io.Writer
	AbortOnExit           bool
}

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

Source Files ¶

View all Source files

?	: This menu
/	: Search site
f or F	: Jump to
y or Y	: Canonical URL