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

Optional keyStoreFile to be used when connecting to cluster nodes

Environment variable: QUARKUS_OPENSEARCH_SSL_KEY_STORE_FILE

string

Optional password for accessing keyStoreFile

Environment variable: QUARKUS_OPENSEARCH_SSL_KEY_STORE_PASSWORD

string

SSL Verify Hostname

Environment variable: QUARKUS_OPENSEARCH_SSL_VERIFY_HOSTNAME

boolean

true

Verify SSL Certificates

Environment variable: QUARKUS_OPENSEARCH_SSL_VERIFY

boolean

true

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.