SOLR-17674: Refresh bin/solr instructions to down play SolrCloud and introduce --user-managed example. #3190
Conversation
Downplay SolrCloud mode, and make sure to introduce how to run User Managed mode. Reference standalone since most folks know it as that.
| @@ -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,"); | |||
There was a problem hiding this comment.
[-1] What is "Standalone server example" doing in this list of bin/solr subcommands?
| 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:"); |
There was a problem hiding this comment.
[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
There was a problem hiding this comment.
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)
|
I pushed up an edit. What do you think about moving the |
| print(""); | ||
| print(" Standalone server example (start Solr running in the background on port 8984):"); | ||
| print(" Start Solr on default port 8983:"); |
There was a problem hiding this comment.
I think I’m fine with --user-managed being second. Between the help-text ordering and the “user-managed” name itself (which IMO correctly implies more responsibility+work for the user) - we’re giving new users a pretty substantial nudge towards SolrCloud. Personally, I think that’s great.
But I'm a little uncomfortable with the wording that's here in the “first spot”. It doesn't really clarify the mode one way or another. And that feels a little dangerous in a release that also happens to switch the "default" mode! 90% of users coming from 9.x standalone will read that and (incorrectly) miss that the default mode has changed.
Please consider adding a tweak here so that the "First spot" does something to indicate the mode ("SolrCloud", mention ZooKeeper, etc.)
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.