Quarkus Opensearch Extension

The quarkus-opensearch extension allows you to connect to an OpenSearch cluster using the clients provided by the OpenSearch project.

OpenSearch Clients

OpenSearch provides three different flavours of clients for connecting to the cluster. This extension has support for all three of them.

OpenSearch Java Client

This is the latest implementation of the OpenSearch clients, when starting a new project you should use this client and not bother about the others. This will be the only OpenSearch Client supported in the future. Just like the OpenSearch REST high-level level, the OpenSearch Java client lets you interact with OpenSearch through Java methods and data structures. In comparison to the REST high-level, it has no dependency to org.opensearch:opensearch and also provides an async client implementation.

Deprecation

The OpenSearch REST clients are deprecated. Support will be removed in OpenSearch version 3.0.0.

It is recommended to switch to the Java client. We will try to support the REST clients as long as possible, but if you start a new project this is not the client you should use anymore.

OpenSearch REST High-Level Client

The OpenSearch Java high-level REST client lets you interact with your OpenSearch clusters and indices through Java methods and data structures rather than HTTP methods and JSON.

OpenSearch REST (low-level) client

Core low-level client which lets you interact with OpenSearch clusters through HTTP methods and JSON, it is also used by the two other higher level clients for connecting to the cluster.

Installation

OpenSearch Java client

The java client does not have any dependencies on the REST client. All clients are sharing most of the configuration properties. The AWS related configuration properties quarkus.opensearch.aws.* are only applicable to this java client.

If you want to use this client all you need to do is add the io.quarkiverse.opensearch:quarkus-opensearch-java-client extension first to your build file.

with Maven, add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.opensearch</groupId>
    <artifactId>quarkus-opensearch-java-client</artifactId>
    <version>1.8.1</version>
</dependency>

OpenSearch REST High-Level Client

The REST High-Level Client depends on the REST client and does not require any additional configuration.

If you want to use this client all you need to do is add the io.quarkiverse.opensearch:quarkus-opensearch-rest-high-level-client extension first to your build file.

with Maven, add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.opensearch</groupId>
    <artifactId>quarkus-opensearch-rest-high-level-client</artifactId>
    <version>1.8.1</version>
</dependency>

OpenSearch REST Low-Level Client

If you want to use this extension, you need to add the io.quarkiverse.opensearch:quarkus-opensearch-rest-client extension first to your build file.

For instance, with Maven, add the following dependency to your POM file:

<dependency>
    <groupId>io.quarkiverse.opensearch</groupId>
    <artifactId>quarkus-opensearch-rest-client</artifactId>
    <version>1.8.1</version>
</dependency>

Extension Configuration Reference

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

Configuration property

Type

Default

Whether a health check is published in case the smallrye-health extension is present.

Environment variable: QUARKUS_OPENSEARCH_HEALTH_ENABLED

boolean

true

The list of hosts of the OpenSearch servers, when accessing AWS OpenSearch set to AWS endpoint name. Host Example: opensearch-01:9200,opensearch-02:9200 AWS Endpoint Example: search-domain-name-identifier.region.es.amazonaws.com

Environment variable: QUARKUS_OPENSEARCH_HOSTS

list of string

The protocol to use when contacting OpenSearch servers. Set to "https" to enable SSL/TLS.

Environment variable: QUARKUS_OPENSEARCH_PROTOCOL

string

http

The username for basic HTTP authentication.

Environment variable: QUARKUS_OPENSEARCH_USERNAME

string

The password for basic HTTP authentication.

Environment variable: QUARKUS_OPENSEARCH_PASSWORD

string

The connection timeout.

Environment variable: QUARKUS_OPENSEARCH_CONNECTION_TIMEOUT

Duration

15S

The connection timeout.

Environment variable: QUARKUS_OPENSEARCH_THREAD_TIMEOUT

Duration

30S

The socket timeout.

Environment variable: QUARKUS_OPENSEARCH_SOCKET_TIMEOUT

Duration

30S

The maximum number of connections to all the OpenSearch servers.

Environment variable: QUARKUS_OPENSEARCH_MAX_CONNECTIONS

int

20

The maximum number of connections per OpenSearch server.

Environment variable: QUARKUS_OPENSEARCH_MAX_CONNECTIONS_PER_ROUTE

int

10

The number of IO thread. By default, this is the number of locally detected processors.

Thread counts higher than the number of processors should not be necessary because the I/O threads rely on non-blocking operations, but you may want to use a thread count lower than the number of processors.

Environment variable: QUARKUS_OPENSEARCH_IO_THREAD_COUNTS

int

AWS Region

Environment variable: QUARKUS_OPENSEARCH_AWS_REGION

string

us-west-2

Set to "es" or "aoss" to use AWS OpenSearch Service. es : Amazon OpenSearch Service aoss : Amazon OpenSearch Serverless

Environment variable: QUARKUS_OPENSEARCH_AWS_SERVICE

string

AWS Secret Access Key for setting up StaticCredentialsProvider

Environment variable: QUARKUS_OPENSEARCH_AWS_ACCESS_KEY_ID

string

AWS Secret Access Key Secret for setting up StaticCredentialsProvider

Environment variable: QUARKUS_OPENSEARCH_AWS_ACCESS_KEY_SECRET

string

Defines if automatic discovery is enabled.

Environment variable: QUARKUS_OPENSEARCH_DISCOVERY_ENABLED

boolean

false

Refresh interval of the node list.

Environment variable: QUARKUS_OPENSEARCH_DISCOVERY_REFRESH_INTERVAL

Duration

5M

About the Duration format

To write duration values, use the standard java.time.Duration format. See the Duration#parse() Java API documentation for more information.

You can also use a simplified format, starting with a number:

  • If the value is only a number, it represents time in seconds.

  • If the value is a number followed by ms, it represents time in milliseconds.

In other cases, the simplified format is translated to the java.time.Duration format for parsing:

  • If the value is a number followed by h, m, or s, it is prefixed with PT.

  • If the value is a number followed by d, it is prefixed with P.