Skip to content

Commit

Permalink
update documentation, bump opensearch version to 2.11.1
Browse files Browse the repository at this point in the history
Merge commit '182b9c292af64b2040d639a618ead061b6cbc775' into 88-opensearch-java-client-support-for-multiple-transport-options
  • Loading branch information
sboeckelmann committed Dec 3, 2023
2 parents de4c1ed + 182b9c2 commit b59ccf6
Show file tree
Hide file tree
Showing 3 changed files with 72 additions and 3 deletions.
2 changes: 1 addition & 1 deletion README.md
Original file line number Diff line number Diff line change
Expand Up @@ -19,7 +19,7 @@ The Java Client is not dependent on the REST client anymore and supports Apache
## Version Matrix
| | Quarkus | OpenSearch | OpenSearch Java Client |
|-------|--------------|------------|------------------------|
| 1.2.4 | 3.2.8.Final | 2.11.0 | 2.8.1 |
| 1.2.4 | 3.2.8.Final | 2.11.1 | 2.8.1 |
| 1.2.3 | 3.2.8.Final | 2.11.0 | 2.8.1 |
| 1.2.2 | 3.2.4.Final | 2.9.0 | 2.6.0 |
| 1.2.1 | 3.2.3.Final | 2.9.0 | 2.6.0 |
Expand Down
69 changes: 69 additions & 0 deletions docs/modules/ROOT/pages/includes/quarkus-opensearch.adoc
Original file line number Diff line number Diff line change
Expand Up @@ -10,6 +10,7 @@ h|[[quarkus-opensearch_configuration]]link:#quarkus-opensearch_configuration[Con
h|Type
h|Default


a|icon:lock[title=Fixed at build time] [[quarkus-opensearch_quarkus.opensearch.health.enabled]]`link:#quarkus-opensearch_quarkus.opensearch.health.enabled[quarkus.opensearch.health.enabled]`


Expand Down Expand Up @@ -218,6 +219,74 @@ endif::add-copy-button-to-env-var[]
link:#duration-note-anchor-{summaryTableId}[icon:question-circle[], title=More information about the Duration format]
|`5M`


a| [[quarkus-opensearch_quarkus.opensearch.aws.region]]`link:#quarkus-opensearch_quarkus.opensearch.aws.region[quarkus.opensearch.aws.region]`
[.description]
--
Defines the AWS region when connecting to Amazon OpenSearch Service.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSEARCH_AWS_REGION+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSEARCH_DISCOVERY_AWS_REGION+++`
endif::add-copy-button-to-env-var[]
--|string
|`us-west-2`

a| [[quarkus-opensearch_quarkus.opensearch.aws.service]]`link:#quarkus-opensearch_quarkus.opensearch.aws.service[quarkus.opensearch.aws.service]`
[.description]
--
When set AwsSdk2Transport is used instead of default ApacheHttpClient5Transport.

Set to "es" or "aoss" to enable AWS OpenSearch Service client.

* es : Amazon OpenSearch Service
* aoss : Amazon OpenSearch Serverless
ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSEARCH_AWS_SERVICE+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSEARCH_DISCOVERY_AWS_SERVICE+++`
endif::add-copy-button-to-env-var[]
--|optional string
|`-`

a| [[quarkus-opensearch_quarkus.opensearch.aws.access-key-id]]`link:#quarkus-opensearch_quarkus.opensearch.aws.access-key-id[quarkus.opensearch.aws.access-key-id]`
[.description]
--

AWS Access Key ID

Use StaticCredentialsProvider using this access key id instead of DefaultCredentialsProvider.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSEARCH_AWS_ACCESS_KEY_ID+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSEARCH_AWS_ACCESS_KEY_ID+++`
endif::add-copy-button-to-env-var[]
--|optional string
|`-`

a| [[quarkus-opensearch_quarkus.opensearch.aws.access-key-secret]]`link:#quarkus-opensearch_quarkus.opensearch.aws.access-key-secret[quarkus.opensearch.aws.access-key-secret]`
[.description]
--

AWS Access Key Secret

Use StaticCredentialsProvider using this access key secret instead of DefaultCredentialsProvider.

ifdef::add-copy-button-to-env-var[]
Environment variable: env_var_with_copy_button:+++QUARKUS_OPENSEARCH_AWS_ACCESS_KEY_SECRET+++[]
endif::add-copy-button-to-env-var[]
ifndef::add-copy-button-to-env-var[]
Environment variable: `+++QUARKUS_OPENSEARCH_AWS_ACCESS_KEY_SECRET+++`
endif::add-copy-button-to-env-var[]
--|optional string
|`-`

|===
ifndef::no-duration-note[]
[NOTE]
Expand Down
4 changes: 2 additions & 2 deletions pom.xml
Original file line number Diff line number Diff line change
Expand Up @@ -29,8 +29,8 @@
<maven.compiler.release>11</maven.compiler.release>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<project.reporting.outputEncoding>UTF-8</project.reporting.outputEncoding>
<quarkus.version>3.2.8.Final</quarkus.version>
<opensearch.version>2.11.0</opensearch.version>
<quarkus.version>3.5.2</quarkus.version>
<opensearch.version>2.11.1</opensearch.version>
<opensearch.client.version>2.8.1</opensearch.client.version>
<opensearch-testcontainers.version>2.0.1</opensearch-testcontainers.version>
<apache.httpclient5.version>5.2.1</apache.httpclient5.version>
Expand Down

0 comments on commit b59ccf6

Please sign in to comment.