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-17068: Resolve mish mash of bin/post and bin/solr post references in favour of bin/solr post. #2227

Merged
merged 12 commits into from
Feb 2, 2024

Conversation

epugh
Copy link
Contributor

@epugh epugh commented Jan 28, 2024

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

Description

Removing old bin/post references.

Solution

Clean ups through out docs and code base.

Tests

Bats and unit tests.

Checklist

Please review the following and check all that apply:

  • [X ] I have reviewed the guidelines for How to Contribute and my code conforms to the standards described there to the best of my ability.
  • [X ] I have created a Jira issue and added the issue ID to my pull request title.
  • [ X] I have given Solr maintainers access to contribute to my PR branch. (optional but recommended)
  • [ X] I have developed this patch against the main branch.
  • [ X] I have run ./gradlew check.
  • [ X] I have added tests for my changes.
  • [ X] I have added documentation for the Reference Guide

@github-actions github-actions bot added documentation Improvements or additions to documentation examples prometheus-exporter labels Jan 28, 2024
@github-actions github-actions bot added the docker Docker image label Jan 29, 2024
@epugh
Copy link
Contributor Author

epugh commented Jan 29, 2024

Just tested that bin/post still works!

@dsmiley
Copy link
Contributor

dsmiley commented Jan 30, 2024

Maybe I'm being grumpy but I like to think of the unfortunate addition of "post" to bin/solr as an implementation detail out of convenience to make multi-platform and general supportability easier for bin/post. Does this mean we don't want users to use bin/post either? I think not.

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.

The large majority of the changes here make sense to me - we're moving away from bin/post in 10.0 so we want to shift documentation and other usage in that direction. That all fits the title of the PR.

But I'm seeing some other changes here too - loosening some Option declarations in PostTool.java, re-adding support for the 'c' parameter. Can you add some context around these changes?

Are those follow-on changes from some prior PR? Are they only done here to accommodate some of the new bin/solr post call sites?

@epugh
Copy link
Contributor Author

epugh commented Jan 30, 2024

Thanks for asking about the other changes. So what I was finding was that the -c usage was everywhere, and that we even have explicit support now in the SolrCLI to look up SOLR_PORT, SOLR_HOST, SOLR_SCHEME from your environment, which is there to make the -c option work better, and that forcing everyone to use -url was just too big of a change... I decided that eliminating the -c was actually a step backwards for the user experience, especially when OTHER commands support it... It definitely made reading the ref guide docs much harder... to support -c, then I had to loosen the Option. The other changes are bug fixes that i found while actually testing out the code!

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.

OK, makes sense. Do we need to document that change of strategy somewhere other than SOLR-17068? Maybe that's good enough 🤷

Anyway, LGTM.

@epugh
Copy link
Contributor Author

epugh commented Jan 30, 2024

Maybe I'm being grumpy but I like to think of the unfortunate addition of "post" to bin/solr as an implementation detail out of convenience to make multi-platform and general supportability easier for bin/post. Does this mean we don't want users to use bin/post either? I think not.

I think that is EXACTLY what we want. no more bin/post and no more bin/postlogs either... Neighter of them supports basic auth for example... Neighter of them picks up SOLR_PORT, SOLR_HOST, etc variables... each has weird special logic to make them executable... Now, in the future, if someone wants to make a better CLI thatn bin/solr, or break it up into bin/server and bin/client, sure... but yeah, in the short term, no more bin/post and no more bin/postlogs.

@gerlowskija
Copy link
Contributor

Yeah, I thought that was the whole point - bin/solr post gets us a bunch of things that bin/post doesn't, we don't want to maintain them both indefinitely, so we should standardize and deprecate.

Is there a reason we wouldn't converge across docs and test-usage in this case?

@epugh epugh merged commit 6e431cf into apache:main Feb 2, 2024
4 of 5 checks passed
epugh added a commit that referenced this pull request Feb 2, 2024
…s in favour of bin/solr post. (#2227)

* update various examples to use bin/solr post instead of bin/post.

* Restore the -c parameter to the post tool, and ensure it picks up default urls settings if specified.

* Remove special text about how to use tool on Windows as no longer needed

* move all our docker testing and actual docker scripts to using bin/solr post command instead of bin/post
epugh added a commit that referenced this pull request Feb 2, 2024
…s in favour of bin/solr post. (#2227)

* update various examples to use bin/solr post instead of bin/post.

* Restore the -c parameter to the post tool, and ensure it picks up default urls settings if specified.

* Remove special text about how to use tool on Windows as no longer needed

* move all our docker testing and actual docker scripts to using bin/solr post command instead of bin/post
Sign up for free to join this conversation on GitHub. Already have an account? Sign in to comment
Labels
docker Docker image documentation Improvements or additions to documentation examples prometheus-exporter
Projects
None yet
Development

Successfully merging this pull request may close these issues.

3 participants