Skip to content

Remove cluster state from /_cluster/reroute response #114231

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.

Sign up for GitHub

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

Jump to bottom
Merged
merged 1 commit into from
Oct 8, 2024
Merged

Remove cluster state from /_cluster/reroute response #114231

merged 1 commit into from
Oct 8, 2024

Conversation

DaveCTurner
Copy link
Contributor

Including the cluster state in responses to the POST _cluster/state
API was deprecated in #90399 (v8.6.0) requiring callers to pass
?metric=none to avoid the deprecation warning. This commit adjusts the
behaviour as promised in v9 so that this API never returns the cluster
state, and deprecates the ?metric parameter itself.

Closes #88978
@DaveCTurner DaveCTurner added >breaking :Distributed Coordination/Allocation All issues relating to the decision making around placing a shard (both master logic & on the nodes) v9.0.0 labels Oct 7, 2024
@elasticsearchmachine
Copy link
Collaborator

Hi @DaveCTurner, I've created a changelog YAML for you. Note that since this PR is labelled >breaking, you need to update the changelog YAML to fill out the extended information sections.
@DaveCTurner DaveCTurner mentioned this pull request Oct 7, 2024
Closed
@DaveCTurner
Remove cluster state from /_cluster/reroute response
413eb3f 
Including the cluster state in responses to the `POST _cluster/state` API was deprecated in elastic#90399 (v8.6.0) requiring callers to pass `?metric=none` to avoid the deprecation warning. This commit adjusts the behaviour as promised in v9 so that this API never returns the cluster state, and deprecates the `?metric` parameter itself. Closes elastic#88978
@DaveCTurner DaveCTurner force-pushed the 2024/10/07/ignore-reroute-metric-parameter branch from 49a36ea to 413eb3f Compare October 7, 2024 14:57
@DaveCTurner DaveCTurner marked this pull request as ready for review October 7, 2024 16:07
@elasticsearchmachine elasticsearchmachine added the Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. label Oct 7, 2024
@elasticsearchmachine
Copy link
Collaborator

Pinging @elastic/es-distributed (Team:Distributed)
idegtiarenko
idegtiarenko reviewed Oct 8, 2024
View reviewed changes
server/src/main/java/org/elasticsearch/action/admin/cluster/reroute/ClusterRerouteResponse.java
* To be removed when REST compatibility with {@link org.elasticsearch.Version#V_8_6_0} / {@link RestApiVersion#V_8} no longer needed
*/
@UpdateForV9(owner = UpdateForV9.Owner.DISTRIBUTED_COORDINATION) // to remove from the v9 API only
@UpdateForV10(owner = UpdateForV10.Owner.DISTRIBUTED_COORDINATION) // to remove entirely
Copy link
Contributor

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I do not think this pr closes #88978, until this is removed in 10, is it?
Copy link
Contributor Author

Choose a reason for hiding this comment

The reason will be displayed to describe this comment to others. Learn more.

I think it does - at least from the users' perspective with this change we no longer return the cluster state as described in #88978. There's some tech debt left behind (because of the need to support the v8 API still) but that's tracked with the @UpdateForV10 annotation, we don't need to keep an issue open too.
@DaveCTurner DaveCTurner merged commit 07c3acf into elastic:main Oct 8, 2024
16 checks passed
@DaveCTurner DaveCTurner deleted the 2024/10/07/ignore-reroute-metric-parameter branch October 8, 2024 07:00
matthewabbott pushed a commit to matthewabbott/elasticsearch that referenced this pull request Oct 10, 2024
@DaveCTurner @matthewabbott
Remove cluster state from /_cluster/reroute response (elastic#114231)
5949616 
Including the cluster state in responses to the `POST _cluster/state` API was deprecated in elastic#90399 (v8.6.0) requiring callers to pass `?metric=none` to avoid the deprecation warning. This commit adjusts the behaviour as promised in v9 so that this API never returns the cluster state, and deprecates the `?metric` parameter itself. Closes elastic#88978
davidkyle pushed a commit to davidkyle/elasticsearch that referenced this pull request Oct 13, 2024
@DaveCTurner @davidkyle
Remove cluster state from /_cluster/reroute response (elastic#114231)
3709cd0 
Including the cluster state in responses to the `POST _cluster/state` API was deprecated in elastic#90399 (v8.6.0) requiring callers to pass `?metric=none` to avoid the deprecation warning. This commit adjusts the behaviour as promised in v9 so that this API never returns the cluster state, and deprecates the `?metric` parameter itself. Closes elastic#88978
@leemthompo
Copy link
Contributor

@DaveCTurner is this PR relevant to the serverless changelog? [FYI this question is based on 9.0 breaking changes]
@DaveCTurner
Copy link
Contributor Author

No, the reroute API is internal, end-users cannot access it in serverless.
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

>breaking :Distributed Coordination/Allocation All issues relating to the decision making around placing a shard (both master logic & on the nodes) Team:Distributed (Obsolete) Meta label for distributed team (obsolete). Replaced by Distributed Indexing/Coordination. v9.0.0

4 participants

@DaveCTurner @elasticsearchmachine @leemthompo @idegtiarenko