Update language around client version compatibility #6939
Merged
Conversation
This file contains bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Signed-off-by: Heather Halter <[email protected]>
hdhalter
requested review from
kolchfa-aws,
Naarcha-AWS,
vagimeli,
AMoo-Miki,
natebower,
dlvenable,
stephen-crawford and
epugh
as code owners
hdhalter
added
4 - Doc review
Naarcha-AWS
reviewed
Apr 11, 2024
Naarcha-AWS
reviewed
Apr 11, 2024
_clients/index.md
Outdated
| Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch. | ||
| Most clients that work with ElasticSearch OSS 7.10.2 *should* work with OpenSearch 1.x, but the latest versions of those clients might include license or version checks that artificially break compatibility. The table that follows includes recommendations for which client versions to use for best compatibility with OpenSearch 1.x. From OpenSearch 2.0 and later, no ElasticSearch clients are fully compatible with OpenSearch. | ||
|
|
||
| While OpenSearch and ElasticSearch share a majority of core features, mixing and matching the client and server has a very high risk of errors and unexpected results. The issues will continue to get worse over time as OpenSearch and ElasticSearch diverge even further from each other. So, even if your ElasticSearch client still works with your OpenSearch cluster, we highly recommend using OpenSearch clients for OpenSearch clusters. |
There was a problem hiding this comment.
Suggested change
| While OpenSearch and ElasticSearch share a majority of core features, mixing and matching the client and server has a very high risk of errors and unexpected results. The issues will continue to get worse over time as OpenSearch and ElasticSearch diverge even further from each other. So, even if your ElasticSearch client still works with your OpenSearch cluster, we highly recommend using OpenSearch clients for OpenSearch clusters. | |
| While OpenSearch and Elasticsearch share a majority of core features, mixing and matching the client and server has a very high risk of errors and unexpected results. The issues will continue to get worse over time as OpenSearch and Elasticsearch diverge even further from each other. So, even if your Elasticsearch client still works with your OpenSearch cluster, we highly recommend using OpenSearch clients for OpenSearch clusters. |
vagimeli
approved these changes
Apr 11, 2024
_clients/index.md
Outdated
| ## Legacy clients | ||
|
|
||
| Most clients that work with Elasticsearch OSS 7.10.2 *should* work with OpenSearch, but the latest versions of those clients might include license or version checks that artificially break compatibility. This page includes recommendations around which versions of those clients to use for best compatibility with OpenSearch. | ||
| Most clients that work with ElasticSearch OSS 7.10.2 *should* work with OpenSearch 1.x, but the latest versions of those clients might include license or version checks that artificially break compatibility. The table that follows includes recommendations for which client versions to use for best compatibility with OpenSearch 1.x. From OpenSearch 2.0 and later, no ElasticSearch clients are fully compatible with OpenSearch. |
There was a problem hiding this comment.
Suggested change
| Most clients that work with ElasticSearch OSS 7.10.2 *should* work with OpenSearch 1.x, but the latest versions of those clients might include license or version checks that artificially break compatibility. The table that follows includes recommendations for which client versions to use for best compatibility with OpenSearch 1.x. From OpenSearch 2.0 and later, no ElasticSearch clients are fully compatible with OpenSearch. | |
| Clients that work with ElasticSearch OSS 7.10.2 should work with OpenSearch 1.x. The latest versions of those clients, however, might include license or version checks that artificially break compatibility. The following table provides recommendations for which client versions to use for best compatibility with OpenSearch 1.x. For OpenSearch 2.0 and later, no Elasticsearch clients are fully compatible with OpenSearch. |
vagimeli
approved these changes
Apr 11, 2024
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Heather Halter <[email protected]>
Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]>
opensearch-trigger-bot bot
pushed a commit
that referenced
this pull request
Apr 11, 2024
* Update language around client version compatibility Signed-off-by: Heather Halter <[email protected]> * Update _clients/index.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/index.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/index.md Co-authored-by: Naarcha-AWS <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/index.md Co-authored-by: Melissa Vagi <[email protected]> Signed-off-by: Heather Halter <[email protected]> * Update _clients/index.md Co-authored-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> --------- Signed-off-by: Heather Halter <[email protected]> Signed-off-by: Melissa Vagi <[email protected]> Co-authored-by: Melissa Vagi <[email protected]> Co-authored-by: Naarcha-AWS <[email protected]> (cherry picked from commit b7d50c5) Signed-off-by: github-actions[bot] <github-actions[bot]@users.noreply.github.com>
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
Add this suggestion to a batch that can be applied as a single commit.
This suggestion is invalid because no changes were made to the code.
Suggestions cannot be applied while the pull request is closed.
Suggestions cannot be applied while viewing a subset of changes.
Only one suggestion per line can be applied in a batch.
Add this suggestion to a batch that can be applied as a single commit.
Applying suggestions on deleted lines is not supported.
You must change the existing code in this line in order to create a valid suggestion.
Outdated suggestions cannot be applied.
This suggestion has been applied or marked resolved.
Suggestions cannot be applied from pending reviews.
Suggestions cannot be applied on multi-line comments.
Suggestions cannot be applied while the pull request is queued to merge.
Suggestion cannot be applied right now. Please check back later.
Description
Addresses community feedback from Slack.
Issues Resolved
See https://opensearch.slack.com/archives/C052GAV1MQF/p1712689014138299
Checklist
For more information on following Developer Certificate of Origin and signing off your commits, please check here.