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

changelog/unreleased/SOLR_18160_deprecate_addrole_removerole.yml

@@ -0,0 +1,8 @@
+type: deprecated
+title: Deprecate Overseer ADDROLE and REMOVEROLE Collection API operations
+authors:
+  - name: Abhishek Umarjikar
+    nick: abumarjikar
+links:
+  - name: SOLR-18160
+    url: https://issues.apache.org/jira/browse/SOLR-18160

solr/core/src/java/org/apache/solr/cloud/api/collections/OverseerRoleCmd.java

@@ -32,6 +32,7 @@
 import org.apache.solr.common.util.CollectionUtil;
 import org.apache.solr.common.util.NamedList;
 import org.apache.solr.common.util.Utils;
+import org.apache.solr.logging.DeprecationLog;
 import org.apache.zookeeper.CreateMode;
 import org.apache.zookeeper.data.Stat;
 import org.slf4j.Logger;
@@ -87,9 +88,21 @@ public void call(AdminCmdContext adminCmdContext, ZkNodeProps message, NamedList
 
     List<String> nodeList = roles.computeIfAbsent(roleName, k -> new ArrayList<>());
     if (ADDROLE == operation) {
+      DeprecationLog.log(
+          "CollectionAPI-" + operation.toLower(),
+          "The "
+              + operation
+              + " API is deprecated and will be removed in Solr 11. "
+              + "Please transition to using Node Roles (-Dsolr.node.roles) at startup instead.");
       log.info("Overseer role added to {}", node);
       if (!nodeList.contains(node)) nodeList.add(node);
     } else if (REMOVEROLE == operation) {
+      DeprecationLog.log(
+          "CollectionAPI-" + operation.toLower(),
+          "The "
+              + operation
+              + " API is deprecated and will be removed in Solr 11. "
+              + "Please transition to using Node Roles (-Dsolr.node.roles) at startup instead.");
       log.info("Overseer role removed from {}", node);
       nodeList.remove(node);
     }

solr/core/src/java/org/apache/solr/handler/ClusterAPI.java

@@ -258,6 +258,7 @@ private CoreContainer getCoreContainer() {
   @EndPoint(method = POST, path = "/cluster", permission = COLL_EDIT_PERM)
   public class Commands {
     @Command(name = "add-role")
+    @Deprecated(since = "10.1")
     public void addRole(PayloadObj<RoleInfo> obj) throws Exception {
       RoleInfo info = obj.get();
       Map<String, Object> m = new SimpleOrderedMap<>(info);
@@ -266,6 +267,7 @@ public void addRole(PayloadObj<RoleInfo> obj) throws Exception {
     }
 
     @Command(name = "remove-role")
+    @Deprecated(since = "10.1")
     public void removeRole(PayloadObj<RoleInfo> obj) throws Exception {
       RoleInfo info = obj.get();
       Map<String, Object> m = new SimpleOrderedMap<>(info);

solr/core/src/java/org/apache/solr/handler/admin/ClusterStatus.java

@@ -50,7 +50,10 @@ public class ClusterStatus {
   public static final String INCLUDE_ALL = "includeAll";
   public static final String LIVENODES_PROP = "liveNodes";
   public static final String CLUSTER_PROP = "clusterProperties";
+
+  @Deprecated(since = "10.1")
   public static final String ROLES_PROP = "roles";
+
   public static final String ALIASES_PROP = "aliases";
 
   /** Shard / collection health state. */

solr/solr-ref-guide/modules/upgrade-notes/pages/major-changes-in-solr-10.adoc

@@ -307,6 +307,8 @@ Nowadays, the HTTP request is available via internal APIs: `SolrQueryRequest.get
 
 * The deprecated `VMParamsAllAndReadonlyDigestZkACLProvider` class has been removed. Use a combination of `DigestZkACLProvider` and `VMParamsZkCredentialsInjector` instead. (SOLR-18122)
 
+* The legacy V1 `ADDROLE` and `REMOVEROLE` commands (and their SolrJ client and experimental V2 counterparts) are deprecated as of 10.1 and scheduled for removal in Solr 11. Users must switch to **"node roles" (system properties)** (e.g., `-Dsolr.node.roles=data:on,overseer:preferred`) at startup. The `roles` field in `CLUSTERSTATUS` is also deprecated.
+
 === Security
 
 * There is no longer a distinction between trusted and untrusted configSets; all configSets are now considered trusted. To ensure security, Solr should be properly protected using authentication and authorization mechanisms, allowing only authorized users with administrative privileges to publish them.

solr/solrj/src/java/org/apache/solr/client/solrj/request/CollectionAdminRequest.java

@@ -2861,7 +2861,12 @@ public SolrParams getParams() {
     }
   }
 
-  /** Returns a SolrRequest to add a role to a node */
+  /**
+   * Returns a SolrRequest to add a role to a node
+   *
+   * @deprecated Use Node Roles ({@code -Dsolr.node.roles}) at startup instead.
+   */
+  @Deprecated(since = "10.1")
   public static AddRole addRole(String node, String role) {
     return new AddRole(node, role);
   }
@@ -2873,7 +2878,12 @@ private AddRole(String node, String role) {
     }
   }
 
-  /** Returns a SolrRequest to remove a role from a node */
+  /**
+   * Returns a SolrRequest to remove a role from a node
+   *
+   * @deprecated Use Node Roles ({@code -Dsolr.node.roles}) at startup instead.
+   */
+  @Deprecated(since = "10.1")
   public static RemoveRole removeRole(String node, String role) {
     return new RemoveRole(node, role);
   }

solr/solrj/src/java/org/apache/solr/common/params/CollectionParams.java

@@ -102,7 +102,9 @@ enum CollectionAction {
     DELETEREPLICA(true, LockLevel.SHARD),
     FORCELEADER(true, LockLevel.SHARD),
     MIGRATE(true, LockLevel.COLLECTION),
+    @Deprecated(since = "10.1")
     ADDROLE(true, LockLevel.NONE),
+    @Deprecated(since = "10.1")
     REMOVEROLE(true, LockLevel.NONE),
     CLUSTERPROP(true, LockLevel.NONE),
     COLLECTIONPROP(true, LockLevel.NONE), // atomic; no lock