Dev Services for AMQP
Dev Services for AMQP automatically starts an AMQP 1.0 broker in dev mode and when running tests. So, you don’t have to start a broker manually. The application is configured automatically.
Enabling / Disabling Dev Services for AMQP
Dev Services for AMQP is automatically enabled unless:
-
quarkus.amqp.devservices.enabledis set tofalse -
the
amqp-hostoramqp-portis configured -
all the Reactive Messaging AMQP channels have the
hostorportattributes set
Dev Services for AMQP relies on Docker to start the broker.
If your environment does not support Docker, you will need to start the broker manually, or connect to an already running broker.
You can configure the broker access using the amqp-host, amqp-port, amqp-user and amqp-password properties.
Shared broker
Most of the time you need to share the broker between applications. Dev Services for AMQP implements a service discovery mechanism for your multiple Quarkus applications running in dev mode to share a single broker.
Dev Services for AMQP starts the container with the quarkus-dev-service-amqp label which is used to identify the container.
|
If you need multiple (shared) brokers, you can configure the quarkus.amqp.devservices.service-name attribute and indicate the broker name.
It looks for a container with the same value, or starts a new one if none can be found.
The default service name is amqp.
Sharing is enabled by default in dev mode, but disabled in test mode.
You can disable the sharing with quarkus.amqp.devservices.shared=false.
Setting the port
By default, Dev Services for AMQP picks a random port and configures the application.
You can set the port by configuring the quarkus.amqp.devservices.port property.
Configuring the image
Dev Services for AMQP uses activemq-artemis-broker images.
You can configure the image and version using the quarkus.amqp.devservices.image-name property:
quarkus.amqp.devservices.image-name=quay.io/artemiscloud/activemq-artemis-broker:latest
The configured image must be compatible with the activemq-artemis-broker one.
The container is launched with the AMQ_USER, AMQ_PASSWORD and AMQ_EXTRA_ARGS environment variables.
The ports 5672 and 8161 (web console) are exposed.
|
Configuration reference
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Configuration property |
Type |
Default |
|---|---|---|
If Dev Services for AMQP has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For AMQP, Dev Services starts a broker unless Environment variable: Show more |
boolean |
|
Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: Show more |
int |
|
The image to use. Note that only ActiveMQ Artemis images are supported. Specifically, the image repository must end with Check the activemq-artemis-broker on Quay page to find the available versions. Environment variable: Show more |
string |
|
The value of the Environment variable: Show more |
string |
|
Indicates if the AMQP broker 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 for AMQP starts a new container. The discovery uses the Container sharing is only used in dev mode. Environment variable: Show more |
boolean |
|
The value of the This property is used when you need multiple shared AMQP brokers. Environment variable: Show more |
string |
|
Environment variables that are passed to the container. Environment variable: Show more |
Map<String,String> |
