SOLR-18094 Support running embedded-zk in "ensemble" mode with new node role

changelog/unreleased/SOLR-18094-zk-quorum-noderole.yml

@@ -0,0 +1,10 @@
+# See https://github.com/apache/solr/blob/main/dev-docs/changelog.adoc
+title: Capability for Solr to run embedded ZooKeeper in a quorum/ensemble mode, allowing multiple Solr nodes to form a distributed ZooKeeper ensemble within their own processes. Controlled by a new solr node-role.
+type: added # added, changed, fixed, deprecated, removed, dependency_update, security, other
+authors:
+  - name: Eric Pugh
+  - name: Jason Gerlowski
+  - name: Jan Høydahl
+links:
+  - name: SOLR-18094
+    url: https://issues.apache.org/jira/browse/SOLR-18094

gradle/libs.versions.toml

@@ -240,8 +240,8 @@ amazon-awssdk-s3 = { module = "software.amazon.awssdk:s3", version.ref = "amazon
 amazon-awssdk-sdkcore = { module = "software.amazon.awssdk:sdk-core", version.ref = "amazon-awssdk" }
 amazon-awssdk-sts = { module = "software.amazon.awssdk:sts", version.ref = "amazon-awssdk" }
 androidx-lifecycle-runtimeCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-runtime-compose", version.ref = "androidx-lifecycle" }
-androidx-lifecycle-viewmodelCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }
 androidx-lifecycle-viewModelNav3 = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-navigation3", version.ref = "androidx-lifecycle" }
+androidx-lifecycle-viewmodelCompose = { module = "org.jetbrains.androidx.lifecycle:lifecycle-viewmodel-compose", version.ref = "androidx-lifecycle" }
 androidx-material3-adaptive = { module = "org.jetbrains.compose.material3.adaptive:adaptive", version.ref = "androidx-adaptive" }
 androidx-material3-adaptive-nav3 = { module = "org.jetbrains.compose.material3.adaptive:adaptive-navigation3", version.ref = "androidx-adaptive" }
 androidx-navigation3-ui = { module = "org.jetbrains.androidx.navigation3:navigation3-ui", version.ref = "androidx-navigation3" }

solr/core/src/java/org/apache/solr/cloud/SolrZkServer.java

@@ -45,26 +45,58 @@ public class SolrZkServer {
   // Per ZooKeeper, "0" means no limit for max client connections.
   public static final String ZK_MAX_CNXNS_DEFAULT = "0";
 
-  boolean zkRun = false;
   String zkHost;
 
   int solrPort;
   Properties props;
   SolrZkServerProps zkProps;
 
-  private Thread zkThread; // the thread running a zookeeper server, only if zkRun is true
+  private Thread zkThread; // the thread running a zookeeper server, only if zkServerEnabled is true
 
   private Path dataHome; // o.a.zookeeper.**.QuorumPeerConfig needs a File not a Path
   private String confHome;
 
-  public SolrZkServer(boolean zkRun, String zkHost, Path dataHome, String confHome, int solrPort) {
-    this.zkRun = zkRun;
+  public SolrZkServer(String zkHost, Path dataHome, String confHome, int solrPort) {
     this.zkHost = zkHost;
     this.dataHome = dataHome;
     this.confHome = confHome;
     this.solrPort = solrPort;
   }
 
+  /**
+   * Creates and initializes a SolrZkServer instance for standalone (non-quorum) mode.
+   *
+   * @param zkHost the ZooKeeper host string (chroot will be stripped)
+   * @param solrHome the Solr home directory path
+   * @param solrHostPort the Solr host port
+   * @return initialized and started SolrZkServer instance
+   */
+  public static SolrZkServer createAndStart(String zkHost, Path solrHome, int solrHostPort) {
+    String zkDataHome =
+        EnvUtils.getProperty(
+            "solr.zookeeper.server.datadir", solrHome.resolve("zoo_data").toString());
+    String zkConfHome = EnvUtils.getProperty("solr.zookeeper.server.confdir", solrHome.toString());
+
+    String strippedZkHost = stripChroot(zkHost);
+    SolrZkServer zkServer =
+        new SolrZkServer(strippedZkHost, Path.of(zkDataHome), zkConfHome, solrHostPort);
+    zkServer.parseConfig();
+    zkServer.start();
+
+    return zkServer;
+  }
+
+  /**
+   * Strips the chroot portion from a ZooKeeper host string.
+   *
+   * @param zkRun the ZooKeeper host string (e.g., "localhost:2181/solr")
+   * @return the host string without chroot (e.g., "localhost:2181")
+   */
+  private static String stripChroot(String zkRun) {
+    if (zkRun == null || zkRun.trim().isEmpty() || zkRun.lastIndexOf('/') < 0) return zkRun;
+    return zkRun.substring(0, zkRun.lastIndexOf('/'));
+  }
+
   public String getClientString() {
     if (zkHost != null) {
       return zkHost;
@@ -74,11 +106,6 @@ public String getClientString() {
       return null;
     }
 
-    // if the string wasn't passed as zkHost, then use the standalone server we started
-    if (!zkRun) {
-      return null;
-    }
-
     InetSocketAddress addr = zkProps.getClientPortAddress();
     String hostName;
     // We cannot advertise 0.0.0.0, so choose the best host to advertise
@@ -97,7 +124,6 @@ public void parseConfig() {
       // set default data dir
       // TODO: use something based on IP+port???  support ensemble all from same solr home?
       zkProps.setDataDir(dataHome);
-      zkProps.zkRun = zkRun;
       zkProps.solrPort = Integer.toString(solrPort);
     }
 
@@ -116,7 +142,7 @@ public void parseConfig() {
 
     try {
       props = SolrZkServerProps.getProperties(zooCfgPath);
-      SolrZkServerProps.injectServers(props, zkRun, zkHost);
+      SolrZkServerProps.injectServers(props, zkHost);
       // This is the address that the embedded Zookeeper will bind to. Like Solr, it defaults to
       // "127.0.0.1".
       props.setProperty(
@@ -126,9 +152,8 @@ public void parseConfig() {
       }
       zkProps.parseProperties(props);
     } catch (QuorumPeerConfig.ConfigException | IOException e) {
-      if (zkRun) {
-        throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, e);
-      }
+
+      throw new SolrException(SolrException.ErrorCode.SERVER_ERROR, e);
     }
   }
 
@@ -137,9 +162,6 @@ public Map<Long, QuorumPeer.QuorumServer> getServers() {
   }
 
   public void start() {
-    if (!zkRun) {
-      return;
-    }
 
     ensureZkMaxCnxnsConfigured();
     if (System.getProperty(ZK_WHITELIST_PROPERTY) == null) {
@@ -167,20 +189,11 @@ public void start() {
             },
             "embeddedZkServer");
 
-    if (zkProps.getServers().size() > 1) {
-      if (log.isInfoEnabled()) {
-        log.info(
-            "STARTING EMBEDDED ENSEMBLE ZOOKEEPER SERVER at port {}, listening on host {}",
-            zkProps.getClientPortAddress().getPort(),
-            zkProps.getClientPortAddress().getAddress().getHostAddress());
-      }
-    } else {
-      if (log.isInfoEnabled()) {
-        log.info(
-            "STARTING EMBEDDED ENSEMBLE ZOOKEEPER SERVER at port {}, listening on host {}",
-            zkProps.getClientPortAddress().getPort(),
-            zkProps.getClientPortAddress().getAddress().getHostAddress());
-      }
+    if (log.isInfoEnabled()) {
+      log.info(
+          "STARTING EMBEDDED ENSEMBLE ZOOKEEPER SERVER at port {}, listening on host {}",
+          zkProps.getClientPortAddress().getPort(),
+          zkProps.getClientPortAddress().getAddress().getHostAddress());
     }
 
     zkThread.setDaemon(true);
@@ -207,9 +220,7 @@ public void start() {
   }
 
   public void stop() {
-    if (!zkRun) {
-      return;
-    }
+
     zkThread.interrupt();
   }
 
@@ -224,7 +235,6 @@ class SolrZkServerProps extends QuorumPeerConfig {
   private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
 
   String solrPort; // port that Solr is listening on
-  boolean zkRun;
 
   /**
    * Parse a ZooKeeper configuration file
@@ -253,10 +263,10 @@ public static Properties getProperties(Path configPath) throws ConfigException {
   // Given zkHost=localhost:1111,localhost:2222 this will inject
   // server.0=localhost:1112:1113
   // server.1=localhost:2223:2224
-  public static void injectServers(Properties props, boolean zkRun, String zkHost) {
+  public static void injectServers(Properties props, String zkHost) {
 
     // if clientPort not already set, use zkRun
-    if (zkRun && props.getProperty("clientPort") == null) {
+    if (props.getProperty("clientPort") == null) {
       // int portIdx = zkRun.lastIndexOf(':');
       int portIdx = "".lastIndexOf(':');
       if (portIdx > 0) {

solr/core/src/java/org/apache/solr/core/CoreContainer.java

@@ -290,7 +290,7 @@ public JerseyAppHandlerCache getJerseyAppHandlerCache() {
 
   private final ObjectCache objectCache = new ObjectCache();
 
-  public final NodeRoles nodeRoles = new NodeRoles(System.getProperty(NodeRoles.NODE_ROLES_PROP));
+  public final NodeRoles nodeRoles = new NodeRoles(EnvUtils.getProperty(NodeRoles.NODE_ROLES_PROP));
 
   private final ExecutorService indexSearcherExecutor;
 

solr/core/src/java/org/apache/solr/core/NodeConfig.java

@@ -235,11 +235,16 @@ public static NodeConfig loadNodeConfig(Path solrHome, Properties nodeProperties
     initModules(loader, null);
     nodeProperties = SolrXmlConfig.wrapAndSetZkHostFromSysPropIfNeeded(nodeProperties);
 
-    // TODO: Only job of this block is to
-    //  delay starting a solr core to satisfy
-    //  ZkFailoverTest test case...
     String zkHost = nodeProperties.getProperty(SolrXmlConfig.ZK_HOST);
-    if (StrUtils.isNotNullOrEmpty(zkHost)) {
+    NodeRoles nodeRoles = new NodeRoles(EnvUtils.getProperty(NodeRoles.NODE_ROLES_PROP));
+    boolean zookeeperQuorumNode =
+        NodeRoles.MODE_ON.equals(nodeRoles.getRoleMode(NodeRoles.Role.ZOOKEEPER_QUORUM));
+
+    // This block demonstrates how we pause and wait for a ZooKeeper to be available before
+    // continuing.
+    // See the ZkFailoverTest to see how changing solr.cloud.wait.for.zk.seconds impacts this
+    // capability.
+    if (StrUtils.isNotNullOrEmpty(zkHost) && !zookeeperQuorumNode) {
       int startUpZkTimeOut =
           1000
               * Integer.getInteger(

solr/core/src/java/org/apache/solr/core/NodeRoles.java

@@ -113,6 +113,18 @@ public String modeWhenRoleIsAbsent() {
       public Set<String> supportedModes() {
         return Set.of(MODE_ON, MODE_OFF);
       }
+    },
+
+    ZOOKEEPER_QUORUM("zookeeper_quorum") {
+      @Override
+      public Set<String> supportedModes() {
+        return Set.of(MODE_ON, MODE_OFF);
+      }
+
+      @Override
+      public String modeWhenRoleIsAbsent() {
+        return MODE_OFF;
+      }
     };
 
     public final String roleName;