Package io.quarkus.observability.common.config

Class AbstractContainerConfig

java.lang.Object
io.quarkus.observability.common.config.AbstractContainerConfig
All Implemented Interfaces:
ContainerConfig
Direct Known Subclasses:
AbstractGrafanaConfig
public abstract class AbstractContainerConfig extends Object implements ContainerConfig

  • Constructor Details

    • AbstractContainerConfig

      public AbstractContainerConfig(String imageName)

    • AbstractContainerConfig

      public AbstractContainerConfig(String imageName, boolean shared)

  • Method Details

    • enabled

      public boolean enabled()
      Description copied from interface: ContainerConfig
      If DevServices has been explicitly enabled or disabled. DevServices is generally enabled by default, unless there is an existing configuration present.

      When DevServices is enabled Quarkus will attempt to automatically configure and start a containers when running in Dev or Test mode and when Docker is running.

      Specified by:
      enabled in interface ContainerConfig

    • imageName

      public String imageName()
      Description copied from interface: ContainerConfig
      The container image name to use, for container based DevServices providers.

      Ignored for the config doc here as a more precise value will be defined in subinterfaces.

      Specified by:
      imageName in interface ContainerConfig

    • shared

      public boolean shared()
      Description copied from interface: ContainerConfig
      Indicates if the container managed by Quarkus Dev Services is shared. When shared, Quarkus looks for running containers using label-based service discovery. If a matching container is found, it is used, and so a second one is not started. Otherwise, Dev Services starts a new container.

      The discovery uses the quarkus-dev-service-label label. The value is configured using the service-name property.

      Container sharing is only used in dev mode.

      Specified by:
      shared in interface ContainerConfig

    • networkAliases

      public Optional<Set<String>> networkAliases()
      Description copied from interface: ContainerConfig
      Network aliases.

      Ignored for the config doc here as a more precise value will be defined in subinterfaces.

      Specified by:
      networkAliases in interface ContainerConfig

    • label

      public String label()
      Description copied from interface: ContainerConfig
      The full name of the label attached to the started container. This label is used when shared is set to true. In this case, before starting a container, Dev Services for looks for a container with th label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with this label set to the specified value.

      This property is used when you need multiple shared containers.

      Ignored for the config doc here as a more precise value will be defined in subinterfaces.

      Specified by:
      label in interface ContainerConfig

    • serviceName

      public String serviceName()
      Description copied from interface: ContainerConfig
      The value of the quarkus-dev-service label attached to the started container. This property is used when shared is set to true. In this case, before starting a container, Dev Services for looks for a container with the quarkus-dev-service label set to the configured value. If found, it will use this container instead of starting a new one. Otherwise, it starts a new container with the quarkus-dev-service label set to the specified value.

      This property is used when you need multiple shared containers.

      Specified by:
      serviceName in interface ContainerConfig