Skip to content

SOLR-18160: Deprecate Overseer ADDROLE and REMOVEROLE Collection API operations#4627

Open
abumarjikar wants to merge 6 commits into
apache:mainfrom
abumarjikar:SOLR_18160_deprecate_addrole_removerole
Open

SOLR-18160: Deprecate Overseer ADDROLE and REMOVEROLE Collection API operations#4627
abumarjikar wants to merge 6 commits into
apache:mainfrom
abumarjikar:SOLR_18160_deprecate_addrole_removerole

Conversation

@abumarjikar

@abumarjikar abumarjikar commented Jul 9, 2026

Copy link
Copy Markdown
Contributor

https://issues.apache.org/jira/browse/SOLR-18160

Description

Deprecate the legacy ADDROLE and REMOVEROLE Overseer Collection API operations. Users should transition to managing node roles at startup via the -Dsolr.node.roles parameter.

Solution

  • Added deprecation logging messages using DeprecationLog.log in OverseerRoleCmd.java for both ADDROLE and REMOVEROLE operations, alerting users that they will be removed in Solr 11.
  • Added @Deprecated(since = "10.1") annotations and updated JavaDoc documentation for addRole and removeRole helper methods within CollectionAdminRequest.java.
  • Marked ADDROLE and REMOVEROLE enum entries with @Deprecated(since = "10.1") in CollectionAction inside CollectionParams.java.

Checklist

Please review the following and check all that apply:

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch.
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added tests for my changes.
  • I have added documentation for the Reference Guide
  • I have added a changelog entry for my change

@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Jul 10, 2026
@abumarjikar abumarjikar marked this pull request as ready for review July 10, 2026 04:00

@dsmiley dsmiley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

looks good; thanks

Comment thread solr/core/src/java/org/apache/solr/cloud/api/collections/OverseerRoleCmd.java Outdated
@abumarjikar abumarjikar requested a review from dsmiley July 13, 2026 06:10
@dsmiley dsmiley added this to the 10.x milestone Jul 13, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

cat:api cat:cloud client:solrj documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

2 participants