Require SolrCloud mode: enforce at runtime and document clearly#43
Merged
Conversation
Solr Orbit only supports SolrCloud (ZooKeeper) mode. Standalone/user-managed mode is not supported because collection management relies on the Collections API which is unavailable in standalone mode. Changes: - Add SolrAdminClient.is_cloud_mode() which probes the CLUSTERSTATUS endpoint; returns True for cloud mode, False for standalone (HTTP 400), or raises on unexpected errors. - Add _check_cloud_mode() in test_run_orchestrator and call it from benchmark_only() so users get a clear error immediately rather than a confusing failure later. - Fix quickstart.md docker run example: replace 'solr-demo' (standalone) with '-c' (SolrCloud). Add an important callout about the cloud mode requirement. - Add SolrCloud requirement notes to running-workloads.md and test-procedures.md. - Add unit tests for all three is_cloud_mode() outcomes. For Solr 9.x: start with '-c' flag (bin/solr start -c or docker run ... solr:9 -c). For Solr 10.0.0+: SolrCloud is the default; no extra flag needed. The provisioning pipelines (docker, from-distribution, from-sources) already start Solr with cloud mode for all versions. Closes apache#33
epugh
reviewed
May 30, 2026
epugh
approved these changes
May 30, 2026
Contributor
epugh
left a comment
epugh
left a comment
There was a problem hiding this comment.
Other than a question about the phrasing of SolrCloud mode, this LGTM. I like that you went beyond just the documentation and actually made it part of the code! Will save folks who run it against something without reading the docs, or point to a solr that just happens to NOT be in cloud mode.
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
Solr Orbit only supports SolrCloud (ZooKeeper) mode. Standalone/user-managed mode is not supported because collection management relies on the Collections API which is unavailable in standalone mode.
Changes:
For Solr 9.x: start with '-c' flag (bin/solr start -c or docker run ... solr:9 -c). For Solr 10.0.0+: SolrCloud is the default; no extra flag needed. The provisioning pipelines (docker, from-distribution, from-sources) already start Solr with cloud mode for all versions.
Closes #33