Package io.quarkus.deployment.dev.devservices

Interface ComposeDevServicesBuildTimeConfig

public interface ComposeDevServicesBuildTimeConfig

  • Method Details

    • enabled

      @WithDefault("true") boolean enabled()
      Compose dev service enabled or disabled

    • files

      Optional<List<String>> files()
      List of file paths relative to the project root for Compose dev service configuration, if not provided will look for compose files in the project root

    • projectName

      Optional<String> projectName()
      Name of the compose project, used to discover running containers, if not provided a project name will be generated

    • profiles

      Optional<List<String>> profiles()
      Compose profiles to activate

    • options

      Optional<List<String>> options()
      List of additional options to pass to compose command

    • startServices

      @WithDefault("true") boolean startServices()
      Whether to run compose up and start containers at startup, when disabled, services are discovered by project name

    • stopServices

      @WithDefault("true") boolean stopServices()
      Whether to run compose down and stop containers at shutdown

    • ryukEnabled

      @WithDefault("true") boolean ryukEnabled()
      Whether to use test containers Ryuk resource reaper to clean up containers

    • removeVolumes

      @WithDefault("true") boolean removeVolumes()
      Whether to remove volumes on compose down

    • removeImages

      Optional<ComposeDevServicesBuildTimeConfig.RemoveImages> removeImages()
      Which images to remove on compose down

      Locally built images, without custom tags are removed by default.

    • envVariables

      Map<String,String> envVariables()
      Env variables to pass to all Compose instances

    • scale

      Map<String,Integer> scale()
      Scale configuration for services: Configure the number of instances for specific services

    • followContainerLogs

      @WithDefault("false") boolean followContainerLogs()
      Whether to tail container logs to the console

    • build

      Optional<Boolean> build()
      Whether to build images before starting containers.

      When not provided, Compose images are built per-service `pull-policy`. When `true`, forces build of all images before starting containers. When `false`, skips re-building images before starting containers.

    • reuseProjectForTests

      @WithDefault("false") boolean reuseProjectForTests()
      Whether to reuse the project for tests, when disabled, a new project is created for each test run

    • stopTimeout

      @WithDefault("1s") Duration stopTimeout()
      Timeout for stopping services, after the timeout the services are forcefully stopped,