You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@solr.apache.org by ho...@apache.org on 2023/08/22 15:24:21 UTC
[solr] branch branch_9x updated: SOLR-16941: Use smarter default Solr URL in CLI (#1849)
This is an automated email from the ASF dual-hosted git repository.
houston pushed a commit to branch branch_9x
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/branch_9x by this push:
new 1dde8a90c3c SOLR-16941: Use smarter default Solr URL in CLI (#1849)
1dde8a90c3c is described below
commit 1dde8a90c3c81417f84529401de1dfc582901705
Author: Houston Putman <ho...@apache.org>
AuthorDate: Fri Aug 18 16:21:00 2023 -0400
SOLR-16941: Use smarter default Solr URL in CLI (#1849)
(cherry picked from commit 7f2f6dc6f2d38cde3211a89f8859add791d74060)
---
solr/CHANGES.txt | 2 +
solr/bin/solr | 22 ++++---
.../java/org/apache/solr/cli/CreateCoreTool.java | 2 +-
.../src/java/org/apache/solr/cli/CreateTool.java | 2 +-
.../src/java/org/apache/solr/cli/DeleteTool.java | 2 +-
.../src/java/org/apache/solr/cli/PackageTool.java | 6 +-
.../core/src/java/org/apache/solr/cli/SolrCLI.java | 68 +++++++++++++++-------
.../src/java/org/apache/solr/cli/StatusTool.java | 4 +-
solr/packaging/test/test_ssl.bats | 4 +-
9 files changed, 72 insertions(+), 40 deletions(-)
diff --git a/solr/CHANGES.txt b/solr/CHANGES.txt
index 56272a5fd33..5e70873a296 100644
--- a/solr/CHANGES.txt
+++ b/solr/CHANGES.txt
@@ -39,6 +39,8 @@ Improvements
* SOLR-16927: Allow SolrClientCache clients to use Jetty HTTP2 clients (Alex Deparvu, David Smiley)
+* SOLR-16941: The SolrCLI now uses a smarter default for the Solr URL if none is provided, using the same envVars used when running Solr. (Houston Putman)
+
Optimizations
---------------------
diff --git a/solr/bin/solr b/solr/bin/solr
index 588741fc67a..e168696f0e2 100644
--- a/solr/bin/solr
+++ b/solr/bin/solr
@@ -147,6 +147,11 @@ fi
: "${SOLR_STOP_WAIT:=180}"
: "${SOLR_START_WAIT:=$SOLR_STOP_WAIT}" # defaulting to $SOLR_STOP_WAIT for backwards compatibility reasons
+# Store whether a solr port was explicitly provided, for the "solr stop" command.
+PROVIDED_SOLR_PORT="${SOLR_PORT:-}"
+: "${SOLR_PORT:=8983}"
+export SOLR_PORT
+
# test that Java exists, is executable and correct version
JAVA_VER=$("$JAVA" -version 2>&1)
# shellcheck disable=SC2181
@@ -278,6 +283,7 @@ if [ "$SOLR_SSL_ENABLED" == "true" ]; then
else
SOLR_JETTY_CONFIG+=("--module=http")
fi
+export SOLR_URL_SCHEME
# Requestlog options
if [ "${SOLR_REQUESTLOG_ENABLED:-true}" == "true" ]; then
@@ -330,6 +336,7 @@ AUTHC_OPTS="${AUTHC_OPTS:-}${SOLR_AUTHENTICATION_OPTS:+ $SOLR_AUTHENTICATION_OPT
# Set the SOLR_TOOL_HOST variable for use when connecting to a running Solr instance
SOLR_TOOL_HOST="${SOLR_HOST:-localhost}"
+export SOLR_TOOL_HOST
function print_usage() {
CMD="${1:-}"
@@ -689,7 +696,7 @@ function print_usage() {
echo ""
elif [ "$CMD" == "package" ]; then
echo ""
- run_tool package -solrUrl "http://fake.to.allow.help.to.run" "help"
+ run_tool package "help"
fi
} # end print_usage
@@ -1912,8 +1919,8 @@ fi
: "${STOP_KEY:=solrrocks}"
-# stop all if no port specified
-if [[ "$SCRIPT_CMD" == "stop" && -z "${SOLR_PORT:-}" ]]; then
+# stop all if no port specified or "all" is used
+if [[ "$SCRIPT_CMD" == "stop" ]]; then
if $stop_all; then
none_stopped=true
find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | while read PIDF
@@ -1931,8 +1938,9 @@ if [[ "$SCRIPT_CMD" == "stop" && -z "${SOLR_PORT:-}" ]]; then
# if $none_stopped; then
# echo -e "\nNo Solr nodes found to stop.\n"
# fi
- else
- # not stopping all and don't have a port, but if we can find the pid file for the default port 8983, then use that
+ exit
+ elif [[ -z "${PROVIDED_SOLR_PORT:-}" ]]; then
+ # not stopping all and don't have a port, but if we can find a single pid file for Solr, then use that
none_stopped=true
numSolrs=$(find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | wc -l | tr -d ' ')
if [ "$numSolrs" -eq 1 ]; then
@@ -1956,12 +1964,10 @@ if [[ "$SCRIPT_CMD" == "stop" && -z "${SOLR_PORT:-}" ]]; then
fi
exit 1
fi
+ exit
fi
- exit
fi
-: "${SOLR_PORT:=8983}"
-
if [ -n "${SOLR_PORT_ADVERTISE:-}" ]; then
SOLR_OPTS+=("-Dsolr.port.advertise=$SOLR_PORT_ADVERTISE")
fi
diff --git a/solr/core/src/java/org/apache/solr/cli/CreateCoreTool.java b/solr/core/src/java/org/apache/solr/cli/CreateCoreTool.java
index 0efcb5bfb7e..d21f2a17fd8 100644
--- a/solr/core/src/java/org/apache/solr/cli/CreateCoreTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/CreateCoreTool.java
@@ -80,7 +80,7 @@ public class CreateCoreTool extends ToolBase {
@Override
public void runImpl(CommandLine cli) throws Exception {
- String solrUrl = cli.getOptionValue("solrUrl", SolrCLI.DEFAULT_SOLR_URL);
+ String solrUrl = cli.getOptionValue("solrUrl", SolrCLI.getDefaultSolrUrl());
if (!solrUrl.endsWith("/")) solrUrl += "/";
File configsetsDir = new File(cli.getOptionValue("configsetsDir"));
diff --git a/solr/core/src/java/org/apache/solr/cli/CreateTool.java b/solr/core/src/java/org/apache/solr/cli/CreateTool.java
index e3933928607..70dece3a487 100644
--- a/solr/core/src/java/org/apache/solr/cli/CreateTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/CreateTool.java
@@ -49,7 +49,7 @@ public class CreateTool extends ToolBase {
@Override
public void runImpl(CommandLine cli) throws Exception {
SolrCLI.raiseLogLevelUnlessVerbose(cli);
- String solrUrl = cli.getOptionValue("solrUrl", SolrCLI.DEFAULT_SOLR_URL);
+ String solrUrl = cli.getOptionValue("solrUrl", SolrCLI.getDefaultSolrUrl());
if (!solrUrl.endsWith("/")) solrUrl += "/";
ToolBase tool;
diff --git a/solr/core/src/java/org/apache/solr/cli/DeleteTool.java b/solr/core/src/java/org/apache/solr/cli/DeleteTool.java
index 78e36416d05..c8debf07173 100644
--- a/solr/core/src/java/org/apache/solr/cli/DeleteTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/DeleteTool.java
@@ -90,7 +90,7 @@ public class DeleteTool extends ToolBase {
@Override
public void runImpl(CommandLine cli) throws Exception {
SolrCLI.raiseLogLevelUnlessVerbose(cli);
- String solrUrl = cli.getOptionValue("solrUrl", SolrCLI.DEFAULT_SOLR_URL);
+ String solrUrl = cli.getOptionValue("solrUrl", SolrCLI.getDefaultSolrUrl());
if (!solrUrl.endsWith("/")) solrUrl += "/";
try (var solrClient = SolrCLI.getSolrClient(solrUrl)) {
diff --git a/solr/core/src/java/org/apache/solr/cli/PackageTool.java b/solr/core/src/java/org/apache/solr/cli/PackageTool.java
index c0e0c08e660..d7dcb20d4d7 100644
--- a/solr/core/src/java/org/apache/solr/cli/PackageTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/PackageTool.java
@@ -84,7 +84,7 @@ public class PackageTool extends ToolBase {
return;
}
- solrUrl = cli.getOptionValues("solrUrl")[cli.getOptionValues("solrUrl").length - 1];
+ solrUrl = cli.getOptionValue("solrUrl", SolrCLI.getDefaultSolrUrl());
solrBaseUrl = solrUrl.replaceAll("/solr$", ""); // strip out ending "/solr"
log.info("Solr url:{}, solr base url: {}", solrUrl, solrBaseUrl);
String zkHost = getZkHost(cli);
@@ -321,10 +321,10 @@ public class PackageTool extends ToolBase {
Option.builder("solrUrl")
.argName("URL")
.hasArg()
- .required(true)
+ .required(false)
.desc(
"Address of the Solr Web application, defaults to: "
- + SolrCLI.DEFAULT_SOLR_URL
+ + SolrCLI.getDefaultSolrUrl()
+ '.')
.build(),
Option.builder("collections")
diff --git a/solr/core/src/java/org/apache/solr/cli/SolrCLI.java b/solr/core/src/java/org/apache/solr/cli/SolrCLI.java
index a11fc7bdfa6..31960a262ac 100755
--- a/solr/core/src/java/org/apache/solr/cli/SolrCLI.java
+++ b/solr/core/src/java/org/apache/solr/cli/SolrCLI.java
@@ -73,7 +73,7 @@ public class SolrCLI implements CLIO {
TimeUnit.NANOSECONDS.convert(1, TimeUnit.MINUTES);
private static final Logger log = LoggerFactory.getLogger(MethodHandles.lookup().lookupClass());
- public static final String DEFAULT_SOLR_URL = "http://localhost:8983/solr";
+
public static final String ZK_HOST = "localhost:9983";
public static final Option OPTION_ZKHOST =
@@ -91,7 +91,7 @@ public class SolrCLI implements CLIO {
.required(false)
.desc(
"Base Solr URL, which can be used to determine the zkHost if that's not known; defaults to: "
- + DEFAULT_SOLR_URL)
+ + getDefaultSolrUrl())
.build();
public static final Option OPTION_VERBOSE =
Option.builder("verbose").required(false).desc("Enable more verbose command output.").build();
@@ -189,6 +189,22 @@ public class SolrCLI implements CLIO {
return cli;
}
+ public static String getDefaultSolrUrl() {
+ String scheme = System.getenv("SOLR_URL_SCHEME");
+ if (scheme == null) {
+ scheme = "http";
+ }
+ String host = System.getenv("SOLR_TOOL_HOST");
+ if (host == null) {
+ host = "localhost";
+ }
+ String port = System.getenv("SOLR_PORT");
+ if (port == null) {
+ port = "8983";
+ }
+ return String.format(Locale.ROOT, "%s://%s:%s", scheme.toLowerCase(Locale.ROOT), host, port);
+ }
+
protected static void checkSslStoreSysProp(String solrInstallDir, String key) {
String sysProp = "javax.net.ssl." + key;
String keyStore = System.getProperty(sysProp);
@@ -521,21 +537,26 @@ public class SolrCLI implements CLIO {
String solrUrl = cli.getOptionValue("solrUrl");
if (solrUrl == null) {
String zkHost = cli.getOptionValue("zkHost");
- if (zkHost == null)
- throw new IllegalStateException(
- "Must provide either the '-solrUrl' or '-zkHost' parameters!");
-
- try (CloudSolrClient cloudSolrClient =
- new CloudHttp2SolrClient.Builder(Collections.singletonList(zkHost), Optional.empty())
- .build()) {
- cloudSolrClient.connect();
- Set<String> liveNodes = cloudSolrClient.getClusterState().getLiveNodes();
- if (liveNodes.isEmpty())
- throw new IllegalStateException(
- "No live nodes found! Cannot determine 'solrUrl' from ZooKeeper: " + zkHost);
-
- String firstLiveNode = liveNodes.iterator().next();
- solrUrl = ZkStateReader.from(cloudSolrClient).getBaseUrlForNodeName(firstLiveNode);
+ if (zkHost == null) {
+ solrUrl = SolrCLI.getDefaultSolrUrl();
+ CLIO.getOutStream()
+ .println(
+ "Neither -zkHost or -solrUrl parameters provided so assuming solrUrl is "
+ + solrUrl
+ + ".");
+ } else {
+ try (CloudSolrClient cloudSolrClient =
+ new CloudHttp2SolrClient.Builder(Collections.singletonList(zkHost), Optional.empty())
+ .build()) {
+ cloudSolrClient.connect();
+ Set<String> liveNodes = cloudSolrClient.getClusterState().getLiveNodes();
+ if (liveNodes.isEmpty())
+ throw new IllegalStateException(
+ "No live nodes found! Cannot determine 'solrUrl' from ZooKeeper: " + zkHost);
+
+ String firstLiveNode = liveNodes.iterator().next();
+ solrUrl = ZkStateReader.from(cloudSolrClient).getBaseUrlForNodeName(firstLiveNode);
+ }
}
}
return solrUrl;
@@ -551,11 +572,14 @@ public class SolrCLI implements CLIO {
// find it using the localPort
String solrUrl = cli.getOptionValue("solrUrl");
- if (solrUrl == null)
- throw new IllegalStateException(
- "Must provide either the -zkHost or -solrUrl parameters to use the create_collection command!");
-
- if (!solrUrl.endsWith("/")) solrUrl += "/";
+ if (solrUrl == null) {
+ solrUrl = getDefaultSolrUrl();
+ CLIO.getOutStream()
+ .println(
+ "Neither -zkHost or -solrUrl parameters provided so assuming solrUrl is "
+ + solrUrl
+ + ".");
+ }
try (var solrClient = getSolrClient(solrUrl)) {
// hit Solr to get system info
diff --git a/solr/core/src/java/org/apache/solr/cli/StatusTool.java b/solr/core/src/java/org/apache/solr/cli/StatusTool.java
index 9d771e38132..44eac2cbdce 100644
--- a/solr/core/src/java/org/apache/solr/cli/StatusTool.java
+++ b/solr/core/src/java/org/apache/solr/cli/StatusTool.java
@@ -62,7 +62,7 @@ public class StatusTool extends ToolBase {
.required(false)
.desc(
"Address of the Solr Web application, defaults to: "
- + SolrCLI.DEFAULT_SOLR_URL
+ + SolrCLI.getDefaultSolrUrl()
+ '.')
.build(),
Option.builder("maxWaitSecs")
@@ -76,7 +76,7 @@ public class StatusTool extends ToolBase {
@Override
public void runImpl(CommandLine cli) throws Exception {
int maxWaitSecs = Integer.parseInt(cli.getOptionValue("maxWaitSecs", "0"));
- String solrUrl = cli.getOptionValue("solr", SolrCLI.DEFAULT_SOLR_URL);
+ String solrUrl = cli.getOptionValue("solr", SolrCLI.getDefaultSolrUrl());
if (maxWaitSecs > 0) {
int solrPort = (new URL(solrUrl)).getPort();
echo("Waiting up to " + maxWaitSecs + " seconds to see Solr running on port " + solrPort);
diff --git a/solr/packaging/test/test_ssl.bats b/solr/packaging/test/test_ssl.bats
index 3e53a7c6b29..9f3fdfe806c 100644
--- a/solr/packaging/test/test_ssl.bats
+++ b/solr/packaging/test/test_ssl.bats
@@ -54,8 +54,8 @@ teardown() {
solr start -c
solr assert --started https://localhost:8983/solr --timeout 5000
- run curl --cacert "$ssl_dir/solr-ssl.pem" 'https://localhost:8983/solr/admin/collections?action=CREATE&collection.configName=_default&name=test&numShards=2&replicationFactor=1&router.name=compositeId&wt=json'
- assert_output --partial '"status":0'
+ run solr create -c test -s 2
+ assert_output --partial "Created collection 'test'"
run curl --http2 --cacert "$ssl_dir/solr-ssl.pem" 'https://localhost:8983/solr/test/select?q=*:*'
assert_output --partial '"numFound":0'