Categorygithub.com/testcontainers/testcontainers-go/modules/compose
modulepackage
0.35.0
Repository: https://github.com/testcontainers/testcontainers-go.git
Documentation: pkg.go.dev

# Functions

No description provided by the author
No description provided by the author
Deprecated: NewLocalDockerCompose returns a DockerCompose compatible instance which is superseded by ComposeStack use NewDockerCompose instead to get a ComposeStack compatible instance NewLocalDockerCompose returns an instance of the local Docker Compose, using an array of Docker Compose file paths and an identifier for the Compose execution.
RunServices is comparable to 'docker compose run' as it only creates a subset of containers instead of all services defined by the project.
WithLogger is a generic option that implements LocalDockerComposeOption It replaces the global Logging implementation with a user defined one e.g.
WithProfiles allows to enable/disable services based on the profiles defined in the compose file.
WithRecreate defines the strategy to apply on existing containers.
WithRecreateDependencies defines the strategy to apply on container dependencies.
No description provided by the author
WithStackReaders supports reading the compose file/s from a reader.

# Constants

RemoveImagesAll - remove all images used by the stack.
RemoveImagesLocal - remove only images that don't have a tag.

# Variables

No description provided by the author

# Structs

No description provided by the author
ExecError is super struct that holds any information about an execution error, so the client code can handle the result.
Deprecated: use ComposeStack instead LocalDockerCompose represents a Docker Compose execution using local binary docker compose or docker.exe compose, depending on the underlying platform.
No description provided by the author

# Interfaces

ComposeStack defines operations that can be applied to a parsed compose stack.
No description provided by the author
No description provided by the author
Deprecated: DockerCompose is the old shell escape based API use ComposeStack instead DockerCompose defines the contract for running Docker Compose.
No description provided by the author
No description provided by the author
No description provided by the author

# Type aliases

No description provided by the author
No description provided by the author
No description provided by the author
Deprecated: will be removed in the next major release IgnoreOrphans - Ignore legacy containers for services that are not defined in the project.
No description provided by the author
Recreate will recreate the containers that are already running.
RecreateDependencies will recreate the dependencies of the services that are already running.
RemoveImages used by services.
RemoveOrphans will clean up containers that are not declared on the compose model but own the same labels.
No description provided by the author
No description provided by the author
Wait won't return until containers reached the running|healthy state.