Skip to content
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.

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

SOLR-17674: Refresh bin/solr instructions to down play SolrCloud and introduce --user-managed example. #3190

Open
wants to merge 4 commits into
base: main
Choose a base branch
from

Conversation

epugh
Copy link
Contributor

@epugh epugh commented Feb 16, 2025

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

Description

Update the examples for starting solr when bin/solr is run.

Solution

Down play SolrCloud mode (it's the default anyway), and add a example of how to start up in User Managed aka Standalone mode.

Downplay SolrCloud mode, and make sure to introduce how to run User Managed mode.   Reference standalone since most folks know it as that.
@epugh epugh requested a review from gerlowskija February 25, 2025 14:01
Copy link
Contributor

@gerlowskija gerlowskija left a comment

Choose a reason for hiding this comment

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

MInor typo/copy-paste error that needs addressed

@@ -409,23 +409,27 @@ private static void printHelp() {
print(
" healthcheck, create, delete, auth, assert, config, export, api, package, post, stream,");
print(
" zk ls, zk cp, zk rm , zk mv, zk mkroot, zk upconfig, zk downconfig,");
" zk ls, zk cp, zk rm , zk mvStandalone server example, zk mkroot, zk upconfig, zk downconfig,");
Copy link
Contributor

Choose a reason for hiding this comment

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

[-1] What is "Standalone server example" doing in this list of bin/solr subcommands?

Copy link
Contributor Author

Choose a reason for hiding this comment

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

copy paste issue!

print(
" snapshot-create, snapshot-list, snapshot-delete, snapshot-export, snapshot-prepare-export");
print("");
print(" Standalone server example (start Solr running in the background on port 8984):");
print(" Start Solr running in the background on port 8984:");
Copy link
Contributor

Choose a reason for hiding this comment

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

[0] IMO the lead-in to this example should make some reference either to the "mode" or the ZK that will be used. Especially since this behavior changed in Solr 10, a user coming from Solr 9 could read this snippet and be none-the-wiser that they're about to run SolrCloud.

Also, is the "in the background" bit worth retaining?

Perhaps:

Start Solr with its own "embedded" ZooKeeper

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 agree, the background isn't important, and in fact what you would assume! Also, this I think is the crux of the cahnge. Yes user from Solr 9, you dn't have to be any the wiser that you are running SolrCloud. This is the downplaying of SolrCloud (and it's attendent baggage ZK)

@epugh
Copy link
Contributor Author

epugh commented Feb 26, 2025

I pushed up an edit. What do you think about moving the --user-managed example up to the first point? It's there for the Standalone folks.... Even though I want it to be much less apparent? 🤔

Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Projects
None yet
Development

Successfully merging this pull request may close these issues.

2 participants