By Version

Servicios de desarrollo para 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.

Activación/desactivación de los servicios de desarrollo para Elasticsearch

Los servicios de desarrollo para Elasticsearch se activan automáticamente a menos que:

quarkus.devservices.enabled se fija en false.
quarkus.elasticsearch.devservices.enabled se ajusta a false
la propiedad hosts está configurada, dependiendo de la extensión utilizada puede ser:
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.

Elasticsearch compartido

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 inicia el contenedor con la etiqueta quarkus-dev-service-elasticsearch que se utiliza para identificar el contenedor.

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.

Ajuste del puerto

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.

Tenga en cuenta que la propiedad de hosts de Elasticsearch se configura automáticamente con el puerto elegido.

Configuración de la imagen

Dev Services for Elasticsearch only support Elasticsearch based images, OpenSearch is not supported at the moment.

If you need to use a different image than the default one you can configure it via:

quarkus.elasticsearch.devservices.image-name={elasticsearch-image}

Limitaciones actuales

Actualmente, sólo se admite el backend predeterminado para Hibernate Search Elasticsearch, porque Dev Services for Elasticsearch sólo puede iniciar un contenedor de Elasticsearch.

Referencia de configuración

Configuration property fixed at build time - All other configuration properties are overridable at runtime

Configuration property	Tipo	Por defecto
`quarkus.elasticsearch.devservices.enabled` 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 `quarkus.elasticsearch.hosts` is set. Environment variable: `QUARKUS_ELASTICSEARCH_DEVSERVICES_ENABLED` Show more	boolean
`quarkus.elasticsearch.devservices.port` Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly. Environment variable: `QUARKUS_ELASTICSEARCH_DEVSERVICES_PORT` Show more	int
`quarkus.elasticsearch.devservices.image-name` The Elasticsearch container image to use. Defaults to the elasticsearch image provided by Elastic. Environment variable: `QUARKUS_ELASTICSEARCH_DEVSERVICES_IMAGE_NAME` Show more	string	`docker.elastic.co/elasticsearch/elasticsearch:7.17.0`
`quarkus.elasticsearch.devservices.java-opts` The value for the ES_JAVA_OPTS env variable. Defaults to setting the heap to 512MB min - 1GB max. Environment variable: `QUARKUS_ELASTICSEARCH_DEVSERVICES_JAVA_OPTS` Show more	string	`-Xms512m -Xmx1g`
`quarkus.elasticsearch.devservices.shared` 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 `quarkus-dev-service-elasticsearch` label. The value is configured using the `service-name` property. Container sharing is only used in dev mode. Environment variable: `QUARKUS_ELASTICSEARCH_DEVSERVICES_SHARED` Show more	boolean	`true`
`quarkus.elasticsearch.devservices.service-name` The value of the `quarkus-dev-service-elasticsearch` 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 Elasticsearch looks for a container with the `quarkus-dev-service-elasticsearch` 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-elasticsearch` label set to the specified value. This property is used when you need multiple shared Elasticsearch servers. Environment variable: `QUARKUS_ELASTICSEARCH_DEVSERVICES_SERVICE_NAME` Show more	string	`elasticsearch`

Configuration property

Tipo

Por defecto

quarkus.elasticsearch.devservices.enabled

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 quarkus.elasticsearch.hosts is set.

Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_ENABLED

boolean

quarkus.elasticsearch.devservices.port

Optional fixed port the dev service will listen to. If not defined, the port will be chosen randomly.

Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_PORT

int

quarkus.elasticsearch.devservices.image-name

The Elasticsearch container image to use. Defaults to the elasticsearch image provided by Elastic.

Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_IMAGE_NAME

string

docker.elastic.co/elasticsearch/elasticsearch:7.17.0

quarkus.elasticsearch.devservices.java-opts

The value for the ES_JAVA_OPTS env variable. Defaults to setting the heap to 512MB min - 1GB max.

Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_JAVA_OPTS

string

-Xms512m -Xmx1g

quarkus.elasticsearch.devservices.shared

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 quarkus-dev-service-elasticsearch label. The value is configured using the service-name property. Container sharing is only used in dev mode.

Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_SHARED

boolean

true

quarkus.elasticsearch.devservices.service-name

The value of the quarkus-dev-service-elasticsearch 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 Elasticsearch looks for a container with the quarkus-dev-service-elasticsearch 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-elasticsearch label set to the specified value. This property is used when you need multiple shared Elasticsearch servers.

Environment variable: QUARKUS_ELASTICSEARCH_DEVSERVICES_SERVICE_NAME

string

elasticsearch

Activación/desactivación de los servicios de desarrollo para Elasticsearch
Elasticsearch compartido
Ajuste del puerto
Configuración de la imagen
Limitaciones actuales
Referencia de configuración