libstack

README

Docker-Compose wrapper

This library is a wrapper around the docker-compose v2 plugin.

It currently runs docker-compose directly and not via the docker command. Therefore it is installed alongside the other binaries and not to the cli-plugins directory.

Documentation

Index

• type DeployOptions
• type Deployer
• type Options

Types

type DeployOptions

type DeployOptions struct {
	Options
	ForceRecreate bool
	// AbortOnContainerExit will stop the deployment if a container exits.
	// This is useful when running a onetime task.
	//
	// When this is set, docker compose will output its logs to stdout
	AbortOnContainerExit bool ``
}

type Deployer

type Deployer interface {
	Deploy(ctx context.Context, filePaths []string, options DeployOptions) error
	// Remove stops and removes containers
	//
	// projectName or filePaths are required
	// if projectName is supplied filePaths will be ignored
	Remove(ctx context.Context, projectName string, filePaths []string, options Options) error
	Pull(ctx context.Context, filePaths []string, options Options) error
	Validate(ctx context.Context, filePaths []string, options Options) error
}

type Options

type Options struct {
	WorkingDir  string
	Host        string
	ProjectName string
	// EnvFilePath is the path to a .env file
	EnvFilePath string
	// Env is a list of environment variables to pass to the command, example: "FOO=bar"
	Env []string
}