Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

[DOCS] Versioning & Compatibility policy #178

Closed
Xtansia opened this issue Sep 3, 2023 · 3 comments
Closed

[DOCS] Versioning & Compatibility policy #178

Xtansia opened this issue Sep 3, 2023 · 3 comments
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers

Comments

@Xtansia
Copy link
Collaborator

Xtansia commented Sep 3, 2023

The versioning and compatibility policy as laid out here needs revisiting.

It needs v2.0 added to the compatibility matrix as it is in COMPATIBILITY.md

Additionally we do not necessarily intend for client versioning to remain in major version lockstep with the server. ie. if it's possible to support the future OpenSearch 3.0 server without introducing breaking changes to the client, the client will remain v2.

@Xtansia Xtansia added the documentation Improvements or additions to documentation label Sep 3, 2023
@Xtansia Xtansia added good first issue Good for newcomers and removed untriaged labels Sep 13, 2023
@AbhinavGarg90
Copy link
Contributor

Hey, what exactly needs to be done to resolve this issue?

@Xtansia
Copy link
Collaborator Author

Xtansia commented Oct 3, 2023

There's two things that need adjusted in this comment:

  • A very simple addition of a | 2.x | 2.x | row to the compatibility table.
  • There needs to be some re-wording (especially the line A major version of the client is compatible with the same major version of OpenSearch.) as we don't intend to always be in the policy of client version N.x.x matches to server version N.x.x.

@dblock Do you have thoughts about how we might word that latter part?

@dblock
Copy link
Member

dblock commented Oct 4, 2023

I would remove that lengthy comment altogether.

OpenSearch server now follows semver, so should client. Make it independent. Compatibility != support for all features. Trying to match server version is limiting, clients are separate applications and should evolve separately.

In the compatibility matrix I'd like to see things like opensearch-rs 6.1 is compatible with OpenSearch 1.x and 2.x. When I look for a specific API added in OpenSearch 2.12, I'd want to find in CHANGELOG something like "opensearch-rs 6.2 adds support for OpenSearch 2.12 spline/reticulate API". Note that 6.2 would still be compatible with 2.10 or 2.12, just may not have all features (yet).

@Xtansia Xtansia closed this as completed Nov 24, 2023
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
documentation Improvements or additions to documentation good first issue Good for newcomers
Projects
None yet
Development

No branches or pull requests

3 participants