Skip to content

Commit

Permalink
Merge pull request #22894 from yrodiere/aws-config
Browse files Browse the repository at this point in the history
Remove detailed documentation about AWS signing in Hibernate Search
  • Loading branch information
gsmet authored Jan 14, 2022
2 parents 8708cf8 + e66c927 commit 84b7be5
Showing 1 changed file with 4 additions and 41 deletions.
45 changes: 4 additions & 41 deletions docs/src/main/asciidoc/hibernate-search-orm-elasticsearch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -814,47 +814,15 @@ for more information.
====

[[aws-request-signing]]
== AWS request signing
== [[configuration-reference-aws]] AWS request signing

If you need to use https://docs.aws.amazon.com/elasticsearch-service/[Amazon’s managed Elasticsearch service],
you will find it requires a proprietary authentication method involving request signing.

To enable AWS request signing, an additional extension is required:
You can enable AWS request signing in Hibernate Search by adding a dedicated extension to your project and configuring it.

[source,bash]
----
./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
link:#quarkus-hibernate-search-orm-elasticsearch-aws_quarkus.hibernate-search-orm.elasticsearch.aws.region[`quarkus.hibernate-search-orm.elasticsearch.aws.region`].
* Enable request signing with
link:#quarkus-hibernate-search-orm-elasticsearch-aws_quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled[`quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled`].
* Optionally, configure how credentials are retrieved with
link:#quarkus-hibernate-search-orm-elasticsearch-aws_quarkus.hibernate-search-orm.elasticsearch.aws.credentials.type[`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:

[source,properties]
----
quarkus.hibernate-search-orm.elasticsearch.aws.region=us-east-1
quarkus.hibernate-search-orm.elasticsearch.aws.signing.enabled=true
----

Or, if credentials are not available in the application environment (AWS instance role, ...):

[source,properties]
----
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+bPxRfiCYEXAMPLEKEY
----
See link:{hibernate-search-orm-elasticsearch-aws-guide}#aws-configuration-reference[the documentation for the Hibernate Search ORM + Elasticsearch AWS extension]
for more information.

== Further reading

Expand Down Expand Up @@ -904,8 +872,3 @@ for more information.
====

:no-duration-note: true

[[configuration-reference-aws]]
=== AWS Integration Configuration

Please see link:{hibernate-search-orm-elasticsearch-aws-guide}#aws-configuration-reference[the documentation for the Hibernate Search ORM + Elasticsearch AWS extension].

0 comments on commit 84b7be5

Please sign in to comment.