Quarkus Hibernate Search Extras
This set of extensions provides various extra features for the Quarkus Hibernate Search integration.
Compatibility
Quarkus Hibernate Search Extras provides different version streams for different versions of Quarkus.
Refer to the README on the main branch
to pick the appropriate version for your application.
AWS Integration
AWS request signing
If you need to use Amazon’s managed Elasticsearch service, you will find it requires a proprietary authentication method involving request signing.
To enable AWS request signing in Hibernate Search, an additional extension is required:
./mvnw quarkus:add-extension -Dextensions="hibernate-search-orm-elasticsearch-aws"Once the extension is there, you will need some more configuration:
-
Configure the AWS region with
quarkus.hibernate-search-orm.elasticsearch.aws.region. -
Enable request signing with
quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled. -
Optionally, configure how credentials are retrieved with
quarkus.hibernate-search-orm.elasticsearch.aws.credentials.type. The default gets the credentials from the application environment (AWS instance role, …), but several more options are available.
For example:
quarkus.hibernate-search-orm.elasticsearch.aws.region=us-east-1
quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled=trueOr, if credentials are not available in the application environment (AWS instance role, …):
quarkus.hibernate-search-orm.elasticsearch.aws.region=us-east-1
quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled=true
quarkus.hibernate-search-orm.elasticsearch.aws.credentials.type=static
quarkus.hibernate-search-orm.elasticsearch.aws.credentials.static-provider.access-key-id=AKIDEXAMPLE
quarkus.hibernate-search-orm.elasticsearch.aws.credentials.static-provider.secret-access-key=wJalrXUtnFEMI/K7MDENG+bPxRfiCYEXAMPLEKEYAWS Integration Configuration Reference
Configuration property fixed at build time - All other configuration properties are overridable at runtime
Type |
Default |
|
|---|---|---|
Whether requests should be signed using the AWS credentials. Environment variable: |
boolean |
|
An Amazon Web Services region that hosts the Elasticsearch service. Must be provided if signing is enabled; the region won’t be automatically detected. See Environment variable: |
Region |
|
Configure the credentials provider that should be used to authenticate with AWS. Available values:
Environment variable: |
|
|
Type |
Default |
|
Whether this provider should fetch credentials asynchronously in the background. If this is Environment variable: |
boolean |
|
Whether the provider should reuse the last successful credentials provider in the chain. Reusing the last successful credentials provider will typically return credentials faster than searching through the chain. Environment variable: |
boolean |
|
Type |
Default |
|
AWS Access key id Environment variable: |
string |
|
AWS Secret access key Environment variable: |
string |
|
AWS Session token Environment variable: |
string |
|
Type |
Default |
|
The name of the profile that should be used by this credentials provider. If not specified, the value in Environment variable: |
string |
|
Type |
Default |
|
Whether the provider should fetch credentials asynchronously in the background. If this is true, threads are less likely to block when credentials are loaded, but additional resources are used to maintain the provider. Environment variable: |
boolean |
|
The amount of time between when the credentials expire and when the credentials should start to be refreshed. This allows the credentials to be refreshed *before* they are reported to expire. Environment variable: |
|
|
The maximum size of the output that can be returned by the external process before an exception is raised. Environment variable: |
|
|
The command that should be executed to retrieve credentials. Environment variable: |
string |
|
Type |
Default |
|
The name of custom AwsCredentialsProvider bean. Environment variable: |
string |
|
About the Duration format
To write duration values, use the standard You can also use a simplified format, starting with a number:
In other cases, the simplified format is translated to the
|
|
About the MemorySize format
A size configuration option recognises string in this format (shown as a regular expression): |