Dev Services for Elasticsearch
If any Elasticsearch-related extension is present
(e.g. quarkus-elasticsearch-rest-client or
quarkus-hibernate-search-orm-elasticsearch), Dev Services for
Elasticsearch automatically starts an Elasticsearch server in dev mode and
when running tests. So, you don’t have to start a server manually. The
application is configured automatically.
Enabling / Disabling Dev Services for Elasticsearch
Dev Services for Elasticsearch is automatically enabled unless:
-
quarkus.devservices.enabledis set tofalse. -
quarkus.elasticsearch.devservices.enabledis set tofalse -
the hosts property is configured, depending on the extension used it can be:
-
quarkus.elasticsearch.hosts -
quarkus.hibernate-search-orm.elasticsearch.hosts
Dev Services for Elasticsearch relies on Docker to start the server. If your environment does not support Docker, you will need to start the server manually, or connect to an already running server.
Shared Elasticsearch
Sometimes you need to share the server between applications. Dev Services for Elasticsearch implements a service discovery mechanism for your multiple Quarkus applications running in dev mode to share a single server.
Dev Services for Elasticsearch starts the container with the
quarkus-dev-service-elasticsearch label which is used to identify the
container.
|
If you need multiple (shared) servers, you can configure the
quarkus.elasticsearch.devservices.service-name attribute and indicate the
server 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 elasticsearch.
Sharing is enabled by default in dev mode, but disabled in test mode. You
can disable the sharing with
quarkus.elasticsearch.devservices.shared=false.
Setting the port
By default, Dev Services for Elasticsearch picks a random port and
configures the application. You can set the port by configuring the
quarkus.elasticsearch.devservices.port property.
Note that the Elasticsearch hosts property is automatically configured with the chosen port.
Configuring the image
Dev Services for Elasticsearch support distributions based on both Elasticsearch and OpenSearch images.
When using Hibernate Search, Dev Services will default to Elasticsearch or OpenSearch based on Hibernate Search configuration.
Otherwise, Dev Services will default to Elasticsearch. To use OpenSearch, configure the distribution explicitly:
quarkus.elasticsearch.devservices.distribution=opensearchIf you need to use a different Elasticsearch or OpenSearch image than the default one you can configure it via:
quarkus.elasticsearch.devservices.image-name=docker.io/elastic/elasticsearch:8.9.1For exotic image names, Quarkus might be unable to infer the distribution
(elastic or opensearch). In these cases starting the Dev Services will
fail, and you will need to configure the distribution explicitly:
quarkus.elasticsearch.devservices.image-name=my-custom-image-with-no-clue-about-the-distribution:1.0
quarkus.elasticsearch.devservices.distribution=elasticsearchCurrent limitations
Currently, only the default backend for Hibernate Search Elasticsearch is supported, because Dev Services for Elasticsearch can only start one Elasticsearch container.
Configuration reference
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|
|---|---|---|
If Dev Services for Elasticsearch has been explicitly enabled or disabled. Dev Services are generally enabled by default, unless there is an existing configuration present. For Elasticsearch, Dev Services starts a server 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 |
|
Defaults to a distribution inferred from the explicitly configured Environment variable: Show more |
|
|
The Elasticsearch container image to use.
Defaults depend on the configured
Environment variable: Show more |
string |
|
The value for the ES_JAVA_OPTS env variable. Defaults to setting the heap to 512MB min - 1GB max. Environment variable: Show more |
string |
|
Indicates if the Elasticsearch server 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 Elasticsearch 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 Elasticsearch servers. Environment variable: Show more |
string |
|
Environment variables that are passed to the container. Environment variable: Show more |
|
