Interface DockerCompose
public interface DockerCompose
Provides a high-level API to work with Docker compose.
- Since:
- 3.1.0
- Author:
- Moritz Halbritter, Andy Wilkinson, Phillip Webb
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final Duration
Timeout duration used to request a forced stop. -
Method Summary
Modifier and TypeMethodDescriptionvoid
Rundocker compose down
to stop and remove any running services.void
Rundocker compose down
to stop and remove any running services.static DockerCompose
get
(DockerComposeFile file, String hostname, Set<String> activeProfiles) Factory method used to create aDockerCompose
instance.static DockerCompose
Factory method used to create aDockerCompose
instance.Return the running services for the active profile, or an empty list if no services are running.boolean
Return if services have been defined in theDockerComposeFile
for the active profiles.void
Rundocker compose start
to start services.void
Rundocker compose start
to start services.void
Rundocker compose stop
to stop any running services.void
Rundocker compose stop
to stop any running services.void
Rundocker compose up
to create and start services.void
Rundocker compose up
to create and start services.
-
Field Details
-
FORCE_STOP
Timeout duration used to request a forced stop.
-
-
Method Details
-
up
Rundocker compose up
to create and start services. Waits until all contains are started and healthy.- Parameters:
logLevel
- the log level used to report progress
-
up
Rundocker compose up
to create and start services. Waits until all contains are started and healthy.- Parameters:
logLevel
- the log level used to report progressarguments
- the arguments to pass to the up command- Since:
- 3.4.0
-
down
Rundocker compose down
to stop and remove any running services.- Parameters:
timeout
- the amount of time to wait orFORCE_STOP
to stop without waiting.
-
down
Rundocker compose down
to stop and remove any running services.- Parameters:
timeout
- the amount of time to wait orFORCE_STOP
to stop without waiting.arguments
- the arguments to pass to the down command- Since:
- 3.4.0
-
start
Rundocker compose start
to start services. Waits until all containers are started and healthy.- Parameters:
logLevel
- the log level used to report progress
-
start
Rundocker compose start
to start services. Waits until all containers are started and healthy.- Parameters:
logLevel
- the log level used to report progressarguments
- the arguments to pass to the start command- Since:
- 3.4.0
-
stop
Rundocker compose stop
to stop any running services.- Parameters:
timeout
- the amount of time to wait orFORCE_STOP
to stop without waiting.
-
stop
Rundocker compose stop
to stop any running services.- Parameters:
timeout
- the amount of time to wait orFORCE_STOP
to stop without waiting.arguments
- the arguments to pass to the stop command- Since:
- 3.4.0
-
hasDefinedServices
boolean hasDefinedServices()Return if services have been defined in theDockerComposeFile
for the active profiles.- Returns:
true
if services have been defined- See Also:
-
getRunningServices
List<RunningService> getRunningServices()Return the running services for the active profile, or an empty list if no services are running.- Returns:
- the list of running services
-
get
Factory method used to create aDockerCompose
instance.- Parameters:
file
- the Docker Compose filehostname
- the hostname used for services ornull
if the hostname should be deducedactiveProfiles
- a set of the profiles that should be activated- Returns:
- a
DockerCompose
instance
-
get
static DockerCompose get(DockerComposeFile file, String hostname, Set<String> activeProfiles, List<String> arguments) Factory method used to create aDockerCompose
instance.- Parameters:
file
- the Docker Compose filehostname
- the hostname used for services ornull
if the hostname should be deducedactiveProfiles
- a set of the profiles that should be activatedarguments
- the arguments to pass to Docker Compose- Returns:
- a
DockerCompose
instance - Since:
- 3.4.0
-