程序包 org.springframework.boot.docker.compose.core

接口 DockerCompose

public interface DockerCompose
Provides a high-level API to work with Docker compose.
从以下版本开始:
3.1.0
作者:
Moritz Halbritter, Andy Wilkinson, Phillip Webb

  • 字段详细资料

    • FORCE_STOP

      static final Duration FORCE_STOP
      Timeout duration used to request a forced stop.

  • 方法详细资料

    • up

      void up(LogLevel logLevel)
      Run docker compose up to create and start services. Waits until all contains are started and healthy.
      参数:
      logLevel - the log level used to report progress

    • up

      void up(LogLevel logLevel, List<String> arguments)
      Run docker compose up to create and start services. Waits until all contains are started and healthy.
      参数:
      logLevel - the log level used to report progress
      arguments - the arguments to pass to the up command
      从以下版本开始:
      3.4.0

    • down

      void down(Duration timeout)
      Run docker compose down to stop and remove any running services.
      参数:
      timeout - the amount of time to wait or FORCE_STOP to stop without waiting.

    • down

      void down(Duration timeout, List<String> arguments)
      Run docker compose down to stop and remove any running services.
      参数:
      timeout - the amount of time to wait or FORCE_STOP to stop without waiting.
      arguments - the arguments to pass to the down command
      从以下版本开始:
      3.4.0

    • start

      void start(LogLevel logLevel)
      Run docker compose start to start services. Waits until all containers are started and healthy.
      参数:
      logLevel - the log level used to report progress

    • start

      void start(LogLevel logLevel, List<String> arguments)
      Run docker compose start to start services. Waits until all containers are started and healthy.
      参数:
      logLevel - the log level used to report progress
      arguments - the arguments to pass to the start command
      从以下版本开始:
      3.4.0

    • stop

      void stop(Duration timeout)
      Run docker compose stop to stop any running services.
      参数:
      timeout - the amount of time to wait or FORCE_STOP to stop without waiting.

    • stop

      void stop(Duration timeout, List<String> arguments)
      Run docker compose stop to stop any running services.
      参数:
      timeout - the amount of time to wait or FORCE_STOP to stop without waiting.
      arguments - the arguments to pass to the stop command
      从以下版本开始:
      3.4.0

    • hasDefinedServices

      boolean hasDefinedServices()
      Return if services have been defined in the DockerComposeFile for the active profiles.
      返回:
      true if services have been defined
      另请参阅:

    • getRunningServices

      List<RunningService> getRunningServices()
      Return the running services for the active profile, or an empty list if no services are running.
      返回:
      the list of running services

    • get

      static DockerCompose get(DockerComposeFile file, String hostname, Set<String> activeProfiles)
      Factory method used to create a DockerCompose instance.
      参数:
      file - the Docker Compose file
      hostname - the hostname used for services or null if the hostname should be deduced
      activeProfiles - a set of the profiles that should be activated
      返回:
      a DockerCompose instance

    • get

      static DockerCompose get(DockerComposeFile file, String hostname, Set<String> activeProfiles, List<String> arguments)
      Factory method used to create a DockerCompose instance.
      参数:
      file - the Docker Compose file
      hostname - the hostname used for services or null if the hostname should be deduced
      activeProfiles - a set of the profiles that should be activated
      arguments - the arguments to pass to Docker Compose
      返回:
      a DockerCompose instance
      从以下版本开始:
      3.4.0