Clarify Elasticsearch 9.x compatibility #2928
Merged
Conversation
This file contains hidden or 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
Appended the client compatibility matrix to call out the 9.x client compatibility for 9.x release.
miguelgrinberg
approved these changes
Apr 16, 2025
marciw
reviewed
Apr 16, 2025
README.md
Outdated
| | 8.x | 8.x | 8.x | | ||
| | 7.x | 7.x | 7.17 | | ||
|
|
||
| Language clients are forward compatible; meaning that the clients support communicating with greater or equal minor versions of {{es}} without breaking. It does not mean that the clients automatically support new features of newer {{es}} versions; it is only possible after a release of a new client version. For example, a 8.12 client version won’t automatically support the new features of the 8.13 version of {{es}}, the 8.13 client version is required for that. {{es}} language clients are only backwards compatible across minor versions with default distributions and without guarantees made. To upgrade to a new major version, you first need to upgrade Elasticsearch, then the Python Elasticsearch client. |
There was a problem hiding this comment.
I don't think these {{es}} substitutions will work in the README, right? Only in the docs.
The edits I'm suggesting to the docs also apply to the README, except of course the :::{{tip}} block won't work in the README, so that can just be a standard paragraph.
There was a problem hiding this comment.
Thanks, I converted to GitHub-flavored Markdown, which also supports alert blocks:
|
Realized I misstated something, so I made edits to my suggestions (as well as the screenshot) -- done now! |
pquentin
approved these changes
Apr 17, 2025
github-actions bot
pushed a commit
that referenced
this pull request
Apr 17, 2025
Co-authored-by: Quentin Pradet <[email protected]> Co-authored-by: Marci W <[email protected]> (cherry picked from commit bd612f3)
pquentin
pushed a commit
that referenced
this pull request
Apr 17, 2025
Co-authored-by: Quentin Pradet <[email protected]> Co-authored-by: Marci W <[email protected]> (cherry picked from commit bd612f3) Co-authored-by: Zach Brisson <[email protected]>
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.
Appended the client compatibility matrix to call out the 9.x client compatibility for 9.x release.
Based off @miguelgrinberg post here #2927 (comment) and past historical precedent, updated the matrix to show that 9.x clients work with 9.x clients and not 8.x or 7.x as they will run into
Invalid media-type value on headerserrors. You might need someone from the python api team to review prior to approval on this one in case that has changed.Screenshot showing elasticsearch9 is a valid upgrade/install path
