Package io.quarkus.observability.common.config

Interface ContainerConfig

All Known Subinterfaces:

GrafanaConfig, LgtmConfig

All Known Implementing Classes:

AbstractContainerConfig, AbstractGrafanaConfig

public interface ContainerConfig

Method Summary

Modifier and Type	Method	Description
boolean	enabled()	If DevServices has been explicitly enabled or disabled.
String	imageName()	The container image name to use, for container based DevServices providers.
String	label()	The full name of the label attached to the started container.
Optional<Set<String>>	networkAliases()	Network aliases.
String	serviceName()	The value of the quarkus-dev-service label attached to the started container.
boolean	shared()	Indicates if the container managed by Quarkus Dev Services is shared.

Method Details

enabled

@WithDefault("true")
boolean enabled()

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.

imageName

@ConfigDocIgnore
String imageName()

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.

shared

@WithDefault("true")
boolean shared()

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.

networkAliases

@ConfigDocIgnore
Optional<Set<String>> networkAliases()

Network aliases.

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

label

@ConfigDocIgnore
String label()

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.

serviceName

@WithDefault("quarkus")
String serviceName()

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.