Skip to content

SOLR-18526: Fix the start commands in the SSL guide - #5121

Merged
epugh merged 5 commits into
apache:mainfrom
serhiy-bzhezytskyy:SOLR-18526-start-commands
Oct 21, 2026
Merged

epugh merged 5 commits into
apache:mainfrom
serhiy-bzhezytskyy:SOLR-18526-start-commands

Conversation

@serhiy-bzhezytskyy

@serhiy-bzhezytskyy serhiy-bzhezytskyy commented Oct 13, 2026 •

Copy link
Copy Markdown
Contributor

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

Description

bin\solr.cmd needs the start subcommand, and two Windows examples in the SSL guide leave it out. The standalone example, bin/solr start -p 8984, starts SolrCloud, because --user-managed is missing.

Solution

start added to the two Windows examples, --user-managed to the two standalone ones. The system info page said "the mode Solr is running in standalone mode"; it now says what std means.

Written with Claude Code.

Checklist

  • I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • I have created a Jira issue and added the issue ID to my pull request title.
  • I have given Solr maintainers access to contribute to my PR branch. (optional but recommended, not available for branches on forks living under an organisation)
  • I have developed this patch against the main branch.
  • I have run ./gradlew check.
  • I have added tests for my changes.
  • I have added documentation for the Reference Guide
  • I have added a changelog entry for my change

Since Solr 10 a bare `bin/solr start` starts SolrCloud, so the SSL page's
user-managed example needs `--user-managed`; `solr.cmd` ignores a command
that does not begin with `start`. The mode was also called "standalone" and
"User Managed" in places; the guide's own cluster-types page names it
user-managed.
@github-actions github-actions Bot added the documentation Improvements or additions to documentation label Oct 13, 2026

@epugh epugh left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

I like the consistency... And as I look at our weird straddeling of "user managed / standalone" phrasing, I like the elimination of "standalone", because our start param is --user-managed. Having said that, I wish we had bin/solr start --standalone, but that would be something new to discuss.


[%hardbreaks]
# Start in user managed mode
# Start in user-managed mode

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

Not sure we need the dash here?

[source,powershell]
----
bin\solr.cmd --solr-home cloud\node1 -z server1:2181,server2:2181,server3:2181
bin\solr.cmd start --solr-home cloud\node1 -z server1:2181,server2:2181,server3:2181

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

nice!

==== User-Managed Mode

`bin/solr start --user-managed` starts Solr in User Managed mode (AKA Standalone mode). This was the default mode up until Solr 10x.
`bin/solr start --user-managed` starts Solr in user-managed mode (also called standalone mode). This was the default mode up until Solr 10x.

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

i like this better phrasing better. AKA was werid. Having said that, I wonder if using the phrase "user-managed" versus "User Managed" is the way to go. I mean, maybe? What about "in user managed mode". DO we need the dash? We have it in the bin/solr start --user-managed, but maybe we don't need it hyponentaed everywhere?

====

V2 API User-Managed / Standalone Solr::
V2 API User-Managed::

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

This really does read much nicer...

@epugh

epugh commented Oct 13, 2026

Copy link
Copy Markdown
Contributor

@dsmiley I seem to recall you had strong opinons about "user managed" versus "standalone". This PR really shifts us towards the "user managed" name, and reduces the use of the word "Standalone". I'd love your input. Do we want to relitigate the name, and maybe even change bin/solr start to being --standalone instead of --user-managed?

@epugh epugh added this to the 10.x milestone Oct 13, 2026
@epugh epugh self-assigned this Oct 13, 2026
checkCliDocsUpToDate fails when the .adoc terminology differs from the picocli source.

@dsmiley dsmiley left a comment

Copy link
Copy Markdown
Contributor

Choose a reason for hiding this comment

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

The degree to which I hate the over-use of "user managed" I see here really gets to me to perhaps irrational levels but I'm being honest. This really animates me! Sorry I must veto this.

I am bringing this to the list.

@epugh

epugh commented Oct 14, 2026

Copy link
Copy Markdown
Contributor

That is why I tagged you! I think we need to finally resolve this naming conundrum.

…ands

# Conflicts:
#	solr/solr-ref-guide/modules/deployment-guide/pages/user-managed-index-replication.adoc
@epugh

epugh commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

@serhiy-bzhezytskyy okay, we have a sharp u-turn being performed! BAsed on https://lists.apache.org/thread.html/y6x19tr56d1s3t7klk2jmsbxsfn3dmoj we are going with --standalone and "standalone" terminology and erradication "user managed". We need to keep --user-managed for any 10.0 users, but it's deprecated and can be removed in solr 11....

I don't know if you want to update this PR or close and make a new one????

@epugh

epugh commented Oct 21, 2026

Copy link
Copy Markdown
Contributor

also, I notice the title is SOLR-18526, but myabe this is actually fixing SOLR-18500?

The Windows examples left out the start subcommand, which bin\solr.cmd
requires, and the standalone example started SolrCloud because it lacked
--user-managed.
@serhiy-bzhezytskyy serhiy-bzhezytskyy changed the title SOLR-18526: Use "user-managed" for the mode and fix the start commands SOLR-18526: Fix the start commands in the SSL guide Oct 21, 2026
@serhiy-bzhezytskyy

Copy link
Copy Markdown
Contributor Author

Thanks for spotting that: the description was the text of #5120 (SOLR-18500). Reworked: the terminology changes are gone and only the start-command fixes remain, so SOLR-18526 stays. I'll leave the rename to your change.

@github-actions github-actions Bot removed the cat:cli label Oct 21, 2026
@epugh
epugh merged commit 4422d26 into apache:main Oct 21, 2026
3 checks passed
dsmiley pushed a commit that referenced this pull request Oct 22, 2026
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment

Labels

documentation Improvements or additions to documentation

Projects

None yet

Development

Successfully merging this pull request may close these issues.

3 participants