[SOLR-16757] Umbrella Ticket for Revamping Solr CLI's for the Future

• Type: Task
• Status: Open
• Priority: Minor
• Resolution: Unresolved
• Component/s: cli
• Assignee: Eric Pugh
• Reporter: Eric Pugh
• Created: 20/Apr/23 17:42
• Updated: 04/Nov/24 12:30

Description

This is to guide me in revamping the Solr CLI functions by tracking a set of JIRA's. It's to help me figure out which I am going to work on and which I am not.

Issue Links

• is a parent of: SOLR-7871 Platform independent config file instead of solr.in.sh and solr.in.cmd
• is a parent of: SOLR-16791 Write an all-java replacement for bin/solr and bin\solr.cmd.
• is a parent of: SOLR-17383 CLI: Resolve overlapping arguments
• is related to: SOLR-17029 SOLR_OPTS and '-a' both break with quoted/escaped whitespace
• is related to: SOLR-13422 bin/post command not working when run from crontab
• is related to: SOLR-16900 Add/fix wrong/missing "solr.home" to zkcli scripts
• is related to: SOLR-17367 org.apache.solr.cli.PostTool is ignoring -params option
• is related to: SOLR-16973 Fix REMOTE_JMX_OPTS not working on Windows
• is related to: SOLR-10189 Add a solr zk clusterprop command
• is related to: SOLR-15152 Export Tool should export nested docs cleanly in .json, .jsonl, and javabin
• is related to: SOLR-16790 Umbrella - Improve Solr CLI tools
• is related to: SOLR-17383 CLI: Resolve overlapping arguments
• is related to: SOLR-3913 SimplePostTool optimize does a redundant commit
• is related to: SOLR-6962 bin/solr stop/start/restart should complain about missing value for options that expect a value.
• is related to: SOLR-17017 Running an example using Solr start -e should be repeatable
• is related to: SOLR-11318 Add tests for AssertTool
• relates to: SOLR-16504 Convert CLI tools to Jetty HTTP 2 client.
• relates to: SOLR-16754 Change the bin/solr -info logic to work like other tools.
• relates to: SOLR-7962 Passing additional arguments to solr.cmd using "-a" does not work on Windows
• relates to: SOLR-17429 Find more permanent solution to Deprecated SolrCLI logging
• relates to: SOLR-15441 Solr.cmd fails when SOLR_LOGS_DIR contains a space
• relates to: SOLR-16254 solr standalone: in-correct information in the help message for "bin/solr create_core"
• relates to: SOLR-15771 bin/solr auth enable should model best practices for security.json
• relates to: SOLR-16619 `solr status` and `solr create` do not work on IBM i
• relates to: SOLR-11611 Starting Solr using solr.cmd fails under Windows, when the path contains a parenthesis character
• relates to: SOLR-14496 Add basic auth support to SolrCLI commands
• relates to: SOLR-14673 Add CLI for Streaming Expressions
• relates to: SOLR-10772 Add support for replica types in CLI
• relates to: SOLR-13071 Add JWT Auth support in bin/solr
• relates to: SOLR-16620 Solr CLI should be able to do a node healthcheck
• relates to: SOLR-10645 bin/solr auth command should support standalone solr
• relates to: SOLR-14882 bin/solr export refers to .json but actually uses .jsonl
• relates to: SOLR-17159 Remove bin/post and bin/postlogs scripts and keep only bin/solr equivalents
• relates to: SOLR-16645 Support ss and netstat as alternatives to lsof
• relates to: SOLR-11206 Migrate logic from bin/solr scripts to SolrCLI
• relates to: SOLR-14115 Deprecate zkcli.sh
• relates to: SOLR-15831 Refactor bin/solr and bin/solr.cmd to delegate args parsing and usage help to SolrCLI
• relates to: SOLR-6994 Implement Windows version of bin/post via implementing bin/solr post command that works on Windows and Unix
• relates to: SOLR-16711 Seperate tools out of SolrCLI.java into their own files.
• relates to: SOLR-16996 Move Solr Exporter for Prometheus CLI to commons-cli
• relates to: SOLR-16922 Scripts wrongly prohibit embedded zookeeper when solr port is between 55535 and 64535
• relates to: SOLR-11749 regression-test-like functionality for bin/solr*
• relates to: SOLR-7233 rename zkcli.sh script it clashes with zkCli.sh from ZooKeeper on Mac when both are in $PATH

Sub-Tasks

• bin/solr package -h doesn't work: Closed
• Document bin/solr api command: Closed
• Fix docs about export and non solrcloud mode: Closed
• Be clearer that bin/solr export uses JSONL, not JSON format. Fix up how files are named and output and add tests.: Closed
• Export tool doesn't properly count the number of exported docs.: Closed
• Remove -usage as option, and ensure both -help and -h work: Closed
• Move SolrCLI.getSolrParamsFromUri to ApiTool: Closed
• Skip check for local solr's running in bin/solr package: Closed
• Umm... what is bin/solr cp ???: Resolved
• Resolve the bin/solr zk cp and bin/solr cp conundrum: Closed
• Export tool should export in JSON that matches Solr Import Format: Closed
• Return exit codes from CLI tools: Open
• Migrate detailed help/examples/tips from Solr CLI -h output to Ref Guide: Closed
• Remove the bin/solr -f pattern in favour of bin/solr start -f explicit command.: Resolved
• Allow create and delete to use -url instead of -c and work with remote solr.: Resolved
• Remove use of SimplePostTool from Solr code base like RunExampleTool: Closed
• Make all boolean options not take a true/false but just the -option be enough.: Open
• change hostname parameter on start and restart to only be -host, no -h: Resolved
• Deprecate the legacy zk command actions like -upconfig: Resolved
• Adopt Linux Command line tool pattern of -- for multi character commands.: Closed
• Healthcheck tool is Broken!: Closed
• Eliminate special case code in solrCLI by introducing VersionTool: Closed
• Flag to users that bin/solr heathcheck doesn't work with non solrcloud: Resolved
• Resolve Fate of bin/post and the SimplePostTool code base.: Resolved
• Migrate PostLogs into bin/solr postlogs infrastructure.: Closed
• Make "create" be Standalone/Cloud Aware: Resolved
• Remove create_core and create_collection from main (solr 10): Resolved
• Ensure Major Changes in Solr 10 Updated for CLI Changes: Resolved
• Use -solrUrl to derive the zk host connection for bin/solr zk subcommands: Closed
• Allow users to pass system properties when running the Solr tool.: Closed
• Improve Solr Host defaulting in the SolrCLI: Closed
• bin/solr stop -p doesn't work: Closed
• AssertTool has lots of static methods: Open
• Migrate Ref Guide content to using bin/solr post command: Closed
• bin/solr post -h is odd message: Resolved
• To commit or not to commit? That is the question on bin/solr post: Closed
• solr-in-docker.adoc needs updating for bin/solr post changes: Resolved
• bin/solr start -c -e films loads more than jsut films data: Closed
• Move CreateCoreTool and CreateCollectionTool logic into CreateTool: Resolved
• commit to mixedCase cli options or dashed-case cli options: Resolved
• Eliminate create_collection as a command in ref guide...: Resolved
• ensure bin/solr start is used not bin/solr for starting in ref guide.: Closed
• Migrate snapshotscli.sh code into bin/solr and hdfs module code: Resolved
• CloudHttp2SolrClient doesn't properly use httpClient Builder on certain paths: Closed
• Don't warn users about the /solr in the url when we look it up direct from zk: Closed
• Bug in messaging when creating a collection, and then you can't actually call the config method to set-user-property: Closed
• bin/solr version should take a -z or -s and return actual version.: Open
• Update bats test to remove /solr from solr Urls.: Closed
• Remove last vestiges of post.jar from main: Resolved
• Merge windows and linux examples in ref guide for post tool: Closed
• Change missing zkHost/solrUrl to system.err: Closed
• Randomize short/long opts usage in Java-based CLI tests: Open
• Should bin/solr allow short/long opts consistently?: Resolved
• Remove deprecated commands from CLI, such as -zkHost.: Resolved
• Improve default --help formatting for CLI Tools, make configurable: Closed
• Forward port relevant CLI changes from branch_9x: Resolved
• Consolidate Duplicate Unit Tests between ZkSubcommandsTest and SolrCLIZkToolsTest: Resolved
• CLI: Deprecate addlopts in RunExampleTool.java: Resolved
• Update ExportTool's argument representation: Resolved
• Remove deprecated snapshotscli.sh from main: Resolved
• Figure out Sub Command pattern between zk, snapshots, package, and auth: Open
• Restructure Ref Guide Page Solr Control Script Reference: Open
• Tweak Tool.java to support the sub command use case: Resolved
• Use getOptionWithDeprecatedAndDefault in all places in CLI.: Resolved
• Pull in refactorings and code cleanups from fix_command_line_options_9_7: Resolved
• bin/solr.cmd run_zk method can be drastically simplified: Resolved
• Change CLI DeleteTool deleting of configs to opt in instead of default behavior: Resolved
• Change PostTool -out to be --verbose instead.: Resolved
• Change PackageTool -c and --collection to -c and --name?: Resolved
• Add -y as short form of --no-prompt to RunExampleTool: Resolved
• Fix error message on 9x for PostTool and secure solr.: Resolved
• Rearrange and cleanup solr.cmd: Resolved
• Prevent conflicting connection options(-s and -z) from being used: Resolved
• Embed tool --help output into RefGuide: Open