Dev Services for RabbitMQ
Dev Services for RabbitMQ automatically starts a RabbitMQ 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 RabbitMQ
Dev Services for RabbitMQ is automatically enabled unless:
-
quarkus.rabbitmq.devservices.enabledis set tofalse -
the
rabbitmq-hostorrabbitmq-portis configured -
all the Reactive Messaging RabbitMQ channels have the
hostorportattributes set
Dev Services for RabbitMQ relies on Docker to start the broker.
If your environment does not support Docker, you must start the broker manually, or connect to an already running broker.
You can configure the broker access by using the rabbitmq-host, rabbitmq-port, rabbitmq-username and rabbitmq-password properties.
Shared broker
Most of the time you want to share the broker between applications. Dev Services for RabbitMQ implements a service discovery mechanism for your multiple Quarkus applications running in dev mode to share a single broker.
Dev Services for RabbitMQ starts the container with the quarkus-dev-service-rabbitmq label, which is used to identify the container.
|
If you need multiple (shared) brokers, you can configure the quarkus.rabbitmq.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 rabbitmq.
Sharing is enabled by default in dev mode, but disabled in test mode.
You can disable the sharing with quarkus.rabbitmq.devservices.shared=false.
Setting the port
By default, Dev Services for RabbitMQ picks a random port and configures the application.
You can set the port by configuring the quarkus.rabbitmq.devservices.port property.
Configuring the image
Dev Services for RabbitMQ uses official images available at https://hub.docker.com/_/rabbitmq.
You can configure the image and version with the quarkus.rabbitmq.devservices.image-name property:
quarkus.rabbitmq.devservices.image-name=rabbitmq:latestAccess the management UI
By default, Dev Services for RabbitMQ use the official image with the management tag. This means you have the management plugin available. You can use the Dev UI to find the HTTP port randomly affected
or configure a static one by using quarkus.rabbitmq.devservices.http-port.
Predefined topology
Dev Services for RabbitMQ supports defining topology upon broker start. You can define Virtual Hosts, Exchanges, Queues, and Bindings through standard Quarkus configuration.
Defining virtual hosts
RabbitMQ uses a default virtual host of /. To define additional RabbitMQ virtual hosts, provide the names
of the virtual hosts in the quarkus.rabbitmq.devservices.vhosts key:
quarkus.rabbitmq.devservices.vhosts=my-vhost-1,my-vhost-2Defining exchanges
To define a RabbitMQ exchange you provide the exchange’s name after the quarkus.rabbitmq.devservices.exchanges key,
followed by one (or more) of the exchange’s properties:
quarkus.rabbitmq.devservices.exchanges.my-exchange.type=topic # defaults to 'direct'
quarkus.rabbitmq.devservices.exchanges.my-exchange.auto-delete=false # defaults to 'false'
quarkus.rabbitmq.devservices.exchanges.my-exchange.durable=true # defaults to 'false'
quarkus.rabbitmq.devservices.exchanges.my-exchange.vhost=my-vhost # defaults to '/'Additionally, any additional arguments can be provided to the exchange’s definition by using the arguments key:
quarkus.rabbitmq.devservices.exchanges.my-exchange.arguments.alternate-exchange=another-exchangeDefining queues
To define a RabbitMQ queue you provide the queue’s name after the quarkus.rabbitmq.devservices.queues key,
followed by one (or more) of the queue’s properties:
quarkus.rabbitmq.devservices.queues.my-queue.auto-delete=false # defaults to 'false'
quarkus.rabbitmq.devservices.queues.my-queue.durable=true # defaults to 'false'
quarkus.rabbitmq.devservices.queues.my-queue.vhost=my-vhost # defaults to '/'Additionally, any additional arguments can be provided to the queue’s definition by using the arguments key:
quarkus.rabbitmq.devservices.queues.my-queue.arguments.x-dead-letter-exchange=another-exchangeDefining bindings
To define a RabbitMQ binding you provide the binding’s name after the quarkus.rabbitmq.devservices.bindings key,
followed by one (or more) of the binding’s properties:
quarkus.rabbitmq.devservices.bindings.a-binding.source=my-exchange # defaults to name of binding
quarkus.rabbitmq.devservices.bindings.a-binding.routing-key=some-key # defaults to '#'
quarkus.rabbitmq.devservices.bindings.a-binding.destination=my-queue # defaults to name of binding
quarkus.rabbitmq.devservices.bindings.a-binding.destination-type=queue # defaults to 'queue'
quarkus.rabbitmq.devservices.bindings.a-binding.vhost=my-vhost # defaults to '/'| The name of the binding is only used for the purposes of the Dev Services configuration and is not part of the binding defined in RabbitMQ. |
Additionally, any additional arguments can be provided to the binding’s definition by using the arguments key:
quarkus.rabbitmq.devservices.bindings.a-binding.arguments.non-std-option=valueConfiguration reference
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Configuration property |
Type |
Default |
|---|---|---|
If Dev Services for RabbitMQ has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For RabbitMQ, 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 |
|
Optional fixed port for the RabbitMQ management plugin. If not defined, the port will be chosen randomly. Environment variable: Show more |
int |
|
The image to use. Note that only official RabbitMQ images are supported. Specifically, the image repository must end with Environment variable: Show more |
string |
|
Indicates if the RabbitMQ 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 RabbitMQ 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 RabbitMQ brokers. Environment variable: Show more |
string |
|
Type of exchange: direct, topic, headers, fanout, etc. Environment variable: Show more |
string |
|
Should the exchange be deleted when all queues are finished using it? Environment variable: Show more |
boolean |
|
Should the exchange remain after restarts? Environment variable: Show more |
boolean |
|
What virtual host should the exchange be associated with? Environment variable: Show more |
string |
|
Extra arguments for the exchange definition. Environment variable: Show more |
Map<String,String> |
|
Should the queue be deleted when all consumers are finished using it? Environment variable: Show more |
boolean |
|
Should the queue remain after restarts? Environment variable: Show more |
boolean |
|
What virtual host should the queue be associated with? Environment variable: Show more |
string |
|
Extra arguments for the queue definition. Environment variable: Show more |
Map<String,String> |
|
Source exchange to bind to. Defaults to name of binding instance. Environment variable: Show more |
string |
|
Routing key specification for the source exchange. Environment variable: Show more |
string |
|
Destination exchange or queue to bind to. Defaults to name of binding instance. Environment variable: Show more |
string |
|
Destination type for binding: queue, exchange, etc. Environment variable: Show more |
string |
|
What virtual host should the binding be associated with? Environment variable: Show more |
string |
|
Extra arguments for the binding definition. Environment variable: Show more |
Map<String,String> |
|
Virtual hosts that should be predefined after starting the RabbitMQ broker. Environment variable: Show more |
list of string |
|
Environment variables that are passed to the container. Environment variable: Show more |
Map<String,String> |
