SOLR-6733: A beginning.
diff --git a/solr/agent/build.xml b/solr/agent/build.xml
new file mode 100644
index 0000000..8641f0c
--- /dev/null
+++ b/solr/agent/build.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+<project name="solr-start" default="default" xmlns:ivy="antlib:org.apache.ivy.ant">
+ <!-- TODO: This script copied from SolrJ and modified. Get it ready. -->
+ <description>Start - Main method for Solr</description>
+
+ <property name="test.lib.dir" location="test-lib"/>
+
+ <import file="../common-build.xml"/>
+
+ <!-- Specialized compile classpath: to only depend on what start should depend on (e.g. not lucene) -->
+ <path id="classpath">
+ <fileset dir="${common-solr.dir}/start/lib" excludes="${common.classpath.excludes}"/>
+ </path>
+
+ <!-- Specialized common-solr.test.classpath, to remove the Solr core test output -->
+ <path id="test.classpath">
+ <fileset dir="${test.lib.dir}" includes="*.jar"/>
+ <pathelement path="${common-solr.dir}/build/solr-test-framework/classes/java"/>
+ <pathelement path="${tests.userdir}"/>
+ <path refid="test.base.classpath"/>
+ <path refid="solr.base.classpath"/>
+ <pathelement path="${example}/resources"/>
+ </path>
+
+ <target name="resolve" depends="ivy-availability-check,ivy-fail,ivy-configure">
+ <sequential>
+ <ivy:retrieve conf="compile" type="jar,bundle" sync="${ivy.sync}" log="download-only" symlink="${ivy.symlink}"/>
+ <ivy:retrieve conf="test" type="jar,bundle,test" sync="${ivy.sync}" log="download-only" symlink="${ivy.symlink}"
+ pattern="${test.lib.dir}/[artifact]-[revision](-[classifier]).[ext]"/>
+ </sequential>
+ </target>
+
+ <!-- Specialized to depend on nothing -->
+ <target name="javadocs" depends="compile-core,define-lucene-javadoc-url,check-javadocs-uptodate"
+ unless="javadocs-uptodate-${name}">
+ <sequential>
+ <mkdir dir="${javadoc.dir}/${name}"/>
+ <solr-invoke-javadoc>
+ <solrsources>
+ <packageset dir="${src.dir}"/>
+ </solrsources>
+ </solr-invoke-javadoc>
+ <solr-jarify basedir="${javadoc.dir}/${name}" destfile="${build.dir}/${final.name}-javadoc.jar"/>
+ </sequential>
+ </target>
+
+ <!-- Specialized to use lucene's classpath too, because it refs e.g. qp syntax
+ (even though it doesnt compile with it)
+ TODO: would be nice to fix this up better, but it's hard because of
+ the different ways solr links to lucene javadocs -->
+ <target name="-ecj-javadoc-lint-src" depends="-ecj-resolve">
+ <ecj-macro srcdir="${src.dir}" configuration="${common.dir}/tools/javadoc/ecj.javadocs.prefs">
+ <classpath>
+ <path refid="classpath"/>
+ <path refid="solr.lucene.libs"/>
+ </classpath>
+ </ecj-macro>
+ </target>
+
+ <target name="dist" depends="common-solr.dist">
+ <!-- TODO: Fix or remove this.
+ <mkdir dir="${dist}/solrj-lib" />
+ <copy todir="${dist}/solrj-lib">
+ <fileset dir="${common-solr.dir}/start/lib">
+ <include name="*.jar"/>
+ </fileset>
+ </copy>
+ -->
+ </target>
+
+ <target name="-dist-maven" depends="-dist-maven-src-java"/>
+
+ <target name="-install-to-maven-local-repo" depends="-install-src-java-to-maven-local-repo"/>
+</project>
diff --git a/solr/agent/ivy.xml b/solr/agent/ivy.xml
new file mode 100644
index 0000000..ed9823c
--- /dev/null
+++ b/solr/agent/ivy.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<ivy-module version="2.0">
+ <info organisation="org.apache.solr" module="solrj"/>
+
+ <configurations defaultconfmapping="compile->master;test->master">
+ <!-- artifacts in the "compile" configuration will go into solr/solrj/lib/ -->
+ <conf name="compile" transitive="false"/>
+ <!-- artifacts in the "test" configuration will go into solr/solrj/test-lib/ -->
+ <conf name="test" transitive="false"/>
+ </configurations>
+
+ <dependencies>
+ <dependency org="org.slf4j" name="slf4j-api" rev="${/org.slf4j/slf4j-api}" conf="compile"/>
+ <exclude org="*" ext="*" matcher="regexp" type="${ivy.exclude.types}"/>
+ </dependencies>
+</ivy-module>
diff --git a/solr/agent/src/java/org/apache/solr/agent/Main.java b/solr/agent/src/java/org/apache/solr/agent/Main.java
new file mode 100644
index 0000000..1ab6ccd
--- /dev/null
+++ b/solr/agent/src/java/org/apache/solr/agent/Main.java
@@ -0,0 +1,190 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You under the Apache License, Version 2.0
+ * (the "License"); you may not use this file except in compliance with
+ * the License. You may obtain a copy of the License at
+ *
+ * http://www.apache.org/licenses/LICENSE-2.0
+ *
+ * Unless required by applicable law or agreed to in writing, software
+ * distributed under the License is distributed on an "AS IS" BASIS,
+ * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ * See the License for the specific language governing permissions and
+ * limitations under the License.
+ */
+package org.apache.solr.agent;
+
+import java.io.IOException;
+import java.io.InputStream;
+import java.nio.file.Files;
+import java.nio.file.Path;
+import java.nio.file.Paths;
+import java.util.Locale;
+import java.util.Properties;
+import java.util.StringJoiner;
+import java.util.concurrent.atomic.AtomicBoolean;
+
+/**
+ * Executable class for the Solr Agent. Accepts commands on the CLI. TODO: Work out the lifecycle and which commands
+ * will send requests over a socket to an already running agent. If the Solr process that this agent is monitoring dies,
+ * this agent will shut down automatically shortly afterwards.
+ */
+public class Main {
+ private static final String JVM_IS_SHORT_TERM = "JVM_IS_SHORT_TERM";
+ private static final String SOLR_AGENT_PROPERTIES = "SOLR_AGENT_PROPERTIES";
+ private static final String DEFAULT_AGENT_PROPERTIES = "agent.properties";
+ private static final AtomicBoolean osIsWindows = new AtomicBoolean(false);
+ private static final AtomicBoolean jvmIsOracle = new AtomicBoolean(false);
+ private static final AtomicBoolean jvmIsShortTerm = new AtomicBoolean(false);
+
+ private static final Properties agentProps = new Properties();
+ private static Path agentPropPath = null;
+
+ public static void main(String[] args) {
+ try {
+ osIsWindows.set(System.getProperty("os.name").toLowerCase(Locale.ROOT).contains("win"));
+ } catch (Exception e) {
+ throw new RuntimeException("Could not determine OS name! This Java seems to be broken!", e);
+ }
+
+ try {
+ jvmIsOracle.set(System.getProperty("java.vendor").toLowerCase(Locale.ROOT).contains("oracle"));
+ } catch (Exception e) {
+ throw new RuntimeException("Could not determine Java vendor! This Java seems to be broken!", e);
+ }
+
+ String javaVersion = null;
+ String[] javaVersionElements = null;
+ try {
+ javaVersion = System.getProperty("java.version");
+ /* If this property isn't set, attempting the split will throw NPE. */
+ javaVersionElements = javaVersion.split("\\.|_");
+ } catch (Exception e) {
+ throw new RuntimeException("Could not determine Java version! This Java seems to be broken!", e);
+ }
+
+ int majorVersion;
+ try {
+ /* Java versions before 9 are shown as a 1.x version */
+ if (javaVersionElements[0].equals("1")) {
+ majorVersion = Integer.parseInt(javaVersionElements[1]);
+ } else {
+ majorVersion = Integer.parseInt(javaVersionElements[0]);
+ }
+ } catch (Exception e) {
+ /* We should never reach this point if the java version is null. */
+ throw new RuntimeException("Problem parsing java version: " + javaVersion, e);
+ }
+
+ /*
+ * TODO: Unless the target version of this module is lowered, older versions of Java won't even run this class. This
+ * error won't ever be seen.
+ */
+ if (majorVersion < 8) {
+ throw new RuntimeException("Must have at least Java 8!");
+ }
+
+ if (majorVersion != 8 && majorVersion != 11 && majorVersion != 17) {
+ System.err.println("This is likely not a long-term-support Java version.");
+ System.err.println("Major version detected: " + majorVersion);
+ System.err.println("Full version: " + javaVersion);
+ jvmIsShortTerm.set(true);
+ }
+
+ readProperties();
+ // TODO: Remove the validate/print command. Just here for debugging.
+ validateAndPrintEnvironment();
+
+ if (args.length <= 0) {
+ System.err.println("No command!");
+ System.exit(1);
+ }
+
+ int currentArg = 0;
+
+ String command = args[currentArg].toLowerCase(Locale.ROOT);
+ currentArg++;
+
+ switch (command) {
+ case "get_env":
+ validateAndPrintEnvironment();
+ break;
+
+ default:
+ System.err.println("Unknown command " + command);
+ System.exit(1);
+ break;
+ }
+ }
+
+ private static void validateAndPrintEnvironment() {
+ /* Create an object for building a list of env commands. */
+ StringJoiner env = new StringJoiner("\n", "", "\n");
+
+ /* If wee have no properties, we can't continue, so abort. */
+ if (agentProps.size() <= 0) {
+ System.err.println("No properties were loaded!");
+ System.exit(1);
+ }
+
+ /* Add all of the properties for this agent to the list of env commands. */
+ for (Object propKey : agentProps.keySet()) {
+ String propVal = agentProps.getProperty((String) propKey);
+ env.add(kvToEnvVar((String) propKey, propVal));
+ }
+
+ /*
+ * TODO: Add checks for specific things that are easy to validate in Java. Add settings to the env commands so the
+ * script can take action on what was detected -- abort the script, use special CLI options, etc.
+ */
+ if (jvmIsShortTerm.get()) {
+ env.add(kvToEnvVar(JVM_IS_SHORT_TERM, "1"));
+ }
+
+ // Write the full set of env commands to stdout.
+ System.out.println(env.toString());
+ }
+
+ /**
+ * Find the file pointed to by SOLR_AGENT_PROPERTIES and read those properties into the class.
+ */
+ private static void readProperties() {
+ String propFileName = System.getProperty(SOLR_AGENT_PROPERTIES);
+ if (propFileName == null) {
+ propFileName = System.getenv(SOLR_AGENT_PROPERTIES);
+ if (propFileName == null) {
+ propFileName = DEFAULT_AGENT_PROPERTIES;
+ }
+ }
+ agentPropPath = Paths.get(propFileName);
+ try (InputStream is = Files.newInputStream(agentPropPath);) {
+ agentProps.load(is);
+ } catch (IOException e) {
+ throw new RuntimeException(e);
+ }
+ }
+
+ /**
+ * Convert a key/value pair to a command for setting an environment variable.
+ *
+ * @param key
+ * A key or variable name.
+ * @param value
+ * A value.
+ * @return A single string as a shell command to set an environment variable.
+ */
+ private static String kvToEnvVar(String key, String value) {
+ StringBuilder var = new StringBuilder(128);
+ if (osIsWindows.get()) {
+ var.append("SET ");
+ }
+ /* TODO: Decide whether we want to add "export" to these lines for bash. */
+ var.append(key);
+ var.append("=\"");
+ var.append(value);
+ var.append("\"");
+ return var.toString();
+ }
+}
diff --git a/solr/bin/functions.sh b/solr/bin/functions.sh
new file mode 100644
index 0000000..504a64d
--- /dev/null
+++ b/solr/bin/functions.sh
@@ -0,0 +1,440 @@
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+#
+###
+### Shell script functions for Solr
+###
+#
+##### Setup
+DEFAULT_AGENT_HEAP=16M
+DEFAULT_AGENT_MAIN_ETC_DIR=/etc/solr
+DEFAULT_AGENT_PORT=58983
+DEFAULT_CLOUD_BUILD_ADDRESS=239.89.83.0
+DEFAULT_CLOUD_BUILD_PORT=8983
+DEFAULT_SOLR_HEAP=512M
+DEFAULT_SOLR_PORT=8983
+DEFAULT_X_WHICH=/usr/bin/which
+DEFAULT_ZK_CLIENT_PORT=2181
+DEFAULT_ZK_ELECTION_PORT=3888
+DEFAULT_ZK_LEADER_PORT=2888
+##### End Setup
+#
+#----
+# DO NOT EDIT BELOW THIS LINE WITHOUT GUIDANCE
+#----
+
+if [ -z "${AGENT_HEAP}" ]; then
+ AGENT_HEAP="${DEFAULT_AGENT_HEAP}"
+fi
+
+if [ -z "${AGENT_MAIN_ETC_DIR}" ]; then
+ AGENT_MAIN_ETC_DIR="${DEFAULT_AGENT_MAIN_ETC_DIR}"
+fi
+
+if [ -z "${AGENT_PORT}" ]; then
+ AGENT_PORT="${DEFAULT_AGENT_PORT}"
+fi
+
+if [ -z "${CLOUD_BUILD_ADDRESS}" ]; then
+ CLOUD_BUILD_ADDRESS="${DEFAULT_CLOUD_BUILD_ADDRESS}"
+fi
+
+if [ -z "${CLOUD_BUILD_PORT}" ]; then
+ CLOUD_BUILD_PORT="${DEFAULT_CLOUD_BUILD_PORT}"
+fi
+
+if [ -z "${SOLR_HEAP}" ]; then
+ SOLR_HEAP="${DEFAULT_SOLR_HEAP}"
+fi
+
+if [ -z "${SOLR_PORT}" ]; then
+ SOLR_PORT="${DEFAULT_SOLR_PORT}"
+fi
+
+if [ -z "${X_WHICH}" ]; then
+ X_WHICH="${DEFAULT_X_WHICH}"
+fi
+
+if [ -z "${ZK_CLIENT_PORT}" ]; then
+ ZK_CLIENT_PORT="${DEFAULT_ZK_CLIENT_PORT}"
+fi
+
+if [ -z "${ZK_ELECTION_PORT}" ]; then
+ ZK_ELECTION_PORT="${DEFAULT_ZK_ELECTION_PORT}"
+fi
+
+if [ -z "${ZK_LEADER_PORT}" ]; then
+ ZK_LEADER_PORT="${DEFAULT_ZK_LEADER_PORT}"
+fi
+
+# Write a message to stderr indicating that a command is required.
+# If no command is provided to this function, use a generic message.
+# Exit the script after writing the message.
+exit_err_msg_required_command() {
+ REQ_CMD="$1"
+ if [ -z "${REQ_CMD}" ]; then
+ echo >&2 "A command required to run this script is missing."
+ else
+ echo >&2 "The ${REQ_CMD} command is required to run this script."
+ fi
+ err_msg_contact_community
+ exit 1
+}
+
+# Write a message asking the user to contact the Solr community if they
+# feel that there's a problem.
+err_msg_contact_community() {
+ echo >&2 "---"
+ echo >&2 "If you feel this is in error, please mention the problem"
+ echo >&2 "to the Solr community on the mailing list or IRC channel."
+ echo >&2 "http://lucene.apache.org/solr/community.html#mailing-lists-irc"
+}
+
+# Locate directories based based on a script directory passed in as the first
+# argument and set environment variables. The current working directory will
+# be set to the parent of that directory and assigned to SOLR_TIP.
+find_dirs_and_change_cwd() {
+ MYDIR="$1"
+ cd ${MYDIR}
+ cd ..
+ SOLR_TIP=`pwd`
+ LOCAL_ETC_DIR=${SOLR_TIP}/etc
+ SOLR_LIB_DIR=${SOLR_TIP}/lib
+ SOLR_TMP_DIR=${SOLR_TIP}/tmp
+ SOLR_RUN_DIR=${SOLR_TIP}/run
+}
+
+# Find required system executables or shell builtin commands and set
+# variables like X_TEMPFILE so the script has a better chance of running
+# on systems where things are installed outside of LSB locations.
+find_system_programs_or_exit() {
+ # Make sure the which command is available.
+ if [ ! -x "${X_WHICH}" ]; then
+ echo >&2 "The command ${X_WHICH} is not found or not executable."
+ exit_err_msg_required_command "${X_WHICH}"
+ fi
+
+ # Check for the existence of other commands we need.
+ locate_command_or_exit tempfile X_TEMPFILE 1
+ locate_command_or_exit find X_FIND 1
+ locate_command_or_exit xargs X_XARGS 1
+ # We look for lsof and netstat, but do not exit
+ # if they are not found.
+ locate_command_or_exit lsof X_LSOF 0
+ locate_command_or_exit netstat X_NETSTAT 0
+ # If NEITHER lsof or netstat is found, log a warning message.
+ if [-z "${X_LSOF}" ] && [ -z "${X_NETSTAT}" ]; then
+ echo >&2 "Neither lsof or netstat found. Will not be able to check for"
+ echo >&2 "programs already listening on relevant ports."
+ fi
+}
+
+# Check whether a program exists as a builtin or an executable. Will not
+# validate a command that is a function or an alias. Assign a dynamic
+# variable to the bare program name or an executable file path as required
+# if found, exit the script if not. The first argument is the bare command,
+# the second argument is the variable that will be assigned with the correct
+# command or executable. The third argument is an exit flag -- a numeric
+# boolean value (usually 0 or 1) indicating whether or not a missing program
+# will cause a script exit. A missing program will result in an error message
+# whether an exit is forced or not. The first two arguments are required.
+# The exit flag will default to 1 if not present. If the variable mentioned
+# as the second argument is already defined, then the value of that variable
+# will override the first argument to this script and tested to make sure it
+# is a valid command. This allows somebody to define variables like X_TEMPFILE
+# in advance to override the automatic detection, while making sure that the
+# explicitly set value is actually a good command.
+locate_command_or_exit() {
+ PRGNAME=$1
+ shift
+ PRGVAR=$1
+ shift
+ EXITFLAG=$1
+
+ if [ -z "${PRGNAME}" ] || [ -z "${PRGVAR}" ]; then
+ echo >&2 "locate_command_or_exit routine missing required arguments."
+ echo >&2 "Aborting script."
+ err_msg_contact_community
+ exit 1
+ fi
+
+ if [ -z "${EXITFLAG}" ]; then
+ EXITFLAG=1;
+ fi
+
+ BADPROG=0
+ if [ -n "${!PRGVAR}" ]; then
+ echo >&2 "The ${PRGNAME} command has been predefined as ${!PRGVAR}."
+ PRGNAME="${!PRGVAR}"
+ fi
+
+ CMD_TYPE=`type -t ${PRGNAME}`
+ if [ "${CMD_TYPE}" == "builtin" ]; then
+ eval ${PRGVAR}="\${PRGNAME}"
+ elif [ "${CMD_TYPE}" == "file" ]; then
+ XPATH=`"${X_WHICH}" "${PRGNAME}"`
+ RET=$?
+ if [ $RET -eq 0 ]; then
+ if [ -x "${XPATH}" ]; then
+ eval ${PRGVAR}="\${XPATH}"
+ else
+ BADPROG=1
+ fi
+ else
+ BADPROG=1
+ fi
+ else
+ BADPROG=1
+ fi
+
+ if [ ${BADPROG} -ne 0 ]; then
+ echo >&2 "The ${PRGNAME} command is not found or not executable."
+ echo >&2 "The ${PRGVAR} env variable can explicitly set its location."
+ if [ ${EXITFLAG} -ne 0 ]; then
+ exit_err_msg_required_command "${PRGNAME}"
+ fi
+ fi
+ return 0
+}
+
+# Find Java and set the JAVA variable.
+# Exit script if unable to locate a java executable.
+find_java_or_exit() {
+ JAVA=
+ if [ -n "$SOLR_JAVA_HOME" ]; then
+ echo >&2 "SOLR_JAVA_HOME found, using it as JAVA_HOME."
+ JAVA_HOME="$SOLR_JAVA_HOME"
+ fi
+
+ if [ -n "$JAVA_HOME" ]; then
+ for java in "${JAVA_HOME}/bin/amd64/java" "${JAVA_HOME}/bin/java"; do
+ if [ -x "$java" ]; then
+ JAVA="$java"
+ break
+ fi
+ done
+ if [ -z "$JAVA" ]; then
+ echo >&2 "The currently defined JAVA_HOME (${JAVA_HOME}) refers"
+ echo >&2 "to a location where Java could not be found. Aborting."
+ echo >&2 "Either fix the variable or remove it from the environment"
+ echo >&2 "so that the system PATH will be searched."
+ err_msg_contact_community
+ exit 1
+ fi
+ else
+ X_JAVA=`"${X_WHICH}" java`
+ if [ -x "${X_JAVA}" ]; then
+ JAVA=${X_JAVA}
+ else
+ echo >&2 "Unable to locate a java executable."
+ err_msg_contact_community
+ exit 1
+ fi
+ fi
+ return 0
+}
+
+# Start the agent. Will pass all parameters to the startup.
+# The first parameter is the properties file to use.
+agent_start() {
+ start_agent_program $@ start
+}
+
+# Start the agent program with a commandline parameter that tells it
+# to examine its config and the system, and use what it finds to create
+# a bunch of environment variables. The agent will output the commands
+# for the variables to stdout.
+agent_get_env() {
+ start_agent_program get_env
+ return $?
+}
+
+# Start the agent with arguments sent to this function.
+# Removes all options (things like -D), leaving only commands for the agent.
+# Will set a SOLR_AGENT_PROPERTIES sysprop with that variable value.
+start_agent_program() {
+ CP_JARS=`get_jars_for_classpath ${SOLR_TIP}/lib/log ${SOLR_TIP}/lib/solrj`
+
+ OPTIND=1
+ while getopts ":D:" opt; do
+ case ${opt} in
+ D)
+ # Do nothing. This will remove the option. May not need this case.
+ ;;
+ *)
+ # Do nothing. This will remove the option.
+ ;;
+ esac
+ done
+ shift $((OPTIND -1))
+
+ $JAVA -Xmx${AGENT_HEAP} -cp ${CP_JARS} -DSOLR_AGENT_PROPERTIES="${SOLR_AGENT_PROPERTIES}" -jar lib/agent.jar $@
+ return $?
+}
+
+# Given a list of path locations, recursively find all the jars and write a
+# classpath string to stdout.
+get_jars_for_classpath() {
+ get_files_for_classpath jar $@
+}
+
+# Given an extension and a list of of path locations, recursively find all
+# the files with that extension and write a classpath string to stdout. To
+# include all files, pass an equal sign in as the extension.
+get_files_for_classpath() {
+ CP_EXTENSION=$1
+ shift
+
+ if [ "${CP_EXTENSION}" == "=" ]; then
+ CP_FILESPEC="*"
+ else
+ CP_FILESPEC="*.${CP_EXTENSION}"
+ fi
+
+ DETECTED_CLASSPATH=
+ ADDED_FIRST_CP_ENTRY=
+ KEEP_RUNNING=true
+ while [ -n "${KEEP_RUNNING}" ]; do
+ CHECKDIR=$1
+ shift
+ if [ -n "${CHECKDIR}" ]; then
+ if [ -d "${CHECKDIR}" ]; then
+ while IFS= read -r -d '' line; do
+ add_to_detected_classpath "$line"
+ done < <(${X_FIND} ${CHECKDIR} -type f -name "${CP_FILESPEC}" -print0)
+ fi
+ else
+ KEEP_RUNNING=
+ fi
+ done
+ echo "$DETECTED_CLASSPATH"
+}
+
+add_to_detected_classpath() {
+ CP_ENTRY="$1"
+ if [ -n "${ADDED_FIRST_CP_ENTRY}" ]; then
+ # If the first entry in the classpath has been added
+ # we add a colon before the entry as a separator.
+ CP_ENTRY=":${CP_ENTRY}"
+ fi
+ # Set the value to indicate the first entry has been added.
+ ADDED_FIRST_CP_ENTRY=true
+ DETECTED_CLASSPATH="${DETECTED_CLASSPATH}${CP_ENTRY}"
+}
+
+# Locate the agent properties file based on available information.
+# The SOLR_AGENT_PROPERTIES variable may be empty after this runs,
+# but only if this is a non-service install.
+find_agent_properties_or_exit() {
+ # First, if service name is not set, try to figure out a service name.
+ # When no service name set and only one service is installed, we assume
+ # that service. If multiple services installed and no name is set, the
+ # script will abort.
+ if [ -z "${SOLR_SERVICE_NAME}" ]; then
+ SOLR_SERVICES_CONFIG=${LOCAL_ETC_DIR}/services.conf
+ declare -a SERVICES
+ if [ -r "${SOLR_SERVICES_CONFIG}" ]; then
+ readarray -t SERVICES < ${SOLR_SERVICES_CONFIG}
+ fi
+ if [ ${#SERVICES[@]} -gt 0 ]; then
+ if [ ${#SERVICES[@]} -eq 1 ]; then
+ SOLR_SERVICE_NAME=${SERVICES[0]}
+ else
+ echo >&2 "Multiple services detected in ${SOLR_SERVICES_CONFIG}"
+ echo >&2 "SOLR_SERVICE_NAME must be defined to proceed."
+ err_msg_contact_community
+ exit 1
+ fi
+ fi
+ fi
+
+ # If we reach here, then we have either settled on one service name or
+ # there are no services.
+ if [ -n "${SOLR_SERVICE_NAME}" ]; then
+ echo >&2 "Solr service name ${SOLR_SERVICE_NAME} detected."
+ SOLR_AGENT_PROPERTIES=${MAIN_ETC_DIR}/${SOLR_SERVICE_NAME}/solr-agent.properties
+ else
+ SOLR_AGENT_PROPERTIES=${LOCAL_ETC_DIR}/solr-agent.properties
+ fi
+
+ # When running as a service, the agent properties file must exist. When the
+ # properties file does not exist, decide whether to exit or use defaults.
+ if [ ! -r "${SOLR_AGENT_PROPERTIES}" ]; then
+ if [ -n "${SOLR_SERVICE_NAME}" ]; then
+ echo >&2 "The ${SOLR_AGENT_PROPERTIES} file is not found or not readable."
+ echo >&2 "Service installs must have an agent properties file."
+ err_msg_contact_community
+ exit 1
+ else
+ echo >&2 "The ${SOLR_AGENT_PROPERTIES} file is not found or not readable."
+ echo >&2 "Proceeding with defaults for a non-service install."
+ SOLR_AGENT_PROPERTIES=
+ fi
+ # TODO: Service recommendation might need to move.
+ if [ -z "${SOLR_SERVICE_NAME}" ]; then
+ recommend_service
+ fi
+ fi
+}
+
+recommend_service() {
+ echo >&2 "Non-service install detected."
+ echo >&2 "Installing Solr as a service is strongly recommended."
+ echo >&2 "https://lucene.apache.org/solr/guide/taking-solr-to-production.html"
+}
+
+# Determine whether or not the configured version of Java supports the
+# ExitOnOutOfMemoryError flag. Sets JAVA_OOM_EXIT_SUPPORTED with a numeric
+# boolean value and returns the exit code from the attempt to run Java with
+# that option.
+check_oom_exit_supported() {
+ $JAVA -Xmx1M -XX:+ExitOnOutOfMemoryError -version > /dev/null 2> /dev/null
+ RET=$?
+ if [ ${RET} -eq 0 ]; then
+ JAVA_OOM_EXIT_SUPPORTED=1
+ else
+ JAVA_OOM_EXIT_SUPPORTED=0
+ fi
+ return ${RET}
+}
+
+# If the BASH_VERSION variable is not set, it is a reasonable indication
+# that the shell we are running in is not bash. If that situation is
+# detected, exit.
+exit_if_no_bash() {
+ if [ -z "${BASH_VERSION}" ]; then
+ echo >&2 "This script must be run by the bash shell."
+ err_msg_contact_community
+ exit 1
+ fi
+}
+
+# Exit script if the bash version is too old. Require version 4.
+# The first release of bash 4 was in 2009.
+exit_if_bash_too_old() {
+ if [ -n "${BASH_VERSINFO[*]}" ]; then
+ if [ "${BASH_VERSINFO[0]}" -lt 4 ]; then
+ echo >&2 "Detected bash version is ${BASH_VERSION}."
+ echo >&2 "Script needs at least version 4."
+ err_msg_contact_community
+ exit 1
+ fi
+ else
+ echo >&2 "There was a problem detecting bash version."
+ echo >&2 "Aborting because compatibility cannot be detected."
+ err_msg_contact_community
+ exit 1
+ fi
+}
diff --git a/solr/bin/old-solr b/solr/bin/old-solr
new file mode 100755
index 0000000..53cf84d
--- /dev/null
+++ b/solr/bin/old-solr
@@ -0,0 +1,2127 @@
+#!/usr/bin/env bash
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+
+# CONTROLLING STARTUP:
+#
+# Use solr -help to see available command-line options. In addition
+# to passing command-line options, this script looks for an include
+# file named solr.in.sh to set environment variables. Specifically,
+# the following locations are searched in this order:
+#
+# ./
+# $HOME/.solr.in.sh
+# /usr/share/solr
+# /usr/local/share/solr
+# /var/solr/
+# /opt/solr
+#
+# Another option is to specify the full path to the include file in the
+# environment. For example:
+#
+# $ SOLR_INCLUDE=/path/to/solr.in.sh solr start
+#
+# Note: This is particularly handy for running multiple instances on a
+# single installation, or for quick tests.
+#
+# Finally, developers and enthusiasts who frequently run from an SVN
+# checkout, and do not want to locally modify bin/solr.in.sh, can put
+# a customized include file at ~/.solr.in.sh.
+#
+# If you would rather configure startup entirely from the environment, you
+# can disable the include by exporting an empty SOLR_INCLUDE, or by
+# ensuring that no include files exist in the aforementioned search list.
+
+SOLR_SCRIPT="$0"
+verbose=false
+THIS_OS=`uname -s`
+
+# What version of Java is required to run this version of Solr.
+JAVA_VER_REQ="8"
+
+stop_all=false
+
+# for now, we don't support running this script from cygwin due to problems
+# like not having lsof, ps auxww, curl, and awkward directory handling
+if [ "${THIS_OS:0:6}" == "CYGWIN" ]; then
+ echo -e "This script does not support cygwin due to severe limitations and lack of adherence\nto BASH standards, such as lack of lsof, curl, and ps options.\n\nPlease use the native solr.cmd script on Windows!"
+ exit 1
+fi
+
+# Resolve symlinks to this script
+while [ -h "$SOLR_SCRIPT" ] ; do
+ ls=`ls -ld "$SOLR_SCRIPT"`
+ # Drop everything prior to ->
+ link=`expr "$ls" : '.*-> \(.*\)$'`
+ if expr "$link" : '/.*' > /dev/null; then
+ SOLR_SCRIPT="$link"
+ else
+ SOLR_SCRIPT=`dirname "$SOLR_SCRIPT"`/"$link"
+ fi
+done
+
+SOLR_TIP=`dirname "$SOLR_SCRIPT"`/..
+SOLR_TIP=`cd "$SOLR_TIP"; pwd`
+DEFAULT_SERVER_DIR="$SOLR_TIP/server"
+
+# If an include wasn't specified in the environment, then search for one...
+if [ -z "$SOLR_INCLUDE" ]; then
+ # Locations (in order) to use when searching for an include file.
+ for include in "`dirname "$0"`/solr.in.sh" \
+ "$HOME/.solr.in.sh" \
+ /usr/share/solr/solr.in.sh \
+ /usr/local/share/solr/solr.in.sh \
+ /etc/default/solr.in.sh \
+ /opt/solr/solr.in.sh; do
+ if [ -r "$include" ]; then
+ SOLR_INCLUDE="$include"
+ . "$include"
+ break
+ fi
+ done
+elif [ -r "$SOLR_INCLUDE" ]; then
+ . "$SOLR_INCLUDE"
+fi
+
+if [ -z "$SOLR_PID_DIR" ]; then
+ SOLR_PID_DIR="$SOLR_TIP/bin"
+fi
+
+if [ -n "$SOLR_JAVA_HOME" ]; then
+ JAVA="$SOLR_JAVA_HOME/bin/java"
+elif [ -n "$JAVA_HOME" ]; then
+ for java in "$JAVA_HOME"/bin/amd64/java "$JAVA_HOME"/bin/java; do
+ if [ -x "$java" ]; then
+ JAVA="$java"
+ break
+ fi
+ done
+ if [ -z "$JAVA" ]; then
+ echo >&2 "The currently defined JAVA_HOME ($JAVA_HOME) refers"
+ echo >&2 "to a location where Java could not be found. Aborting."
+ echo >&2 "Either fix the JAVA_HOME variable or remove it from the"
+ echo >&2 "environment so that the system PATH will be searched."
+ exit 1
+ fi
+else
+ JAVA=java
+fi
+
+if [ -z "$SOLR_STOP_WAIT" ]; then
+ SOLR_STOP_WAIT=180
+fi
+# test that Java exists, is executable and correct version
+JAVA_VER=$("$JAVA" -version 2>&1)
+if [[ $? -ne 0 ]] ; then
+ echo >&2 "Java not found, or an error was encountered when running java."
+ echo >&2 "A working Java $JAVA_VER_REQ JRE is required to run Solr!"
+ echo >&2 "Please install latest version of Java $JAVA_VER_REQ or set JAVA_HOME properly."
+ echo >&2 "Command that we tried: '${JAVA} -version', with response:"
+ echo >&2 "${JAVA_VER}"
+ echo >&2
+ echo >&2 "Debug information:"
+ echo >&2 "JAVA_HOME: ${JAVA_HOME:-N/A}"
+ echo >&2 "Active Path:"
+ echo >&2 "${PATH}"
+ exit 1
+else
+ JAVA_VER_NUM=$(echo $JAVA_VER | head -1 | awk -F '"' '/version/ {print $2}' | sed -e's/^1\.//' | sed -e's/[._-].*$//')
+ if [[ "$JAVA_VER_NUM" -lt "$JAVA_VER_REQ" ]] ; then
+ echo >&2 "Your current version of Java is too old to run this version of Solr."
+ echo >&2 "We found major version $JAVA_VER_NUM, using command '${JAVA} -version', with response:"
+ echo >&2 "${JAVA_VER}"
+ echo >&2
+ echo >&2 "Please install latest version of Java $JAVA_VER_REQ or set JAVA_HOME properly."
+ echo >&2
+ echo >&2 "Debug information:"
+ echo >&2 "JAVA_HOME: ${JAVA_HOME:-N/A}"
+ echo >&2 "Active Path:"
+ echo >&2 "${PATH}"
+ exit 1
+ fi
+ JAVA_VENDOR="Oracle"
+ if [ "`echo $JAVA_VER | grep -i "IBM J9"`" != "" ]; then
+ JAVA_VENDOR="IBM J9"
+ fi
+fi
+
+
+# Select HTTP OR HTTPS related configurations
+SOLR_URL_SCHEME=http
+SOLR_JETTY_CONFIG=()
+SOLR_SSL_OPTS=""
+
+if [ -n "$SOLR_HADOOP_CREDENTIAL_PROVIDER_PATH" ]; then
+ SOLR_SSL_OPTS+=" -Dhadoop.security.credential.provider.path=$SOLR_HADOOP_CREDENTIAL_PROVIDER_PATH"
+fi
+
+if [ -z "$SOLR_SSL_ENABLED" ]; then
+ if [ -n "$SOLR_SSL_KEY_STORE" ]; then
+ SOLR_SSL_ENABLED="true" # implicitly from earlier behaviour
+ else
+ SOLR_SSL_ENABLED="false"
+ fi
+fi
+if [ "$SOLR_SSL_ENABLED" == "true" ]; then
+ SOLR_JETTY_CONFIG+=("--module=https")
+ SOLR_JETTY_CONFIG+=("--lib=$DEFAULT_SERVER_DIR/solr-webapp/webapp/WEB-INF/lib/*")
+ SOLR_URL_SCHEME=https
+ if [ -n "$SOLR_SSL_KEY_STORE" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.jetty.keystore=$SOLR_SSL_KEY_STORE"
+ fi
+ if [ -n "$SOLR_SSL_KEY_STORE_PASSWORD" ]; then
+ export SOLR_SSL_KEY_STORE_PASSWORD=$SOLR_SSL_KEY_STORE_PASSWORD
+ fi
+ if [ -n "$SOLR_SSL_KEY_STORE_TYPE" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.jetty.keystore.type=$SOLR_SSL_KEY_STORE_TYPE"
+ fi
+
+ if [ -n "$SOLR_SSL_TRUST_STORE" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.jetty.truststore=$SOLR_SSL_TRUST_STORE"
+ fi
+ if [ -n "$SOLR_SSL_TRUST_STORE_PASSWORD" ]; then
+ export SOLR_SSL_TRUST_STORE_PASSWORD=$SOLR_SSL_TRUST_STORE_PASSWORD
+ fi
+ if [ -n "$SOLR_SSL_TRUST_STORE_TYPE" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.jetty.truststore.type=$SOLR_SSL_TRUST_STORE_TYPE"
+ fi
+
+ if [ -n "$SOLR_SSL_NEED_CLIENT_AUTH" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.jetty.ssl.needClientAuth=$SOLR_SSL_NEED_CLIENT_AUTH"
+ fi
+ if [ -n "$SOLR_SSL_WANT_CLIENT_AUTH" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.jetty.ssl.wantClientAuth=$SOLR_SSL_WANT_CLIENT_AUTH"
+ fi
+
+ if [ -n "$SOLR_SSL_CLIENT_KEY_STORE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStore=$SOLR_SSL_CLIENT_KEY_STORE"
+
+ if [ -n "$SOLR_SSL_CLIENT_KEY_STORE_PASSWORD" ]; then
+ export SOLR_SSL_CLIENT_KEY_STORE_PASSWORD=$SOLR_SSL_CLIENT_KEY_STORE_PASSWORD
+ fi
+ if [ -n "$SOLR_SSL_CLIENT_KEY_STORE_TYPE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStoreType=$SOLR_SSL_CLIENT_KEY_STORE_TYPE"
+ fi
+ else
+ if [ -n "$SOLR_SSL_KEY_STORE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStore=$SOLR_SSL_KEY_STORE"
+ fi
+ if [ -n "$SOLR_SSL_KEY_STORE_TYPE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStoreType=$SOLR_SSL_KEYSTORE_TYPE"
+ fi
+ fi
+
+ if [ -n "$SOLR_SSL_CHECK_PEER_NAME" ]; then
+ SOLR_SSL_OPTS+=" -Dsolr.ssl.checkPeerName=$SOLR_SSL_CHECK_PEER_NAME"
+ fi
+
+ if [ -n "$SOLR_SSL_CLIENT_TRUST_STORE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStore=$SOLR_SSL_CLIENT_TRUST_STORE"
+
+ if [ -n "$SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD" ]; then
+ export SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD=$SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD
+ fi
+ if [ -n "$SOLR_SSL_CLIENT_TRUST_STORE_TYPE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStoreType=$SOLR_SSL_CLIENT_TRUST_STORE_TYPE"
+ fi
+ else
+ if [ -n "$SOLR_SSL_TRUST_STORE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStore=$SOLR_SSL_TRUST_STORE"
+ fi
+
+ if [ -n "$SOLR_SSL_TRUST_STORE_TYPE" ]; then
+ SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStoreType=$SOLR_SSL_TRUST_STORE_TYPE"
+ fi
+ fi
+else
+ SOLR_JETTY_CONFIG+=("--module=http")
+fi
+
+# Authentication options
+if [ -z "$SOLR_AUTH_TYPE" ] && [ -n "$SOLR_AUTHENTICATION_OPTS" ]; then
+ echo "WARNING: SOLR_AUTHENTICATION_OPTS environment variable configured without associated SOLR_AUTH_TYPE variable"
+ echo " Please configure SOLR_AUTH_TYPE environment variable with the authentication type to be used."
+ echo " Currently supported authentication types are [kerberos, basic]"
+fi
+
+if [ -n "$SOLR_AUTH_TYPE" ] && [ -n "$SOLR_AUTHENTICATION_CLIENT_BUILDER" ]; then
+ echo "WARNING: SOLR_AUTHENTICATION_CLIENT_BUILDER and SOLR_AUTH_TYPE environment variables are configured together."
+ echo " Use SOLR_AUTH_TYPE environment variable to configure authentication type to be used. "
+ echo " Currently supported authentication types are [kerberos, basic]"
+ echo " The value of SOLR_AUTHENTICATION_CLIENT_BUILDER environment variable will be ignored"
+fi
+
+if [ -n "$SOLR_AUTH_TYPE" ]; then
+ case "$(echo $SOLR_AUTH_TYPE | awk '{print tolower($0)}')" in
+ basic)
+ SOLR_AUTHENTICATION_CLIENT_BUILDER="org.apache.solr.client.solrj.impl.PreemptiveBasicAuthClientBuilderFactory"
+ ;;
+ kerberos)
+ SOLR_AUTHENTICATION_CLIENT_BUILDER="org.apache.solr.client.solrj.impl.Krb5HttpClientBuilder"
+ ;;
+ *)
+ echo "ERROR: Value specified for SOLR_AUTH_TYPE environment variable is invalid."
+ exit 1
+ esac
+fi
+
+if [ "$SOLR_AUTHENTICATION_CLIENT_CONFIGURER" != "" ]; then
+ echo "WARNING: Found unsupported configuration variable SOLR_AUTHENTICATION_CLIENT_CONFIGURER"
+ echo " Please start using SOLR_AUTH_TYPE instead"
+fi
+if [ "$SOLR_AUTHENTICATION_CLIENT_BUILDER" != "" ]; then
+ AUTHC_CLIENT_BUILDER_ARG="-Dsolr.httpclient.builder.factory=$SOLR_AUTHENTICATION_CLIENT_BUILDER"
+fi
+AUTHC_OPTS="$AUTHC_CLIENT_BUILDER_ARG $SOLR_AUTHENTICATION_OPTS"
+
+# Set the SOLR_TOOL_HOST variable for use when connecting to a running Solr instance
+if [ "$SOLR_HOST" != "" ]; then
+ SOLR_TOOL_HOST="$SOLR_HOST"
+else
+ SOLR_TOOL_HOST="localhost"
+fi
+
+function print_usage() {
+ CMD="$1"
+ ERROR_MSG="$2"
+
+ if [ "$ERROR_MSG" != "" ]; then
+ echo -e "\nERROR: $ERROR_MSG\n"
+ fi
+
+ if [ -z "$CMD" ]; then
+ echo ""
+ echo "Usage: solr COMMAND OPTIONS"
+ echo " where COMMAND is one of: start, stop, restart, status, healthcheck, create, create_core, create_collection, delete, version, zk, auth, assert, config"
+ echo ""
+ echo " Standalone server example (start Solr running in the background on port 8984):"
+ echo ""
+ echo " ./solr start -p 8984"
+ echo ""
+ echo " SolrCloud example (start Solr running in SolrCloud mode using localhost:2181 to connect to Zookeeper, with 1g max heap size and remote Java debug options enabled):"
+ echo ""
+ echo " ./solr start -c -m 1g -z localhost:2181 -a \"-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044\""
+ echo ""
+ echo "Pass -help after any COMMAND to see command-specific usage information,"
+ echo " such as: ./solr start -help or ./solr stop -help"
+ echo ""
+ elif [[ "$CMD" == "start" || "$CMD" == "restart" ]]; then
+ echo ""
+ echo "Usage: solr $CMD [-f] [-c] [-h hostname] [-p port] [-d directory] [-z zkHost] [-m memory] [-e example] [-s solr.solr.home] [-t solr.data.home] [-a \"additional-options\"] [-V]"
+ echo ""
+ echo " -f Start Solr in foreground; default starts Solr in the background"
+ echo " and sends stdout / stderr to solr-PORT-console.log"
+ echo ""
+ echo " -c or -cloud Start Solr in SolrCloud mode; if -z not supplied, an embedded Zookeeper"
+ echo " instance is started on Solr port+1000, such as 9983 if Solr is bound to 8983"
+ echo ""
+ echo " -h <host> Specify the hostname for this Solr instance"
+ echo ""
+ echo " -p <port> Specify the port to start the Solr HTTP listener on; default is 8983"
+ echo " The specified port (SOLR_PORT) will also be used to determine the stop port"
+ echo " STOP_PORT=(\$SOLR_PORT-1000) and JMX RMI listen port RMI_PORT=(\$SOLR_PORT+10000). "
+ echo " For instance, if you set -p 8985, then the STOP_PORT=7985 and RMI_PORT=18985"
+ echo ""
+ echo " -d <dir> Specify the Solr server directory; defaults to server"
+ echo ""
+ echo " -z <zkHost> Zookeeper connection string; only used when running in SolrCloud mode using -c"
+ echo " To launch an embedded Zookeeper instance, don't pass this parameter."
+ echo ""
+ echo " -m <memory> Sets the min (-Xms) and max (-Xmx) heap size for the JVM, such as: -m 4g"
+ echo " results in: -Xms4g -Xmx4g; by default, this script sets the heap size to 512m"
+ echo ""
+ echo " -s <dir> Sets the solr.solr.home system property; Solr will create core directories under"
+ echo " this directory. This allows you to run multiple Solr instances on the same host"
+ echo " while reusing the same server directory set using the -d parameter. If set, the"
+ echo " specified directory should contain a solr.xml file, unless solr.xml exists in Zookeeper."
+ echo " This parameter is ignored when running examples (-e), as the solr.solr.home depends"
+ echo " on which example is run. The default value is server/solr. If passed relative dir,"
+ echo " validation with current dir will be done, before trying default server/<dir>"
+ echo ""
+ echo " -t <dir> Sets the solr.data.home system property, where Solr will store index data in <instance_dir>/data subdirectories."
+ echo " If not set, Solr uses solr.solr.home for config and data."
+ echo ""
+ echo " -e <example> Name of the example to run; available examples:"
+ echo " cloud: SolrCloud example"
+ echo " techproducts: Comprehensive example illustrating many of Solr's core capabilities"
+ echo " dih: Data Import Handler"
+ echo " schemaless: Schema-less example"
+ echo ""
+ echo " -a Additional parameters to pass to the JVM when starting Solr, such as to setup"
+ echo " Java debug options. For example, to enable a Java debugger to attach to the Solr JVM"
+ echo " you could pass: -a \"-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=18983\""
+ echo " In most cases, you should wrap the additional parameters in double quotes."
+ echo ""
+ echo " -j Additional parameters to pass to Jetty when starting Solr."
+ echo " For example, to add configuration folder that jetty should read"
+ echo " you could pass: -j \"--include-jetty-dir=/etc/jetty/custom/server/\""
+ echo " In most cases, you should wrap the additional parameters in double quotes."
+ echo ""
+ echo " -noprompt Don't prompt for input; accept all defaults when running examples that accept user input"
+ echo ""
+ echo " -v and -q Verbose (-v) or quiet (-q) logging. Sets default log level to DEBUG or WARN instead of INFO"
+ echo ""
+ echo " -V/-verbose Verbose messages from this script"
+ echo ""
+ elif [ "$CMD" == "stop" ]; then
+ echo ""
+ echo "Usage: solr stop [-k key] [-p port] [-V]"
+ echo ""
+ echo " -k <key> Stop key; default is solrrocks"
+ echo ""
+ echo " -p <port> Specify the port the Solr HTTP listener is bound to"
+ echo ""
+ echo " -all Find and stop all running Solr servers on this host"
+ echo ""
+ echo " -V/-verbose Verbose messages from this script"
+ echo ""
+ echo " NOTE: To see if any Solr servers are running, do: solr status"
+ echo ""
+ elif [ "$CMD" == "healthcheck" ]; then
+ echo ""
+ echo "Usage: solr healthcheck [-c collection] [-z zkHost] [-V]"
+ echo ""
+ echo "Can be run from remote (non-Solr) hosts, as long as a proper ZooKeeper connection is provided"
+ echo ""
+ echo " -c <collection> Collection to run healthcheck against."
+ echo ""
+ echo " -z <zkHost> Zookeeper connection string; default is localhost:9983"
+ echo ""
+ echo " -V Enable more verbose output"
+ echo ""
+ elif [ "$CMD" == "status" ]; then
+ echo ""
+ echo "Usage: solr status"
+ echo ""
+ echo " This command will show the status of all running Solr servers."
+ echo " It can only detect those Solr servers running on the current host."
+ echo ""
+ elif [ "$CMD" == "create" ]; then
+ echo ""
+ echo "Usage: solr create [-c name] [-d confdir] [-n configName] [-shards #] [-replicationFactor #] [-p port] [-V]"
+ echo ""
+ echo " Create a core or collection depending on whether Solr is running in standalone (core) or SolrCloud"
+ echo " mode (collection). In other words, this action detects which mode Solr is running in, and then takes"
+ echo " the appropriate action (either create_core or create_collection). For detailed usage instructions, do:"
+ echo ""
+ echo " bin/solr create_core -help"
+ echo ""
+ echo " or"
+ echo ""
+ echo " bin/solr create_collection -help"
+ echo ""
+ elif [ "$CMD" == "delete" ]; then
+ echo ""
+ echo "Usage: solr delete [-c name] [-deleteConfig true|false] [-p port] [-V]"
+ echo ""
+ echo " Deletes a core or collection depending on whether Solr is running in standalone (core) or SolrCloud"
+ echo " mode (collection). If you're deleting a collection in SolrCloud mode, the default behavior is to also"
+ echo " delete the configuration directory from Zookeeper so long as it is not being used by another collection."
+ echo " You can override this behavior by passing -deleteConfig false when running this command."
+ echo ""
+ echo " Can be run on remote (non-Solr) hosts, as long as a valid SOLR_HOST is provided in solr.in.sh"
+ echo ""
+ echo " -c <name> Name of the core / collection to delete"
+ echo ""
+ echo " -deleteConfig <boolean> Delete the configuration directory from Zookeeper; default is true"
+ echo ""
+ echo " -p <port> Port of a local Solr instance where you want to delete the core/collection"
+ echo " If not specified, the script will search the local system for a running"
+ echo " Solr instance and will use the port of the first server it finds."
+ echo ""
+ echo " -V Enables more verbose output."
+ echo ""
+ elif [ "$CMD" == "create_core" ]; then
+ echo ""
+ echo "Usage: solr create_core [-c core] [-d confdir] [-p port] [-V]"
+ echo ""
+ echo "When a configSet is used, this can be run from remote (non-Solr) hosts. If pointing at a non-configSet directory, this"
+ echo "must be run from the host that you wish to create the core on"
+ echo ""
+ echo " -c <core> Name of core to create"
+ echo ""
+ echo " -d <confdir> Configuration directory to copy when creating the new core, built-in options are:"
+ echo ""
+ echo " _default: Minimal configuration, which supports enabling/disabling field-guessing support"
+ echo " sample_techproducts_configs: Example configuration with many optional features enabled to"
+ echo " demonstrate the full power of Solr"
+ echo ""
+ echo " If not specified, default is: _default"
+ echo ""
+ echo " Alternatively, you can pass the path to your own configuration directory instead of using"
+ echo " one of the built-in configurations, such as: bin/solr create_core -c mycore -d /tmp/myconfig"
+ echo ""
+ echo " -p <port> Port of a local Solr instance where you want to create the new core"
+ echo " If not specified, the script will search the local system for a running"
+ echo " Solr instance and will use the port of the first server it finds."
+ echo ""
+ echo " -V Enable more verbose output."
+ echo ""
+ elif [ "$CMD" == "create_collection" ]; then
+ echo ""
+ echo "Usage: solr create_collection [-c collection] [-d confdir] [-n configName] [-shards #] [-replicationFactor #] [-p port] [-V]"
+ echo ""
+ echo "Can be run from remote (non-Solr) hosts, as long as a valid SOLR_HOST is provided in solr.in.sh"
+ echo " -c <collection> Name of collection to create"
+ echo ""
+ echo " -d <confdir> Configuration directory to copy when creating the new collection, built-in options are:"
+ echo ""
+ echo " _default: Minimal configuration, which supports enabling/disabling field-guessing support"
+ echo " sample_techproducts_configs: Example configuration with many optional features enabled to"
+ echo " demonstrate the full power of Solr"
+ echo ""
+ echo " If not specified, default is: _default"
+ echo ""
+ echo " Alternatively, you can pass the path to your own configuration directory instead of using"
+ echo " one of the built-in configurations, such as: bin/solr create_collection -c mycoll -d /tmp/myconfig"
+ echo ""
+ echo " By default the script will upload the specified confdir directory into Zookeeper using the same"
+ echo " name as the collection (-c) option. Alternatively, if you want to reuse an existing directory"
+ echo " or create a confdir in Zookeeper that can be shared by multiple collections, use the -n option"
+ echo ""
+ echo " -n <configName> Name the configuration directory in Zookeeper; by default, the configuration"
+ echo " will be uploaded to Zookeeper using the collection name (-c), but if you want"
+ echo " to use an existing directory or override the name of the configuration in"
+ echo " Zookeeper, then use the -c option."
+ echo ""
+ echo " -shards <#> Number of shards to split the collection into; default is 1"
+ echo ""
+ echo " -replicationFactor <#> Number of copies of each document in the collection, default is 1 (no replication)"
+ echo ""
+ echo " -p <port> Port of a local Solr instance where you want to create the new collection"
+ echo " If not specified, the script will search the local system for a running"
+ echo " Solr instance and will use the port of the first server it finds."
+ echo ""
+ echo " -V Enable more verbose output."
+ echo ""
+ elif [ "$CMD" == "zk" ]; then
+ print_short_zk_usage ""
+ echo " Can be run on remote (non-Solr) hosts, as long as valid ZK_HOST information is provided"
+ echo " Be sure to check the Solr logs in case of errors."
+ echo ""
+ echo " -z zkHost Optional Zookeeper connection string for all commands. If specified it"
+ echo " overrides the 'ZK_HOST=...'' defined in solr.in.sh."
+ echo ""
+ echo " -V Enable more verbose output."
+ echo ""
+ echo " upconfig uploads a configset from the local machine to Zookeeper. (Backcompat: -upconfig)"
+ echo ""
+ echo " downconfig downloads a configset from Zookeeper to the local machine. (Backcompat: -downconfig)"
+ echo ""
+ echo " -n configName Name of the configset in Zookeeper that will be the destination of"
+ echo " 'upconfig' and the source for 'downconfig'."
+ echo ""
+ echo " -d confdir The local directory the configuration will be uploaded from for"
+ echo " 'upconfig' or downloaded to for 'downconfig'. If 'confdir' is a child of"
+ echo " ...solr/server/solr/configsets' then the configs will be copied from/to"
+ echo " that directory. Otherwise it is interpreted as a simple local path."
+ echo ""
+ echo " cp copies files or folders to/from Zookeeper or Zokeeper -> Zookeeper"
+ echo " -r Recursively copy <src> to <dst>. Command will fail if <src> has children and "
+ echo " -r is not specified. Optional"
+ echo ""
+ echo " <src>, <dest> : [file:][/]path/to/local/file or zk:/path/to/zk/node"
+ echo " NOTE: <src> and <dest> may both be Zookeeper resources prefixed by 'zk:'"
+ echo " When <src> is a zk resource, <dest> may be '.'"
+ echo " If <dest> ends with '/', then <dest> will be a local folder or parent znode and the last"
+ echo " element of the <src> path will be appended unless <src> also ends in a slash. "
+ echo " <dest> may be zk:, which may be useful when using the cp -r form to backup/restore "
+ echo " the entire zk state."
+ echo " You must enclose local paths that end in a wildcard in quotes or just"
+ echo " end the local path in a slash. That is,"
+ echo " 'bin/solr zk cp -r /some/dir/ zk:/ -z localhost:2181' is equivalent to"
+ echo " 'bin/solr zk cp -r \"/some/dir/*\" zk:/ -z localhost:2181'"
+ echo " but 'bin/solr zk cp -r /some/dir/* zk:/ -z localhost:2181' will throw an error"
+ echo ""
+ echo " here's an example of backup/restore for a ZK configuration:"
+ echo " to copy to local: 'bin/solr zk cp -r zk:/ /some/dir -z localhost:2181'"
+ echo " to restore to ZK: 'bin/solr zk cp -r /some/dir/ zk:/ -z localhost:2181'"
+ echo ""
+ echo " The 'file:' prefix is stripped, thus 'file:/wherever' specifies an absolute local path and"
+ echo " 'file:somewhere' specifies a relative local path. All paths on Zookeeper are absolute."
+ echo ""
+ echo " Zookeeper nodes CAN have data, so moving a single file to a parent znode"
+ echo " will overlay the data on the parent Znode so specifying the trailing slash"
+ echo " can be important."
+ echo ""
+ echo " Wildcards are supported when copying from local, trailing only and must be quoted."
+ echo ""
+ echo " rm deletes files or folders on Zookeeper"
+ echo " -r Recursively delete if <path> is a directory. Command will fail if <path>"
+ echo " has children and -r is not specified. Optional"
+ echo " <path> : [zk:]/path/to/zk/node. <path> may not be the root ('/')"
+ echo ""
+ echo " mv moves (renames) znodes on Zookeeper"
+ echo " <src>, <dest> : Zookeeper nodes, the 'zk:' prefix is optional."
+ echo " If <dest> ends with '/', then <dest> will be a parent znode"
+ echo " and the last element of the <src> path will be appended."
+ echo " Zookeeper nodes CAN have data, so moving a single file to a parent znode"
+ echo " will overlay the data on the parent Znode so specifying the trailing slash"
+ echo " is important."
+ echo ""
+ echo " ls lists the znodes on Zookeeper"
+ echo " -r recursively descends the path listing all znodes. Optional"
+ echo " <path>: The Zookeeper path to use as the root."
+ echo ""
+ echo " Only the node names are listed, not data"
+ echo ""
+ echo " mkroot makes a znode in Zookeeper with no data. Can be used to make a path of arbitrary"
+ echo " depth but primarily intended to create a 'chroot'."
+ echo ""
+ echo " <path>: The Zookeeper path to create. Leading slash is assumed if not present."
+ echo " Intermediate nodes are created as needed if not present."
+ echo ""
+ elif [ "$CMD" == "auth" ]; then
+ echo ""
+ echo "Usage: solr auth enable [-type basicAuth] -credentials user:pass [-blockUnknown <true|false>] [-updateIncludeFileOnly <true|false>] [-V]"
+ echo " solr auth enable [-type basicAuth] -prompt <true|false> [-blockUnknown <true|false>] [-updateIncludeFileOnly <true|false>] [-V]"
+ echo " solr auth enable -type kerberos -config \"<kerberos configs>\" [-updateIncludeFileOnly <true|false>] [-V]"
+ echo " solr auth disable [-updateIncludeFileOnly <true|false>] [-V]"
+ echo ""
+ echo " Updates or enables/disables authentication. Must be run on the machine hosting Solr."
+ echo ""
+ echo " -type <type> The authentication mechanism (basicAuth or kerberos) to enable. Defaults to 'basicAuth'."
+ echo ""
+ echo " -credentials <user:pass> The username and password of the initial user. Applicable for basicAuth only."
+ echo " Note: only one of -prompt or -credentials must be provided"
+ echo ""
+ echo " -config \"<configs>\" Configuration parameters (Solr startup parameters). Required and applicable only for Kerberos"
+ echo ""
+ echo " -prompt <true|false> Prompts the user to provide the credentials. Applicable for basicAuth only."
+ echo " Note: only one of -prompt or -credentials must be provided"
+ echo ""
+ echo " -blockUnknown <true|false> When true, this blocks out access to unauthenticated users. When not provided,"
+ echo " this defaults to false (i.e. unauthenticated users can access all endpoints, except the"
+ echo " operations like collection-edit, security-edit, core-admin-edit etc.). Check the reference"
+ echo " guide for Basic Authentication for more details. Applicable for basicAuth only."
+ echo ""
+ echo " -updateIncludeFileOnly <true|false> Only update the solr.in.sh or solr.in.cmd file, and skip actual enabling/disabling"
+ echo " authentication (i.e. don't update security.json)"
+ echo ""
+ echo " -z zkHost Zookeeper connection string"
+ echo ""
+ echo " -d <dir> Specify the Solr server directory"
+ echo ""
+ echo " -s <dir> Specify the Solr home directory. This is where any credentials or authentication"
+ echo " configuration files (e.g. basicAuth.conf) would be placed."
+ echo ""
+ echo " -V Enable more verbose output."
+ echo ""
+ fi
+} # end print_usage
+
+function print_short_zk_usage() {
+
+ if [ "$1" != "" ]; then
+ echo -e "\nERROR: $1\n"
+ fi
+
+ echo " Usage: solr zk upconfig|downconfig -d <confdir> -n <configName> [-z zkHost]"
+ echo " solr zk cp [-r] <src> <dest> [-z zkHost]"
+ echo " solr zk rm [-r] <path> [-z zkHost]"
+ echo " solr zk mv <src> <dest> [-z zkHost]"
+ echo " solr zk ls [-r] <path> [-z zkHost]"
+ echo " solr zk mkroot <path> [-z zkHost]"
+ echo ""
+
+ if [ "$1" == "" ]; then
+ echo "Type bin/solr zk -help for full usage help"
+ else
+ exit 1
+ fi
+}
+
+# used to show the script is still alive when waiting on work to complete
+function spinner() {
+ local pid=$1
+ local delay=0.5
+ local spinstr='|/-\'
+ while [ "$(ps aux | awk '{print $2}' | grep -w $pid)" ]; do
+ local temp=${spinstr#?}
+ printf " [%c] " "$spinstr"
+ local spinstr=$temp${spinstr%"$temp"}
+ sleep $delay
+ printf "\b\b\b\b\b\b"
+ done
+ printf " \b\b\b\b"
+}
+
+# given a port, find the pid for a Solr process
+function solr_pid_by_port() {
+ THE_PORT="$1"
+ if [ -e "$SOLR_PID_DIR/solr-$THE_PORT.pid" ]; then
+ PID=`cat "$SOLR_PID_DIR/solr-$THE_PORT.pid"`
+ CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $PID | sort -r | tr -d ' '`
+ if [ "$CHECK_PID" != "" ]; then
+ local solrPID=$PID
+ fi
+ fi
+ echo "$solrPID"
+}
+
+# extract the value of the -Djetty.port parameter from a running Solr process
+function jetty_port() {
+ SOLR_PID="$1"
+ SOLR_PROC=`ps auxww | grep -w $SOLR_PID | grep start\.jar | grep jetty\.port`
+ IFS=' ' read -a proc_args <<< "$SOLR_PROC"
+ for arg in "${proc_args[@]}"
+ do
+ IFS='=' read -a pair <<< "$arg"
+ if [ "${pair[0]}" == "-Djetty.port" ]; then
+ local jetty_port="${pair[1]}"
+ break
+ fi
+ done
+ echo "$jetty_port"
+} # end jetty_port func
+
+# run a Solr command-line tool using the SolrCLI class;
+# useful for doing cross-platform work from the command-line using Java
+function run_tool() {
+
+ "$JAVA" $SOLR_SSL_OPTS $AUTHC_OPTS $SOLR_ZK_CREDS_AND_ACLS -Dsolr.install.dir="$SOLR_TIP" \
+ -Dlog4j.configurationFile="file:$DEFAULT_SERVER_DIR/scripts/cloud-scripts/log4j2.xml" \
+ -classpath "$DEFAULT_SERVER_DIR/solr-webapp/webapp/WEB-INF/lib/*:$DEFAULT_SERVER_DIR/lib/ext/*" \
+ org.apache.solr.util.SolrCLI "$@"
+
+ return $?
+} # end run_tool function
+
+# get information about any Solr nodes running on this host
+function get_info() {
+ CODE=4
+ # first, see if Solr is running
+ numSolrs=`find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | wc -l | tr -d ' '`
+ if [ "$numSolrs" != "0" ]; then
+ echo -e "\nFound $numSolrs Solr nodes: "
+ while read PIDF
+ do
+ ID=`cat "$PIDF"`
+ port=`jetty_port "$ID"`
+ if [ "$port" != "" ]; then
+ echo -e "\nSolr process $ID running on port $port"
+ run_tool status -solr "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$port/solr"
+ CODE=$?
+ echo ""
+ else
+ echo -e "\nSolr process $ID from $PIDF not found."
+ CODE=1
+ fi
+ done < <(find "$SOLR_PID_DIR" -name "solr-*.pid" -type f)
+ else
+ # no pid files but check using ps just to be sure
+ numSolrs=`ps auxww | grep start\.jar | grep solr\.solr\.home | grep -v grep | wc -l | sed -e 's/^[ \t]*//'`
+ if [ "$numSolrs" != "0" ]; then
+ echo -e "\nFound $numSolrs Solr nodes: "
+ PROCESSES=$(ps auxww | grep start\.jar | grep solr\.solr\.home | grep -v grep | awk '{print $2}' | sort -r)
+ for ID in $PROCESSES
+ do
+ port=`jetty_port "$ID"`
+ if [ "$port" != "" ]; then
+ echo ""
+ echo "Solr process $ID running on port $port"
+ run_tool status -solr "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$port/solr"
+ CODE=$?
+ echo ""
+ fi
+ done
+ else
+ echo -e "\nNo Solr nodes are running.\n"
+ CODE=3
+ fi
+ fi
+
+ return $CODE
+} # end get_info
+
+# tries to gracefully stop Solr using the Jetty
+# stop command and if that fails, then uses kill -9
+function stop_solr() {
+
+ DIR="$1"
+ SOLR_PORT="$2"
+ THIS_STOP_PORT="${STOP_PORT:-$(expr $SOLR_PORT - 1000)}"
+ STOP_KEY="$3"
+ SOLR_PID="$4"
+
+ if [ "$SOLR_PID" != "" ]; then
+ echo -e "Sending stop command to Solr running on port $SOLR_PORT ... waiting up to $SOLR_STOP_WAIT seconds to allow Jetty process $SOLR_PID to stop gracefully."
+ "$JAVA" $SOLR_SSL_OPTS $AUTHC_OPTS -jar "$DIR/start.jar" "STOP.PORT=$THIS_STOP_PORT" "STOP.KEY=$STOP_KEY" --stop || true
+ (loops=0
+ while true
+ do
+ CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $SOLR_PID | sort -r | tr -d ' '`
+ if [ "$CHECK_PID" != "" ]; then
+ slept=$((loops * 2))
+ if [ $slept -lt $SOLR_STOP_WAIT ]; then
+ sleep 2
+ loops=$[$loops+1]
+ else
+ exit # subshell!
+ fi
+ else
+ exit # subshell!
+ fi
+ done) &
+ spinner $!
+ rm -f "$SOLR_PID_DIR/solr-$SOLR_PORT.pid"
+ else
+ echo -e "No Solr nodes found to stop."
+ exit 0
+ fi
+
+ CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $SOLR_PID | sort -r | tr -d ' '`
+ if [ "$CHECK_PID" != "" ]; then
+ echo -e "Solr process $SOLR_PID is still running; forcefully killing it now."
+ kill -9 $SOLR_PID
+ echo "Killed process $SOLR_PID"
+ rm -f "$SOLR_PID_DIR/solr-$SOLR_PORT.pid"
+ sleep 1
+ fi
+
+ CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $SOLR_PID | sort -r | tr -d ' '`
+ if [ "$CHECK_PID" != "" ]; then
+ echo "ERROR: Failed to kill previous Solr Java process $SOLR_PID ... script fails."
+ exit 1
+ fi
+} # end stop_solr
+
+if [ $# -eq 1 ]; then
+ case $1 in
+ -help|-usage|-h|--help)
+ print_usage ""
+ exit
+ ;;
+ -info|-i|status)
+ get_info
+ exit $?
+ ;;
+ -version|-v|version)
+ run_tool version
+ exit
+ ;;
+ esac
+fi
+
+if [ $# -gt 0 ]; then
+ # if first arg starts with a dash (and it's not -help or -info),
+ # then assume they are starting Solr, such as: solr -f
+ if [[ $1 == -* ]]; then
+ SCRIPT_CMD="start"
+ else
+ SCRIPT_CMD="$1"
+ shift
+ fi
+else
+ # no args - just show usage and exit
+ print_usage ""
+ exit
+fi
+
+if [ "$SCRIPT_CMD" == "status" ]; then
+ # hacky - the script hits this if the user passes additional args with the status command,
+ # which is not supported but also not worth complaining about either
+ get_info
+ exit
+fi
+
+# assert tool
+if [ "$SCRIPT_CMD" == "assert" ]; then
+ run_tool assert $*
+ exit $?
+fi
+
+# run a healthcheck and exit if requested
+if [ "$SCRIPT_CMD" == "healthcheck" ]; then
+
+ VERBOSE=""
+
+ if [ $# -gt 0 ]; then
+ while true; do
+ case "$1" in
+ -c|-collection)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Collection name is required when using the $1 option!"
+ exit 1
+ fi
+ HEALTHCHECK_COLLECTION="$2"
+ shift 2
+ ;;
+ -z|-zkhost)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "ZooKeeper connection string is required when using the $1 option!"
+ exit 1
+ fi
+ ZK_HOST="$2"
+ shift 2
+ ;;
+ -help|-usage)
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ ;;
+ -V|--verbose)
+ VERBOSE="-verbose"
+ shift
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ if [ "$1" != "" ]; then
+ print_usage "$SCRIPT_CMD" "Unrecognized or misplaced argument: $1!"
+ exit 1
+ else
+ break # out-of-args, stop looping
+ fi
+ ;;
+ esac
+ done
+ fi
+
+ if [ -z "$ZK_HOST" ]; then
+ ZK_HOST=localhost:9983
+ fi
+
+ if [ -z "$HEALTHCHECK_COLLECTION" ]; then
+ echo "collection parameter is required!"
+ print_usage "healthcheck"
+ exit 1
+ fi
+
+ run_tool healthcheck -zkHost "$ZK_HOST" -collection "$HEALTHCHECK_COLLECTION" $VERBOSE
+
+ exit $?
+fi
+
+if [[ "$SCRIPT_CMD" == "config" ]]; then
+ run_tool config $*
+ exit $?
+fi
+
+# create a core or collection
+if [[ "$SCRIPT_CMD" == "create" || "$SCRIPT_CMD" == "create_core" || "$SCRIPT_CMD" == "create_collection" ]]; then
+
+ CREATE_NUM_SHARDS=1
+ CREATE_REPFACT=1
+ FORCE=false
+ VERBOSE=""
+
+ if [ $# -gt 0 ]; then
+ while true; do
+ case "$1" in
+ -c|-core|-collection)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "name is required when using the $1 option!"
+ exit 1
+ fi
+ CREATE_NAME="$2"
+ shift 2
+ ;;
+ -n|-confname)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Configuration name is required when using the $1 option!"
+ exit 1
+ fi
+ CREATE_CONFNAME="$2"
+ shift 2
+ ;;
+ -d|-confdir)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Configuration directory is required when using the $1 option!"
+ exit 1
+ fi
+ CREATE_CONFDIR="$2"
+ shift 2
+ ;;
+ -s|-shards)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Shard count is required when using the $1 option!"
+ exit 1
+ fi
+ CREATE_NUM_SHARDS="$2"
+ shift 2
+ ;;
+ -rf|-replicationFactor)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Replication factor is required when using the $1 option!"
+ exit 1
+ fi
+ CREATE_REPFACT="$2"
+ shift 2
+ ;;
+ -p|-port)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Solr port is required when using the $1 option!"
+ exit 1
+ fi
+ CREATE_PORT="$2"
+ shift 2
+ ;;
+ -V|--verbose)
+ VERBOSE="-verbose"
+ shift
+ ;;
+ -force)
+ FORCE=true
+ shift
+ ;;
+ -help|-usage)
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ if [ "$1" != "" ]; then
+ print_usage "$SCRIPT_CMD" "Unrecognized or misplaced argument: $1!"
+ exit 1
+ else
+ break # out-of-args, stop looping
+ fi
+ ;;
+ esac
+ done
+ fi
+
+ if [ -z "$CREATE_CONFDIR" ]; then
+ CREATE_CONFDIR='_default'
+ fi
+
+ # validate the confdir arg (if provided)
+ if [[ ! -d "$SOLR_TIP/server/solr/configsets/$CREATE_CONFDIR" && ! -d "$CREATE_CONFDIR" ]]; then
+ echo -e "\nSpecified configuration directory $CREATE_CONFDIR not found!\n"
+ exit 1
+ fi
+
+ if [ -z "$CREATE_NAME" ]; then
+ echo "Name (-c) argument is required!"
+ print_usage "$SCRIPT_CMD"
+ exit 1
+ fi
+
+ if [ -z "$CREATE_PORT" ]; then
+ for ID in `ps auxww | grep java | grep start\.jar | awk '{print $2}' | sort -r`
+ do
+ port=`jetty_port "$ID"`
+ if [ "$port" != "" ]; then
+ CREATE_PORT=$port
+ break
+ fi
+ done
+ fi
+
+ if [ -z "$CREATE_PORT" ]; then
+ echo "Failed to determine the port of a local Solr instance, cannot create $CREATE_NAME!"
+ exit 1
+ fi
+
+ if [[ "$CREATE_CONFDIR" == "_default" ]] && ([[ "$CREATE_CONFNAME" == "" ]] || [[ "$CREATE_CONFNAME" == "_default" ]]); then
+ echo "WARNING: Using _default configset with data driven schema functionality. NOT RECOMMENDED for production use."
+ echo " To turn off: bin/solr config -c $CREATE_NAME -p $CREATE_PORT -property update.autoCreateFields -value false"
+ fi
+
+ if [[ "$(whoami)" == "root" ]] && [[ "$FORCE" == "false" ]] ; then
+ echo "WARNING: Creating cores as the root user can cause Solr to fail and is not advisable. Exiting."
+ echo " If you started Solr as root (not advisable either), force core creation by adding argument -force"
+ exit 1
+ fi
+ if [ "$SCRIPT_CMD" == "create_core" ]; then
+ run_tool create_core -name "$CREATE_NAME" -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$CREATE_PORT/solr" \
+ -confdir "$CREATE_CONFDIR" -configsetsDir "$SOLR_TIP/server/solr/configsets" \
+ $VERBOSE
+ exit $?
+ else
+ run_tool "$SCRIPT_CMD" -name "$CREATE_NAME" -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$CREATE_PORT/solr" \
+ -shards "$CREATE_NUM_SHARDS" -replicationFactor "$CREATE_REPFACT" \
+ -confname "$CREATE_CONFNAME" -confdir "$CREATE_CONFDIR" \
+ -configsetsDir "$SOLR_TIP/server/solr/configsets" \
+ $VERBOSE
+ exit $?
+ fi
+fi
+
+# delete a core or collection
+if [[ "$SCRIPT_CMD" == "delete" ]]; then
+
+ VERBOSE=""
+
+ if [ $# -gt 0 ]; then
+ while true; do
+ case "$1" in
+ -c|-core|-collection)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "name is required when using the $1 option!"
+ exit 1
+ fi
+ DELETE_NAME="$2"
+ shift 2
+ ;;
+ -p|-port)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Solr port is required when using the $1 option!"
+ exit 1
+ fi
+ DELETE_PORT="$2"
+ shift 2
+ ;;
+ -deleteConfig)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "true|false is required when using the $1 option!"
+ exit 1
+ fi
+ DELETE_CONFIG="$2"
+ shift 2
+ ;;
+ -V|--verbose)
+ VERBOSE="-verbose"
+ shift
+ ;;
+ -help|-usage)
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ if [ "$1" != "" ]; then
+ print_usage "$SCRIPT_CMD" "Unrecognized or misplaced argument: $1!"
+ exit 1
+ else
+ break # out-of-args, stop looping
+ fi
+ ;;
+ esac
+ done
+ fi
+
+ if [ -z "$DELETE_NAME" ]; then
+ echo "Name (-c) argument is required!"
+ print_usage "$SCRIPT_CMD"
+ exit 1
+ fi
+
+ # If not defined, use the collection name for the name of the configuration in Zookeeper
+ if [ -z "$DELETE_CONFIG" ]; then
+ DELETE_CONFIG=true
+ fi
+
+ if [ -z "$DELETE_PORT" ]; then
+ for ID in `ps auxww | grep java | grep start\.jar | awk '{print $2}' | sort -r`
+ do
+ port=`jetty_port "$ID"`
+ if [ "$port" != "" ]; then
+ DELETE_PORT=$port
+ break
+ fi
+ done
+ fi
+
+ if [ -z "$DELETE_PORT" ]; then
+ echo "Failed to determine the port of a local Solr instance, cannot delete $DELETE_NAME!"
+ exit 1
+ fi
+
+ run_tool delete -name "$DELETE_NAME" -deleteConfig "$DELETE_CONFIG" \
+ -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$DELETE_PORT/solr" \
+ $VERBOSE
+ exit $?
+fi
+
+ZK_RECURSE=false
+# Zookeeper file maintenance (upconfig, downconfig, files up/down etc.)
+# It's a little clumsy to have the parsing go round and round for upconfig and downconfig, but that's
+# necessary for back-compat
+if [[ "$SCRIPT_CMD" == "zk" ]]; then
+
+ VERBOSE=""
+
+ if [ $# -gt 0 ]; then
+ while true; do
+ case "$1" in
+ -upconfig|upconfig|-downconfig|downconfig|cp|rm|mv|ls|mkroot)
+ if [ "${1:0:1}" == "-" ]; then
+ ZK_OP=${1:1}
+ else
+ ZK_OP=$1
+ fi
+ shift 1
+ ;;
+ -z|-zkhost)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_short_zk_usage "$SCRIPT_CMD" "ZooKeeper connection string is required when using the $1 option!"
+ fi
+ ZK_HOST="$2"
+ shift 2
+ ;;
+ -n|-confname)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_short_zk_usage "$SCRIPT_CMD" "Configuration name is required when using the $1 option!"
+ fi
+ CONFIGSET_CONFNAME="$2"
+ shift 2
+ ;;
+ -d|-confdir)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_short_zk_usage "$SCRIPT_CMD" "Configuration directory is required when using the $1 option!"
+ fi
+ CONFIGSET_CONFDIR="$2"
+ shift 2
+ ;;
+ -r)
+ ZK_RECURSE="true"
+ shift
+ ;;
+ -V|--verbose)
+ VERBOSE="-verbose"
+ shift
+ ;;
+ -help|-usage|-h)
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *) # Pick up <src> <dst> or <path> params for rm, ls, cp, mv, mkroot.
+ if [ "$1" == "" ]; then
+ break # out-of-args, stop looping
+ fi
+ if [ -z "$ZK_SRC" ]; then
+ ZK_SRC=$1
+ else
+ if [ -z "$ZK_DST" ]; then
+ ZK_DST=$1
+ else
+ print_short_zk_usage "Unrecognized or misplaced command $1. 'cp' with trailing asterisk requires quoting, see help text."
+ fi
+ fi
+ shift
+ ;;
+ esac
+ done
+ fi
+
+ if [ -z "$ZK_OP" ]; then
+ print_short_zk_usage "Zookeeper operation (one of 'upconfig', 'downconfig', 'rm', 'mv', 'cp', 'ls', 'mkroot') is required!"
+ fi
+
+ if [ -z "$ZK_HOST" ]; then
+ print_short_zk_usage "Zookeeper address (-z) argument is required or ZK_HOST must be specified in the solr.in.sh file."
+ fi
+
+ if [[ "$ZK_OP" == "upconfig" || "$ZK_OP" == "downconfig" ]]; then
+ if [ -z "$CONFIGSET_CONFDIR" ]; then
+ print_short_zk_usage "Local directory of the configset (-d) argument is required!"
+ fi
+
+ if [ -z "$CONFIGSET_CONFNAME" ]; then
+ print_short_zk_usage "Configset name on Zookeeper (-n) argument is required!"
+ fi
+ fi
+
+ if [[ "$ZK_OP" == "cp" || "$ZK_OP" == "mv" ]]; then
+ if [[ -z "$ZK_SRC" || -z "$ZK_DST" ]]; then
+ print_short_zk_usage "<source> and <destination> must be specified when using either the 'mv' or 'cp' commands."
+ fi
+ if [[ "$ZK_OP" == "cp" && "${ZK_SRC:0:3}" != "zk:" && "${ZK_DST:0:3}" != "zk:" ]]; then
+ print_short_zk_usage "One of the source or desintation paths must be prefixed by 'zk:' for the 'cp' command."
+ fi
+ fi
+
+ if [[ "$ZK_OP" == "mkroot" ]]; then
+ if [[ -z "$ZK_SRC" ]]; then
+ print_short_zk_usage "<path> must be specified when using the 'mkroot' command."
+ fi
+ fi
+
+
+ case "$ZK_OP" in
+ upconfig)
+ run_tool "$ZK_OP" -confname "$CONFIGSET_CONFNAME" -confdir "$CONFIGSET_CONFDIR" -zkHost "$ZK_HOST" -configsetsDir "$SOLR_TIP/server/solr/configsets" $VERBOSE
+ ;;
+ downconfig)
+ run_tool "$ZK_OP" -confname "$CONFIGSET_CONFNAME" -confdir "$CONFIGSET_CONFDIR" -zkHost "$ZK_HOST" $VERBOSE
+ ;;
+ rm)
+ if [ -z "$ZK_SRC" ]; then
+ print_short_zk_usage "Zookeeper path to remove must be specified when using the 'rm' command"
+ fi
+ run_tool "$ZK_OP" -path "$ZK_SRC" -zkHost "$ZK_HOST" -recurse "$ZK_RECURSE" $VERBOSE
+ ;;
+ mv)
+ run_tool "$ZK_OP" -src "$ZK_SRC" -dst "$ZK_DST" -zkHost "$ZK_HOST" $VERBOSE
+ ;;
+ cp)
+ run_tool "$ZK_OP" -src "$ZK_SRC" -dst "$ZK_DST" -zkHost "$ZK_HOST" -recurse "$ZK_RECURSE" $VERBOSE
+ ;;
+ ls)
+ if [ -z "$ZK_SRC" ]; then
+ print_short_zk_usage "Zookeeper path to list must be specified when using the 'ls' command"
+ fi
+ run_tool "$ZK_OP" -path "$ZK_SRC" -recurse "$ZK_RECURSE" -zkHost "$ZK_HOST" $VERBOSE
+ ;;
+ mkroot)
+ if [ -z "$ZK_SRC" ]; then
+ print_short_zk_usage "Zookeeper path to list must be specified when using the 'mkroot' command"
+ fi
+ run_tool "$ZK_OP" -path "$ZK_SRC" -zkHost "$ZK_HOST" $VERBOSE
+ ;;
+ *)
+ print_short_zk_usage "Unrecognized Zookeeper operation $ZK_OP"
+ ;;
+ esac
+
+ exit $?
+fi
+
+if [[ "$SCRIPT_CMD" == "auth" ]]; then
+
+ VERBOSE=""
+
+ declare -a AUTH_PARAMS
+ if [ $# -gt 0 ]; then
+ while true; do
+ case "$1" in
+ enable|disable)
+ AUTH_OP=$1
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "$AUTH_OP")
+ shift
+ ;;
+ -z|-zkhost|zkHost)
+ ZK_HOST="$2"
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-zkHost" "$ZK_HOST")
+ shift 2
+ ;;
+ -t|-type)
+ AUTH_TYPE="$2"
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-type" "$AUTH_TYPE")
+ shift 2
+ ;;
+ -credentials)
+ AUTH_CREDENTIALS="$2"
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-credentials" "$AUTH_CREDENTIALS")
+ shift 2
+ ;;
+ -config)
+ AUTH_CONFIG="`echo $2| base64`"
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-config" "$AUTH_CONFIG")
+ shift 2
+ ;;
+ -solrIncludeFile)
+ SOLR_INCLUDE="$2"
+ shift 2
+ ;;
+ -prompt)
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-prompt" "$2")
+ shift
+ ;;
+ -blockUnknown)
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-blockUnknown" "$2")
+ shift
+ break
+ ;;
+ -updateIncludeFileOnly)
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-updateIncludeFileOnly" "$2")
+ shift
+ break
+ ;;
+ -V|--verbose)
+ VERBOSE="-verbose"
+ shift
+ ;;
+ -d|-dir)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Server directory is required when using the $1 option!"
+ exit 1
+ fi
+
+ if [[ "$2" == "." || "$2" == "./" || "$2" == ".." || "$2" == "../" ]]; then
+ SOLR_SERVER_DIR="$(pwd)/$2"
+ else
+ # see if the arg value is relative to the tip vs full path
+ if [[ "$2" != /* ]] && [[ -d "$SOLR_TIP/$2" ]]; then
+ SOLR_SERVER_DIR="$SOLR_TIP/$2"
+ else
+ SOLR_SERVER_DIR="$2"
+ fi
+ fi
+ # resolve it to an absolute path
+ SOLR_SERVER_DIR="$(cd "$SOLR_SERVER_DIR"; pwd)"
+ shift 2
+ ;;
+ -s|-solr.home)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Solr home directory is required when using the $1 option!"
+ exit 1
+ fi
+
+ SOLR_HOME="$2"
+ shift 2
+ ;;
+ -help|-usage|-h)
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ shift
+ break
+ ;;
+ esac
+ done
+ fi
+
+ if [ -z "$SOLR_SERVER_DIR" ]; then
+ SOLR_SERVER_DIR="$DEFAULT_SERVER_DIR"
+ fi
+ if [ ! -e "$SOLR_SERVER_DIR" ]; then
+ echo -e "\nSolr server directory $SOLR_SERVER_DIR not found!\n"
+ exit 1
+ fi
+
+ if [ -z "$SOLR_HOME" ]; then
+ SOLR_HOME="$SOLR_SERVER_DIR/solr"
+ elif [[ $SOLR_HOME != /* ]]; then
+ if [[ -d "`pwd`/$SOLR_HOME" ]]; then
+ SOLR_HOME="$(pwd)/$SOLR_HOME"
+ elif [[ -d "$SOLR_SERVER_DIR/$SOLR_HOME" ]]; then
+ SOLR_HOME="$SOLR_SERVER_DIR/$SOLR_HOME"
+ SOLR_PID_DIR="$SOLR_HOME"
+ fi
+ fi
+
+ if [ -z "$AUTH_OP" ]; then
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ fi
+
+ AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-solrIncludeFile" "$SOLR_INCLUDE")
+
+ if [ -z "$AUTH_PORT" ]; then
+ for ID in `ps auxww | grep java | grep start\.jar | awk '{print $2}' | sort -r`
+ do
+ port=`jetty_port "$ID"`
+ if [ "$port" != "" ]; then
+ AUTH_PORT=$port
+ break
+ fi
+ done
+ fi
+ run_tool auth ${AUTH_PARAMS[@]} -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$AUTH_PORT/solr" -authConfDir "$SOLR_HOME" $VERBOSE
+ exit $?
+fi
+
+
+# verify the command given is supported
+if [ "$SCRIPT_CMD" != "stop" ] && [ "$SCRIPT_CMD" != "start" ] && [ "$SCRIPT_CMD" != "restart" ] && [ "$SCRIPT_CMD" != "status" ] && [ "$SCRIPT_CMD" != "assert" ]; then
+ print_usage "" "$SCRIPT_CMD is not a valid command!"
+ exit 1
+fi
+
+#Check current Ulimits for Open Files and Max Processes. Warn if they are below the recommended values.
+
+if [ -z "$SOLR_RECOMMENDED_MAX_PROCESSES" ]; then
+ SOLR_RECOMMENDED_MAX_PROCESSES=65000
+fi
+
+if [ -z "$SOLR_RECOMMENDED_OPEN_FILES" ]; then
+ SOLR_RECOMMENDED_OPEN_FILES=65000
+fi
+
+if [ -z "$SOLR_ULIMIT_CHECKS" ] || [ "$SOLR_ULIMIT_CHECKS" != "false" ]; then
+ if [ "$SCRIPT_CMD" == "start" ] || [ "$SCRIPT_CMD" == "restart" ] || [ "$SCRIPT_CMD" == "status" ]; then
+ if hash ulimit 2>/dev/null; then
+ openFiles=$(ulimit -n)
+ maxProcs=$(ulimit -u)
+ if [ $openFiles != "unlimited" ] && [ $openFiles -lt "$SOLR_RECOMMENDED_OPEN_FILES" ]; then
+ echo "*** [WARN] *** Your open file limit is currently $openFiles. "
+ echo " It should be set to $SOLR_RECOMMENDED_OPEN_FILES to avoid operational disruption. "
+ echo " If you no longer wish to see this warning, set SOLR_ULIMIT_CHECKS to false in your profile or solr.in.sh"
+ fi
+
+ if [ $maxProcs != "unlimited" ] && [ $maxProcs -lt "$SOLR_RECOMMENDED_MAX_PROCESSES" ]; then
+ echo "*** [WARN] *** Your Max Processes Limit is currently $maxProcs. "
+ echo " It should be set to $SOLR_RECOMMENDED_MAX_PROCESSES to avoid operational disruption. "
+ echo " If you no longer wish to see this warning, set SOLR_ULIMIT_CHECKS to false in your profile or solr.in.sh"
+ fi
+ else
+ echo "Could not check ulimits for processes and open files, recommended values are"
+ echo " max processes: $SOLR_RECOMMENDED_MAX_PROCESSES "
+ echo " open files: $SOLR_RECOMMENDED_OPEN_FILES"
+ fi
+ fi
+fi
+
+# Run in foreground (default is to run in the background)
+FG="false"
+FORCE=false
+noprompt=false
+SOLR_OPTS=($SOLR_OPTS)
+PASS_TO_RUN_EXAMPLE=
+
+if [ $# -gt 0 ]; then
+ while true; do
+ case "$1" in
+ -c|-cloud)
+ SOLR_MODE="solrcloud"
+ PASS_TO_RUN_EXAMPLE+=" -c"
+ shift
+ ;;
+ -d|-dir)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Server directory is required when using the $1 option!"
+ exit 1
+ fi
+
+ if [[ "$2" == "." || "$2" == "./" || "$2" == ".." || "$2" == "../" ]]; then
+ SOLR_SERVER_DIR="$(pwd)/$2"
+ else
+ # see if the arg value is relative to the tip vs full path
+ if [[ "$2" != /* ]] && [[ -d "$SOLR_TIP/$2" ]]; then
+ SOLR_SERVER_DIR="$SOLR_TIP/$2"
+ else
+ SOLR_SERVER_DIR="$2"
+ fi
+ fi
+ # resolve it to an absolute path
+ SOLR_SERVER_DIR="$(cd "$SOLR_SERVER_DIR"; pwd)"
+ shift 2
+ ;;
+ -s|-solr.home)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Solr home directory is required when using the $1 option!"
+ exit 1
+ fi
+
+ SOLR_HOME="$2"
+ shift 2
+ ;;
+ -t|-data.home)
+ SOLR_DATA_HOME="$2"
+ shift 2
+ ;;
+ -e|-example)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Example name is required when using the $1 option!"
+ exit 1
+ fi
+ EXAMPLE="$2"
+ shift 2
+ ;;
+ -f|-foreground)
+ FG="true"
+ shift
+ ;;
+ -h|-host)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Hostname is required when using the $1 option!"
+ exit 1
+ fi
+ SOLR_HOST="$2"
+ PASS_TO_RUN_EXAMPLE+=" -h $SOLR_HOST"
+ shift 2
+ ;;
+ -m|-memory)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Memory setting is required when using the $1 option!"
+ exit 1
+ fi
+ SOLR_HEAP="$2"
+ PASS_TO_RUN_EXAMPLE+=" -m $SOLR_HEAP"
+ shift 2
+ ;;
+ -p|-port)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Port number is required when using the $1 option!"
+ exit 1
+ fi
+ SOLR_PORT="$2"
+ PASS_TO_RUN_EXAMPLE+=" -p $SOLR_PORT"
+ shift 2
+ ;;
+ -z|-zkhost)
+ if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
+ print_usage "$SCRIPT_CMD" "Zookeeper connection string is required when using the $1 option!"
+ exit 1
+ fi
+ ZK_HOST="$2"
+ SOLR_MODE="solrcloud"
+ PASS_TO_RUN_EXAMPLE+=" -z $ZK_HOST"
+ shift 2
+ ;;
+ -a|-addlopts)
+ ADDITIONAL_CMD_OPTS="$2"
+ PASS_TO_RUN_EXAMPLE+=" -a \"$ADDITIONAL_CMD_OPTS\""
+ shift 2
+ ;;
+ -j|-jettyconfig)
+ ADDITIONAL_JETTY_CONFIG="$2"
+ PASS_TO_RUN_EXAMPLE+=" -j \"$ADDITIONAL_JETTY_CONFIG\""
+ shift 2
+ ;;
+ -k|-key)
+ STOP_KEY="$2"
+ shift 2
+ ;;
+ -help|-usage)
+ print_usage "$SCRIPT_CMD"
+ exit 0
+ ;;
+ -noprompt)
+ noprompt=true
+ PASS_TO_RUN_EXAMPLE+=" -noprompt"
+ shift
+ ;;
+ -V|-verbose)
+ verbose=true
+ PASS_TO_RUN_EXAMPLE+=" --verbose"
+ shift
+ ;;
+ -v)
+ SOLR_LOG_LEVEL=DEBUG
+ shift
+ ;;
+ -q)
+ SOLR_LOG_LEVEL=WARN
+ shift
+ ;;
+ -all)
+ stop_all=true
+ shift
+ ;;
+ -force)
+ FORCE=true
+ PASS_TO_RUN_EXAMPLE+=" -force"
+ shift
+ ;;
+ --)
+ shift
+ break
+ ;;
+ *)
+ if [ "${1:0:2}" == "-D" ]; then
+ # pass thru any opts that begin with -D (java system props)
+ SOLR_OPTS+=("$1")
+ PASS_TO_RUN_EXAMPLE+=" $1"
+ shift
+ else
+ if [ "$1" != "" ]; then
+ print_usage "$SCRIPT_CMD" "$1 is not supported by this script"
+ exit 1
+ else
+ break # out-of-args, stop looping
+ fi
+ fi
+ ;;
+ esac
+ done
+fi
+
+if [[ $SOLR_LOG_LEVEL ]] ; then
+ SOLR_LOG_LEVEL_OPT="-Dsolr.log.level=$SOLR_LOG_LEVEL"
+fi
+
+if [ -z "$SOLR_SERVER_DIR" ]; then
+ SOLR_SERVER_DIR="$DEFAULT_SERVER_DIR"
+fi
+
+if [ ! -e "$SOLR_SERVER_DIR" ]; then
+ echo -e "\nSolr server directory $SOLR_SERVER_DIR not found!\n"
+ exit 1
+fi
+
+if [[ "$FG" == 'true' && "$EXAMPLE" != "" ]]; then
+ FG='false'
+ echo -e "\nWARNING: Foreground mode (-f) not supported when running examples.\n"
+fi
+
+#
+# If the user specified an example to run, invoke the run_example tool (Java app) and exit
+# otherwise let this script proceed to process the user request
+#
+if [ -n "$EXAMPLE" ] && [ "$SCRIPT_CMD" == "start" ]; then
+ run_tool run_example -e $EXAMPLE -d "$SOLR_SERVER_DIR" -urlScheme $SOLR_URL_SCHEME $PASS_TO_RUN_EXAMPLE
+ exit $?
+fi
+
+############# start/stop logic below here ################
+
+if $verbose ; then
+ echo "Using Solr root directory: $SOLR_TIP"
+ echo "Using Java: $JAVA"
+ "$JAVA" -version
+fi
+
+if [ "$SOLR_HOST" != "" ]; then
+ SOLR_HOST_ARG=("-Dhost=$SOLR_HOST")
+else
+ SOLR_HOST_ARG=()
+fi
+
+if [ -z "$STOP_KEY" ]; then
+ STOP_KEY='solrrocks'
+fi
+
+# stop all if no port specified
+if [[ "$SCRIPT_CMD" == "stop" && -z "$SOLR_PORT" ]]; then
+ if $stop_all; then
+ none_stopped=true
+ find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | while read PIDF
+ do
+ NEXT_PID=`cat "$PIDF"`
+ port=`jetty_port "$NEXT_PID"`
+ if [ "$port" != "" ]; then
+ stop_solr "$SOLR_SERVER_DIR" "$port" "$STOP_KEY" "$NEXT_PID"
+ none_stopped=false
+ fi
+ rm -f "$PIDF"
+ done
+ # TODO: none_stopped doesn't get reflected across the subshell
+ # This can be uncommented once we find a clean way out of it
+ # 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
+ none_stopped=true
+ numSolrs=`find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | wc -l | tr -d ' '`
+ if [ $numSolrs -eq 1 ]; then
+ # only do this if there is only 1 node running, otherwise they must provide the -p or -all
+ PID="$(cat "$(find "$SOLR_PID_DIR" -name "solr-*.pid" -type f)")"
+ CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $PID | sort -r | tr -d ' '`
+ if [ "$CHECK_PID" != "" ]; then
+ port=`jetty_port "$CHECK_PID"`
+ if [ "$port" != "" ]; then
+ stop_solr "$SOLR_SERVER_DIR" "$port" "$STOP_KEY" "$CHECK_PID"
+ none_stopped=false
+ fi
+ fi
+ fi
+
+ if $none_stopped; then
+ if [ $numSolrs -gt 0 ]; then
+ echo -e "\nFound $numSolrs Solr nodes running! Must either specify a port using -p or -all to stop all Solr nodes on this host.\n"
+ else
+ echo -e "\nNo Solr nodes found to stop.\n"
+ fi
+ exit 1
+ fi
+ fi
+ exit
+fi
+
+if [ -z "$SOLR_PORT" ]; then
+ SOLR_PORT=8983
+fi
+
+if [ -z "$STOP_PORT" ]; then
+ STOP_PORT=`expr $SOLR_PORT - 1000`
+fi
+
+if [ "$SCRIPT_CMD" == "start" ] || [ "$SCRIPT_CMD" == "restart" ] ; then
+ if [[ "$(whoami)" == "root" ]] && [[ "$FORCE" == "false" ]] ; then
+ echo "WARNING: Starting Solr as the root user is a security risk and not considered best practice. Exiting."
+ echo " Please consult the Reference Guide. To override this check, start with argument '-force'"
+ exit 1
+ fi
+fi
+
+if [[ "$SCRIPT_CMD" == "start" ]]; then
+ # see if Solr is already running
+ SOLR_PID=`solr_pid_by_port "$SOLR_PORT"`
+
+ if [ -z "$SOLR_PID" ]; then
+ # not found using the pid file ... but use ps to ensure not found
+ SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
+ fi
+
+ if [ "$SOLR_PID" != "" ]; then
+ echo -e "\nPort $SOLR_PORT is already being used by another process (pid: $SOLR_PID)\nPlease choose a different port using the -p option.\n"
+ exit 1
+ fi
+else
+ # either stop or restart
+ # see if Solr is already running
+ SOLR_PID=`solr_pid_by_port "$SOLR_PORT"`
+ if [ -z "$SOLR_PID" ]; then
+ # not found using the pid file ... but use ps to ensure not found
+ SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
+ fi
+ if [ "$SOLR_PID" != "" ]; then
+ stop_solr "$SOLR_SERVER_DIR" "$SOLR_PORT" "$STOP_KEY" "$SOLR_PID"
+ else
+ if [ "$SCRIPT_CMD" == "stop" ]; then
+ echo -e "No process found for Solr node running on port $SOLR_PORT"
+ exit 1
+ fi
+ fi
+fi
+
+if [ -z "$SOLR_HOME" ]; then
+ SOLR_HOME="$SOLR_SERVER_DIR/solr"
+elif [[ $SOLR_HOME != /* ]]; then
+ if [[ -d "`pwd`/$SOLR_HOME" ]]; then
+ SOLR_HOME="$(pwd)/$SOLR_HOME"
+ elif [[ -d "$SOLR_SERVER_DIR/$SOLR_HOME" ]]; then
+ SOLR_HOME="$SOLR_SERVER_DIR/$SOLR_HOME"
+ SOLR_PID_DIR="$SOLR_HOME"
+ fi
+fi
+
+# Set the default configset dir to be bootstrapped as _default
+if [ -z "$DEFAULT_CONFDIR" ]; then
+ DEFAULT_CONFDIR="$SOLR_SERVER_DIR/solr/configsets/_default/conf"
+fi
+
+# This is quite hacky, but examples rely on a different log4j2.xml
+# so that we can write logs for examples to $SOLR_HOME/../logs
+if [ -z "$SOLR_LOGS_DIR" ]; then
+ SOLR_LOGS_DIR="$SOLR_SERVER_DIR/logs"
+fi
+EXAMPLE_DIR="$SOLR_TIP/example"
+if [ "${SOLR_HOME:0:${#EXAMPLE_DIR}}" = "$EXAMPLE_DIR" ]; then
+ LOG4J_PROPS="$EXAMPLE_DIR/resources/log4j2.xml"
+ SOLR_LOGS_DIR="$SOLR_HOME/../logs"
+fi
+
+LOG4J_CONFIG=()
+if [ -n "$LOG4J_PROPS" ]; then
+ LOG4J_CONFIG+=("-Dlog4j.configurationFile=file:$LOG4J_PROPS")
+fi
+
+if [ "$SCRIPT_CMD" == "stop" ]; then
+ # already stopped, script is done.
+ exit 0
+fi
+
+# NOTE: If the script gets to here, then it is starting up a Solr node.
+
+if [ ! -e "$SOLR_HOME" ]; then
+ echo -e "\nSolr home directory $SOLR_HOME not found!\n"
+ exit 1
+fi
+if [[ $SOLR_DATA_HOME ]] && [ ! -e "$SOLR_DATA_HOME" ]; then
+ echo -e "\nSolr data home directory $SOLR_DATA_HOME not found!\n"
+ exit 1
+fi
+if $verbose ; then
+ q=""
+else
+ q="-q"
+fi
+# Rotate and clean on startup. Default to false since 7.4 as log4j2 handles startup rotation
+if [ "${SOLR_LOG_PRESTART_ROTATION:=false}" == "true" ]; then
+ # Enable any of these if you require old remove/archive behavior
+ #run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -remove_old_solr_logs 7 || echo "Failed removing old solr logs"
+ #run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -archive_gc_logs $q || echo "Failed archiving old GC logs"
+ #run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -archive_console_logs || echo "Failed archiving old console logs"
+ run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -rotate_solr_logs 10 || echo "Failed rotating old solr logs"
+fi
+
+# Establish default GC logging opts if no env var set (otherwise init to sensible default)
+if [ -z ${GC_LOG_OPTS+x} ]; then
+ if [[ "$JAVA_VER_NUM" -lt "9" ]] ; then
+ GC_LOG_OPTS=('-verbose:gc' '-XX:+PrintHeapAtGC' '-XX:+PrintGCDetails' \
+ '-XX:+PrintGCDateStamps' '-XX:+PrintGCTimeStamps' '-XX:+PrintTenuringDistribution' \
+ '-XX:+PrintGCApplicationStoppedTime')
+ else
+ GC_LOG_OPTS=('-Xlog:gc*')
+ fi
+else
+ GC_LOG_OPTS=($GC_LOG_OPTS)
+fi
+
+# if verbose gc logging enabled, setup the location of the log file and rotation
+if [ "$GC_LOG_OPTS" != "" ]; then
+ if [[ "$JAVA_VER_NUM" -lt "9" ]] ; then
+ gc_log_flag="-Xloggc"
+ if [ "$JAVA_VENDOR" == "IBM J9" ]; then
+ gc_log_flag="-Xverbosegclog"
+ fi
+ GC_LOG_OPTS+=("$gc_log_flag:$SOLR_LOGS_DIR/solr_gc.log" '-XX:+UseGCLogFileRotation' '-XX:NumberOfGCLogFiles=9' '-XX:GCLogFileSize=20M')
+ else
+ # http://openjdk.java.net/jeps/158
+ for i in "${!GC_LOG_OPTS[@]}";
+ do
+ # for simplicity, we only look at the prefix '-Xlog:gc'
+ # (if 'all' or multiple tags are used starting with anything other then 'gc' the user is on their own)
+ # if a single additional ':' exists in param, then there is already an explicit output specifier
+ GC_LOG_OPTS[$i]=$(echo ${GC_LOG_OPTS[$i]} | sed "s|^\(-Xlog:gc[^:]*$\)|\1:file=$SOLR_LOGS_DIR/solr_gc.log:time,uptime:filecount=9,filesize=20000|")
+ done
+ fi
+fi
+
+# If ZK_HOST is defined, the assume SolrCloud mode
+if [[ -n "$ZK_HOST" ]]; then
+ SOLR_MODE="solrcloud"
+fi
+
+if [ "$SOLR_MODE" == 'solrcloud' ]; then
+ if [ -z "$ZK_CLIENT_TIMEOUT" ]; then
+ ZK_CLIENT_TIMEOUT="15000"
+ fi
+
+ CLOUD_MODE_OPTS=("-DzkClientTimeout=$ZK_CLIENT_TIMEOUT")
+
+ if [ "$ZK_HOST" != "" ]; then
+ CLOUD_MODE_OPTS+=("-DzkHost=$ZK_HOST")
+ else
+ if $verbose ; then
+ echo "Configuring SolrCloud to launch an embedded Zookeeper using -DzkRun"
+ fi
+
+ CLOUD_MODE_OPTS+=('-DzkRun')
+ fi
+
+ # and if collection1 needs to be bootstrapped
+ if [ -e "$SOLR_HOME/collection1/core.properties" ]; then
+ CLOUD_MODE_OPTS+=('-Dbootstrap_confdir=./solr/collection1/conf' '-Dcollection.configName=myconf' '-DnumShards=1')
+ fi
+
+else
+ if [ ! -e "$SOLR_HOME/solr.xml" ]; then
+ echo -e "\nSolr home directory $SOLR_HOME must contain a solr.xml file!\n"
+ exit 1
+ fi
+fi
+
+# These are useful for attaching remote profilers like VisualVM/JConsole
+if [ "$ENABLE_REMOTE_JMX_OPTS" == "true" ]; then
+
+ if [ -z "$RMI_PORT" ]; then
+ RMI_PORT=`expr $SOLR_PORT + 10000`
+ if [ $RMI_PORT -gt 65535 ]; then
+ echo -e "\nRMI_PORT is $RMI_PORT, which is invalid!\n"
+ exit 1
+ fi
+ fi
+
+ REMOTE_JMX_OPTS=('-Dcom.sun.management.jmxremote' \
+ '-Dcom.sun.management.jmxremote.local.only=false' \
+ '-Dcom.sun.management.jmxremote.ssl=false' \
+ '-Dcom.sun.management.jmxremote.authenticate=false' \
+ "-Dcom.sun.management.jmxremote.port=$RMI_PORT" \
+ "-Dcom.sun.management.jmxremote.rmi.port=$RMI_PORT")
+
+ # if the host is set, then set that as the rmi server hostname
+ if [ "$SOLR_HOST" != "" ]; then
+ REMOTE_JMX_OPTS+=("-Djava.rmi.server.hostname=$SOLR_HOST")
+ fi
+else
+ REMOTE_JMX_OPTS=()
+fi
+
+JAVA_MEM_OPTS=()
+if [ -z "$SOLR_HEAP" ] && [ -n "$SOLR_JAVA_MEM" ]; then
+ JAVA_MEM_OPTS=($SOLR_JAVA_MEM)
+else
+ SOLR_HEAP="${SOLR_HEAP:-512m}"
+ JAVA_MEM_OPTS=("-Xms$SOLR_HEAP" "-Xmx$SOLR_HEAP")
+fi
+
+# Pick default for Java thread stack size, and then add to SOLR_OPTS
+if [ -z ${SOLR_JAVA_STACK_SIZE+x} ]; then
+ SOLR_JAVA_STACK_SIZE='-Xss256k'
+fi
+SOLR_OPTS+=($SOLR_JAVA_STACK_SIZE)
+
+if [ -z "$SOLR_TIMEZONE" ]; then
+ SOLR_TIMEZONE='UTC'
+fi
+
+# Launches Solr in foreground/background depending on parameters
+function launch_solr() {
+
+ run_in_foreground="$1"
+ stop_port="$STOP_PORT"
+
+ SOLR_ADDL_ARGS="$2"
+ SOLR_JETTY_ADDL_CONFIG="$3"
+
+ # define default GC_TUNE
+ if [ -z ${GC_TUNE+x} ]; then
+ GC_TUNE=('-XX:NewRatio=3' \
+ '-XX:SurvivorRatio=4' \
+ '-XX:TargetSurvivorRatio=90' \
+ '-XX:MaxTenuringThreshold=8' \
+ '-XX:+UseConcMarkSweepGC' \
+ '-XX:ConcGCThreads=4' '-XX:ParallelGCThreads=4' \
+ '-XX:+CMSScavengeBeforeRemark' \
+ '-XX:PretenureSizeThreshold=64m' \
+ '-XX:+UseCMSInitiatingOccupancyOnly' \
+ '-XX:CMSInitiatingOccupancyFraction=50' \
+ '-XX:CMSMaxAbortablePrecleanTime=6000' \
+ '-XX:+CMSParallelRemarkEnabled' \
+ '-XX:+ParallelRefProcEnabled' \
+ '-XX:-OmitStackTraceInFastThrow')
+ else
+ GC_TUNE=($GC_TUNE)
+ fi
+
+ if [ -n "$SOLR_WAIT_FOR_ZK" ]; then
+ WAIT_FOR_ZK_PROP="-DwaitForZk=$SOLR_WAIT_FOR_ZK"
+ SOLR_OPTS+=($WAIT_FOR_ZK_PROP)
+ fi
+
+ # If SSL-related system props are set, add them to SOLR_OPTS
+ if [ "$SOLR_SSL_ENABLED" ]; then
+ # If using SSL and solr.jetty.https.port not set explicitly, use the jetty.port
+ SSL_PORT_PROP="-Dsolr.jetty.https.port=$SOLR_PORT"
+ SOLR_OPTS+=($SOLR_SSL_OPTS "$SSL_PORT_PROP")
+ fi
+
+ # If authentication system props are set, add them to SOLR_OPTS
+ if [ -n "$AUTHC_OPTS" ]; then
+ SOLR_OPTS+=($AUTHC_OPTS)
+ fi
+
+ if $verbose ; then
+ echo -e "\nStarting Solr using the following settings:"
+ echo -e " JAVA = $JAVA"
+ echo -e " SOLR_SERVER_DIR = $SOLR_SERVER_DIR"
+ echo -e " SOLR_HOME = $SOLR_HOME"
+ echo -e " SOLR_HOST = $SOLR_HOST"
+ echo -e " SOLR_PORT = $SOLR_PORT"
+ echo -e " STOP_PORT = $STOP_PORT"
+ echo -e " JAVA_MEM_OPTS = ${JAVA_MEM_OPTS[@]}"
+ echo -e " GC_TUNE = ${GC_TUNE[@]}"
+ echo -e " GC_LOG_OPTS = ${GC_LOG_OPTS[@]}"
+ echo -e " SOLR_TIMEZONE = $SOLR_TIMEZONE"
+
+ if [ "$SOLR_MODE" == "solrcloud" ]; then
+ echo -e " CLOUD_MODE_OPTS = ${CLOUD_MODE_OPTS[@]}"
+ fi
+
+ if [ "$SOLR_OPTS" != "" ]; then
+ echo -e " SOLR_OPTS = ${SOLR_OPTS[@]}"
+ fi
+
+ if [ "$SOLR_ADDL_ARGS" != "" ]; then
+ echo -e " SOLR_ADDL_ARGS = $SOLR_ADDL_ARGS"
+ fi
+
+ if [ "$ENABLE_REMOTE_JMX_OPTS" == "true" ]; then
+ echo -e " RMI_PORT = $RMI_PORT"
+ echo -e " REMOTE_JMX_OPTS = ${REMOTE_JMX_OPTS[@]}"
+ fi
+
+ if [ "$SOLR_LOG_LEVEL" != "" ]; then
+ echo -e " SOLR_LOG_LEVEL = $SOLR_LOG_LEVEL"
+ fi
+
+ if [ "$SOLR_DATA_HOME" != "" ]; then
+ echo -e " SOLR_DATA_HOME = $SOLR_DATA_HOME"
+ fi
+ echo -e "\n"
+ fi
+
+ # need to launch solr from the server dir
+ cd "$SOLR_SERVER_DIR"
+
+ if [ ! -e "$SOLR_SERVER_DIR/start.jar" ]; then
+ echo -e "\nERROR: start.jar file not found in $SOLR_SERVER_DIR!\nPlease check your -d parameter to set the correct Solr server directory.\n"
+ exit 1
+ fi
+
+ SOLR_START_OPTS=('-server' "${JAVA_MEM_OPTS[@]}" "${GC_TUNE[@]}" "${GC_LOG_OPTS[@]}" \
+ "${REMOTE_JMX_OPTS[@]}" "${CLOUD_MODE_OPTS[@]}" $SOLR_LOG_LEVEL_OPT -Dsolr.log.dir="$SOLR_LOGS_DIR" \
+ "-Djetty.port=$SOLR_PORT" "-DSTOP.PORT=$stop_port" "-DSTOP.KEY=$STOP_KEY" \
+ "${SOLR_HOST_ARG[@]}" "-Duser.timezone=$SOLR_TIMEZONE" \
+ "-Djetty.home=$SOLR_SERVER_DIR" "-Dsolr.solr.home=$SOLR_HOME" "-Dsolr.data.home=$SOLR_DATA_HOME" "-Dsolr.install.dir=$SOLR_TIP" \
+ "-Dsolr.default.confdir=$DEFAULT_CONFDIR" "${LOG4J_CONFIG[@]}" "${SOLR_OPTS[@]}")
+
+ if [ "$SOLR_MODE" == "solrcloud" ]; then
+ IN_CLOUD_MODE=" in SolrCloud mode"
+ fi
+
+ mkdir -p "$SOLR_LOGS_DIR" 2>/dev/null
+ if [ $? -ne 0 ]; then
+ echo -e "\nERROR: Logs directory $SOLR_LOGS_DIR could not be created. Exiting"
+ exit 1
+ fi
+ if [ ! -w "$SOLR_LOGS_DIR" ]; then
+ echo -e "\nERROR: Logs directory $SOLR_LOGS_DIR is not writable. Exiting"
+ exit 1
+ fi
+ case "$SOLR_LOGS_DIR" in
+ contexts|etc|lib|modules|resources|scripts|solr|solr-webapp)
+ echo -e "\nERROR: Logs directory $SOLR_LOGS_DIR is invalid. Reserved for the system. Exiting"
+ exit 1
+ ;;
+ esac
+
+ if [ "$run_in_foreground" == "true" ]; then
+ exec "$JAVA" "${SOLR_START_OPTS[@]}" $SOLR_ADDL_ARGS -jar start.jar "${SOLR_JETTY_CONFIG[@]}" $SOLR_JETTY_ADDL_CONFIG
+ else
+ # run Solr in the background
+ nohup "$JAVA" "${SOLR_START_OPTS[@]}" $SOLR_ADDL_ARGS -Dsolr.log.muteconsole \
+ "-XX:OnOutOfMemoryError=$SOLR_TIP/bin/oom_solr.sh $SOLR_PORT $SOLR_LOGS_DIR" \
+ -jar start.jar "${SOLR_JETTY_CONFIG[@]}" $SOLR_JETTY_ADDL_CONFIG \
+ 1>"$SOLR_LOGS_DIR/solr-$SOLR_PORT-console.log" 2>&1 & echo $! > "$SOLR_PID_DIR/solr-$SOLR_PORT.pid"
+
+ # check if /proc/sys/kernel/random/entropy_avail exists then check output of cat /proc/sys/kernel/random/entropy_avail to see if less than 300
+ if [[ -f /proc/sys/kernel/random/entropy_avail ]] && (( `cat /proc/sys/kernel/random/entropy_avail` < 300)); then
+ echo "Warning: Available entropy is low. As a result, use of the UUIDField, SSL, or any other features that require"
+ echo "RNG might not work properly. To check for the amount of available entropy, use 'cat /proc/sys/kernel/random/entropy_avail'."
+ echo ""
+ fi
+ # no lsof on cygwin though
+ if hash lsof 2>/dev/null ; then # hash returns true if lsof is on the path
+ echo -n "Waiting up to $SOLR_STOP_WAIT seconds to see Solr running on port $SOLR_PORT"
+ # Launch in a subshell to show the spinner
+ (loops=0
+ while true
+ do
+ running=`lsof -PniTCP:$SOLR_PORT -sTCP:LISTEN`
+ if [ -z "$running" ]; then
+ slept=$((loops * 2))
+ if [ $slept -lt $SOLR_STOP_WAIT ]; then
+ sleep 2
+ loops=$[$loops+1]
+ else
+ echo -e "Still not seeing Solr listening on $SOLR_PORT after $SOLR_STOP_WAIT seconds!"
+ tail -30 "$SOLR_LOGS_DIR/solr.log"
+ exit # subshell!
+ fi
+ else
+ SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
+ echo -e "\nStarted Solr server on port $SOLR_PORT (pid=$SOLR_PID). Happy searching!\n"
+ exit # subshell!
+ fi
+ done) &
+ spinner $!
+ else
+ echo -e "NOTE: Please install lsof as this script needs it to determine if Solr is listening on port $SOLR_PORT."
+ sleep 10
+ SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
+ echo -e "\nStarted Solr server on port $SOLR_PORT (pid=$SOLR_PID). Happy searching!\n"
+ return;
+ fi
+ fi
+}
+
+launch_solr "$FG" "$ADDITIONAL_CMD_OPTS" "$ADDITIONAL_JETTY_CONFIG"
+
+exit $?
diff --git a/solr/bin/oom_log.cmd b/solr/bin/oom_log.cmd
new file mode 100644
index 0000000..e534296
--- /dev/null
+++ b/solr/bin/oom_log.cmd
@@ -0,0 +1,32 @@
+@REM
+@REM Licensed to the Apache Software Foundation (ASF) under one or more
+@REM contributor license agreements. See the NOTICE file distributed with
+@REM this work for additional information regarding copyright ownership.
+@REM The ASF licenses this file to You under the Apache License, Version 2.0
+@REM (the "License"); you may not use this file except in compliance with
+@REM the License. You may obtain a copy of the License at
+@REM
+@REM http://www.apache.org/licenses/LICENSE-2.0
+@REM
+@REM Unless required by applicable law or agreed to in writing, software
+@REM distributed under the License is distributed on an "AS IS" BASIS,
+@REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@REM See the License for the specific language governing permissions and
+@REM limitations under the License.
+
+@echo off
+
+set SOLR_PID=%1
+shift
+set SOLR_PORT=%1
+shift
+set SOLR_LOGS_DIR=%1
+
+set MyDate=%date:~10,4%-%date:~4,2%-%date:~7,2%
+set MyTime=%time:~0,2%-%time:~3,2%-%time:~6,2%
+if "%MyTime~0,1%"==" " set MyTime=0%MyTime:~1%
+set NOW=%MyDate%_%MyTime%
+set LOGFILE=%SOLR_LOGS_DIR%\solr_oom_log-%SOLR_PORT%-%NOW%.log
+
+echo "Logging OOM event for Solr process $SOLR_PID, port $SOLR_PORT" > $LOGFILE
+echo "Process has been terminated" >> $LOGFILE
diff --git a/solr/bin/oom_log.sh b/solr/bin/oom_log.sh
new file mode 100644
index 0000000..51e1f47
--- /dev/null
+++ b/solr/bin/oom_log.sh
@@ -0,0 +1,28 @@
+#!/bin/sh
+
+# Licensed to the Apache Software Foundation (ASF) under one or more
+# contributor license agreements. See the NOTICE file distributed with
+# this work for additional information regarding copyright ownership.
+# The ASF licenses this file to You under the Apache License, Version 2.0
+# (the "License"); you may not use this file except in compliance with
+# the License. You may obtain a copy of the License at
+#
+# http://www.apache.org/licenses/LICENSE-2.0
+#
+# Unless required by applicable law or agreed to in writing, software
+# distributed under the License is distributed on an "AS IS" BASIS,
+# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+# See the License for the specific language governing permissions and
+# limitations under the License.
+
+SOLR_PID="$1"
+shift
+SOLR_PORT="$1"
+shift
+SOLR_LOGS_DIR="$1"
+shift
+NOW=$(date +"%F_%H-%M-%S")
+(
+echo "Logging OOM event for Solr process $SOLR_PID, port $SOLR_PORT"
+echo "Process has been terminated"
+) | tee $SOLR_LOGS_DIR/solr_oom_log-$SOLR_PORT-$NOW.log
diff --git a/solr/bin/oom_log_nokill.cmd b/solr/bin/oom_log_nokill.cmd
new file mode 100644
index 0000000..6fa1598
--- /dev/null
+++ b/solr/bin/oom_log_nokill.cmd
@@ -0,0 +1,32 @@
+@REM
+@REM Licensed to the Apache Software Foundation (ASF) under one or more
+@REM contributor license agreements. See the NOTICE file distributed with
+@REM this work for additional information regarding copyright ownership.
+@REM The ASF licenses this file to You under the Apache License, Version 2.0
+@REM (the "License"); you may not use this file except in compliance with
+@REM the License. You may obtain a copy of the License at
+@REM
+@REM http://www.apache.org/licenses/LICENSE-2.0
+@REM
+@REM Unless required by applicable law or agreed to in writing, software
+@REM distributed under the License is distributed on an "AS IS" BASIS,
+@REM WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+@REM See the License for the specific language governing permissions and
+@REM limitations under the License.
+
+@echo off
+
+set SOLR_PID=%1
+shift
+set SOLR_PORT=%1
+shift
+set SOLR_LOGS_DIR=%1
+
+set MyDate=%date:~10,4%-%date:~4,2%-%date:~7,2%
+set MyTime=%time:~0,2%-%time:~3,2%-%time:~6,2%
+if "%MyTime~0,1%"==" " set MyTime=0%MyTime:~1%
+set NOW=%MyDate%_%MyTime%
+set LOGFILE=%SOLR_LOGS_DIR%\solr_oom_log-%SOLR_PORT%-%NOW%.log
+
+echo "Logging OOM event for Solr process $SOLR_PID, port $SOLR_PORT" > $LOGFILE
+echo "Process has NOT been terminated, operation unpredictable" >> $LOGFILE
diff --git a/solr/bin/oom_solr.sh b/solr/bin/oom_solr.sh
index 5ecba6b..dc9cf49 100755
--- a/solr/bin/oom_solr.sh
+++ b/solr/bin/oom_solr.sh
@@ -1,4 +1,4 @@
-#!/usr/bin/env bash
+#!/bin/sh
# Licensed to the Apache Software Foundation (ASF) under one or more
# contributor license agreements. See the NOTICE file distributed with
@@ -15,16 +15,18 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-SOLR_PORT=$1
-SOLR_LOGS_DIR=$2
-SOLR_PID=`ps auxww | grep start.jar | grep $SOLR_PORT | grep -v grep | awk '{print $2}' | sort -r`
-if [ -z "$SOLR_PID" ]; then
- echo "Couldn't find Solr process running on port $SOLR_PORT!"
- exit
-fi
-NOW=$(date +"%F_%H_%M_%S")
+SOLR_PID="$1"
+shift
+SOLR_PORT="$1"
+shift
+SOLR_LOGS_DIR="$1"
+shift
+NOW=$(date +"%F_%H-%M-%S")
+# Kill the PID with the -KILL signal. OOM makes program operation
+# completely unpredictable, so we can't be sure that shutdown hooks
+# will work. The process could be unresponsive.
(
-echo "Running OOM killer script for process $SOLR_PID for Solr on port $SOLR_PORT"
+echo "Running OOM killer script for Solr process $SOLR_PID, port $SOLR_PORT"
kill -9 $SOLR_PID
echo "Killed process $SOLR_PID"
) | tee $SOLR_LOGS_DIR/solr_oom_killer-$SOLR_PORT-$NOW.log
diff --git a/solr/bin/solr b/solr/bin/solr
index 53cf84d..6506244 100755
--- a/solr/bin/solr
+++ b/solr/bin/solr
@@ -14,2114 +14,143 @@
# See the License for the specific language governing permissions and
# limitations under the License.
-
# CONTROLLING STARTUP:
#
-# Use solr -help to see available command-line options. In addition
-# to passing command-line options, this script looks for an include
-# file named solr.in.sh to set environment variables. Specifically,
-# the following locations are searched in this order:
+# TODO: Write instructions here.
#
-# ./
-# $HOME/.solr.in.sh
-# /usr/share/solr
-# /usr/local/share/solr
-# /var/solr/
-# /opt/solr
-#
-# Another option is to specify the full path to the include file in the
-# environment. For example:
-#
-# $ SOLR_INCLUDE=/path/to/solr.in.sh solr start
-#
-# Note: This is particularly handy for running multiple instances on a
-# single installation, or for quick tests.
-#
-# Finally, developers and enthusiasts who frequently run from an SVN
-# checkout, and do not want to locally modify bin/solr.in.sh, can put
-# a customized include file at ~/.solr.in.sh.
-#
-# If you would rather configure startup entirely from the environment, you
-# can disable the include by exporting an empty SOLR_INCLUDE, or by
-# ensuring that no include files exist in the aforementioned search list.
-
-SOLR_SCRIPT="$0"
+##### Setup
+DEFAULT_X_WHICH=/usr/bin/which
verbose=false
-THIS_OS=`uname -s`
-
-# What version of Java is required to run this version of Solr.
-JAVA_VER_REQ="8"
-
stop_all=false
-
-# for now, we don't support running this script from cygwin due to problems
-# like not having lsof, ps auxww, curl, and awkward directory handling
-if [ "${THIS_OS:0:6}" == "CYGWIN" ]; then
- echo -e "This script does not support cygwin due to severe limitations and lack of adherence\nto BASH standards, such as lack of lsof, curl, and ps options.\n\nPlease use the native solr.cmd script on Windows!"
- exit 1
-fi
-
-# Resolve symlinks to this script
-while [ -h "$SOLR_SCRIPT" ] ; do
- ls=`ls -ld "$SOLR_SCRIPT"`
- # Drop everything prior to ->
- link=`expr "$ls" : '.*-> \(.*\)$'`
- if expr "$link" : '/.*' > /dev/null; then
- SOLR_SCRIPT="$link"
- else
- SOLR_SCRIPT=`dirname "$SOLR_SCRIPT"`/"$link"
- fi
-done
-
-SOLR_TIP=`dirname "$SOLR_SCRIPT"`/..
-SOLR_TIP=`cd "$SOLR_TIP"; pwd`
-DEFAULT_SERVER_DIR="$SOLR_TIP/server"
-
-# If an include wasn't specified in the environment, then search for one...
-if [ -z "$SOLR_INCLUDE" ]; then
- # Locations (in order) to use when searching for an include file.
- for include in "`dirname "$0"`/solr.in.sh" \
- "$HOME/.solr.in.sh" \
- /usr/share/solr/solr.in.sh \
- /usr/local/share/solr/solr.in.sh \
- /etc/default/solr.in.sh \
- /opt/solr/solr.in.sh; do
- if [ -r "$include" ]; then
- SOLR_INCLUDE="$include"
- . "$include"
- break
- fi
- done
-elif [ -r "$SOLR_INCLUDE" ]; then
- . "$SOLR_INCLUDE"
-fi
-
-if [ -z "$SOLR_PID_DIR" ]; then
- SOLR_PID_DIR="$SOLR_TIP/bin"
-fi
-
-if [ -n "$SOLR_JAVA_HOME" ]; then
- JAVA="$SOLR_JAVA_HOME/bin/java"
-elif [ -n "$JAVA_HOME" ]; then
- for java in "$JAVA_HOME"/bin/amd64/java "$JAVA_HOME"/bin/java; do
- if [ -x "$java" ]; then
- JAVA="$java"
- break
- fi
- done
- if [ -z "$JAVA" ]; then
- echo >&2 "The currently defined JAVA_HOME ($JAVA_HOME) refers"
- echo >&2 "to a location where Java could not be found. Aborting."
- echo >&2 "Either fix the JAVA_HOME variable or remove it from the"
- echo >&2 "environment so that the system PATH will be searched."
- exit 1
- fi
-else
- JAVA=java
-fi
-
-if [ -z "$SOLR_STOP_WAIT" ]; then
- SOLR_STOP_WAIT=180
-fi
-# test that Java exists, is executable and correct version
-JAVA_VER=$("$JAVA" -version 2>&1)
-if [[ $? -ne 0 ]] ; then
- echo >&2 "Java not found, or an error was encountered when running java."
- echo >&2 "A working Java $JAVA_VER_REQ JRE is required to run Solr!"
- echo >&2 "Please install latest version of Java $JAVA_VER_REQ or set JAVA_HOME properly."
- echo >&2 "Command that we tried: '${JAVA} -version', with response:"
- echo >&2 "${JAVA_VER}"
- echo >&2
- echo >&2 "Debug information:"
- echo >&2 "JAVA_HOME: ${JAVA_HOME:-N/A}"
- echo >&2 "Active Path:"
- echo >&2 "${PATH}"
- exit 1
-else
- JAVA_VER_NUM=$(echo $JAVA_VER | head -1 | awk -F '"' '/version/ {print $2}' | sed -e's/^1\.//' | sed -e's/[._-].*$//')
- if [[ "$JAVA_VER_NUM" -lt "$JAVA_VER_REQ" ]] ; then
- echo >&2 "Your current version of Java is too old to run this version of Solr."
- echo >&2 "We found major version $JAVA_VER_NUM, using command '${JAVA} -version', with response:"
- echo >&2 "${JAVA_VER}"
- echo >&2
- echo >&2 "Please install latest version of Java $JAVA_VER_REQ or set JAVA_HOME properly."
- echo >&2
- echo >&2 "Debug information:"
- echo >&2 "JAVA_HOME: ${JAVA_HOME:-N/A}"
- echo >&2 "Active Path:"
- echo >&2 "${PATH}"
- exit 1
- fi
- JAVA_VENDOR="Oracle"
- if [ "`echo $JAVA_VER | grep -i "IBM J9"`" != "" ]; then
- JAVA_VENDOR="IBM J9"
- fi
-fi
-
-
-# Select HTTP OR HTTPS related configurations
-SOLR_URL_SCHEME=http
-SOLR_JETTY_CONFIG=()
-SOLR_SSL_OPTS=""
-
-if [ -n "$SOLR_HADOOP_CREDENTIAL_PROVIDER_PATH" ]; then
- SOLR_SSL_OPTS+=" -Dhadoop.security.credential.provider.path=$SOLR_HADOOP_CREDENTIAL_PROVIDER_PATH"
-fi
-
-if [ -z "$SOLR_SSL_ENABLED" ]; then
- if [ -n "$SOLR_SSL_KEY_STORE" ]; then
- SOLR_SSL_ENABLED="true" # implicitly from earlier behaviour
- else
- SOLR_SSL_ENABLED="false"
- fi
-fi
-if [ "$SOLR_SSL_ENABLED" == "true" ]; then
- SOLR_JETTY_CONFIG+=("--module=https")
- SOLR_JETTY_CONFIG+=("--lib=$DEFAULT_SERVER_DIR/solr-webapp/webapp/WEB-INF/lib/*")
- SOLR_URL_SCHEME=https
- if [ -n "$SOLR_SSL_KEY_STORE" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.jetty.keystore=$SOLR_SSL_KEY_STORE"
- fi
- if [ -n "$SOLR_SSL_KEY_STORE_PASSWORD" ]; then
- export SOLR_SSL_KEY_STORE_PASSWORD=$SOLR_SSL_KEY_STORE_PASSWORD
- fi
- if [ -n "$SOLR_SSL_KEY_STORE_TYPE" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.jetty.keystore.type=$SOLR_SSL_KEY_STORE_TYPE"
- fi
-
- if [ -n "$SOLR_SSL_TRUST_STORE" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.jetty.truststore=$SOLR_SSL_TRUST_STORE"
- fi
- if [ -n "$SOLR_SSL_TRUST_STORE_PASSWORD" ]; then
- export SOLR_SSL_TRUST_STORE_PASSWORD=$SOLR_SSL_TRUST_STORE_PASSWORD
- fi
- if [ -n "$SOLR_SSL_TRUST_STORE_TYPE" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.jetty.truststore.type=$SOLR_SSL_TRUST_STORE_TYPE"
- fi
-
- if [ -n "$SOLR_SSL_NEED_CLIENT_AUTH" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.jetty.ssl.needClientAuth=$SOLR_SSL_NEED_CLIENT_AUTH"
- fi
- if [ -n "$SOLR_SSL_WANT_CLIENT_AUTH" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.jetty.ssl.wantClientAuth=$SOLR_SSL_WANT_CLIENT_AUTH"
- fi
-
- if [ -n "$SOLR_SSL_CLIENT_KEY_STORE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStore=$SOLR_SSL_CLIENT_KEY_STORE"
-
- if [ -n "$SOLR_SSL_CLIENT_KEY_STORE_PASSWORD" ]; then
- export SOLR_SSL_CLIENT_KEY_STORE_PASSWORD=$SOLR_SSL_CLIENT_KEY_STORE_PASSWORD
- fi
- if [ -n "$SOLR_SSL_CLIENT_KEY_STORE_TYPE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStoreType=$SOLR_SSL_CLIENT_KEY_STORE_TYPE"
- fi
- else
- if [ -n "$SOLR_SSL_KEY_STORE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStore=$SOLR_SSL_KEY_STORE"
- fi
- if [ -n "$SOLR_SSL_KEY_STORE_TYPE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.keyStoreType=$SOLR_SSL_KEYSTORE_TYPE"
- fi
- fi
-
- if [ -n "$SOLR_SSL_CHECK_PEER_NAME" ]; then
- SOLR_SSL_OPTS+=" -Dsolr.ssl.checkPeerName=$SOLR_SSL_CHECK_PEER_NAME"
- fi
-
- if [ -n "$SOLR_SSL_CLIENT_TRUST_STORE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStore=$SOLR_SSL_CLIENT_TRUST_STORE"
-
- if [ -n "$SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD" ]; then
- export SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD=$SOLR_SSL_CLIENT_TRUST_STORE_PASSWORD
- fi
- if [ -n "$SOLR_SSL_CLIENT_TRUST_STORE_TYPE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStoreType=$SOLR_SSL_CLIENT_TRUST_STORE_TYPE"
- fi
- else
- if [ -n "$SOLR_SSL_TRUST_STORE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStore=$SOLR_SSL_TRUST_STORE"
- fi
-
- if [ -n "$SOLR_SSL_TRUST_STORE_TYPE" ]; then
- SOLR_SSL_OPTS+=" -Djavax.net.ssl.trustStoreType=$SOLR_SSL_TRUST_STORE_TYPE"
- fi
- fi
-else
- SOLR_JETTY_CONFIG+=("--module=http")
-fi
-
-# Authentication options
-if [ -z "$SOLR_AUTH_TYPE" ] && [ -n "$SOLR_AUTHENTICATION_OPTS" ]; then
- echo "WARNING: SOLR_AUTHENTICATION_OPTS environment variable configured without associated SOLR_AUTH_TYPE variable"
- echo " Please configure SOLR_AUTH_TYPE environment variable with the authentication type to be used."
- echo " Currently supported authentication types are [kerberos, basic]"
-fi
-
-if [ -n "$SOLR_AUTH_TYPE" ] && [ -n "$SOLR_AUTHENTICATION_CLIENT_BUILDER" ]; then
- echo "WARNING: SOLR_AUTHENTICATION_CLIENT_BUILDER and SOLR_AUTH_TYPE environment variables are configured together."
- echo " Use SOLR_AUTH_TYPE environment variable to configure authentication type to be used. "
- echo " Currently supported authentication types are [kerberos, basic]"
- echo " The value of SOLR_AUTHENTICATION_CLIENT_BUILDER environment variable will be ignored"
-fi
-
-if [ -n "$SOLR_AUTH_TYPE" ]; then
- case "$(echo $SOLR_AUTH_TYPE | awk '{print tolower($0)}')" in
- basic)
- SOLR_AUTHENTICATION_CLIENT_BUILDER="org.apache.solr.client.solrj.impl.PreemptiveBasicAuthClientBuilderFactory"
- ;;
- kerberos)
- SOLR_AUTHENTICATION_CLIENT_BUILDER="org.apache.solr.client.solrj.impl.Krb5HttpClientBuilder"
- ;;
- *)
- echo "ERROR: Value specified for SOLR_AUTH_TYPE environment variable is invalid."
- exit 1
- esac
-fi
-
-if [ "$SOLR_AUTHENTICATION_CLIENT_CONFIGURER" != "" ]; then
- echo "WARNING: Found unsupported configuration variable SOLR_AUTHENTICATION_CLIENT_CONFIGURER"
- echo " Please start using SOLR_AUTH_TYPE instead"
-fi
-if [ "$SOLR_AUTHENTICATION_CLIENT_BUILDER" != "" ]; then
- AUTHC_CLIENT_BUILDER_ARG="-Dsolr.httpclient.builder.factory=$SOLR_AUTHENTICATION_CLIENT_BUILDER"
-fi
-AUTHC_OPTS="$AUTHC_CLIENT_BUILDER_ARG $SOLR_AUTHENTICATION_OPTS"
-
-# Set the SOLR_TOOL_HOST variable for use when connecting to a running Solr instance
-if [ "$SOLR_HOST" != "" ]; then
- SOLR_TOOL_HOST="$SOLR_HOST"
-else
- SOLR_TOOL_HOST="localhost"
-fi
-
-function print_usage() {
- CMD="$1"
- ERROR_MSG="$2"
-
- if [ "$ERROR_MSG" != "" ]; then
- echo -e "\nERROR: $ERROR_MSG\n"
- fi
-
- if [ -z "$CMD" ]; then
- echo ""
- echo "Usage: solr COMMAND OPTIONS"
- echo " where COMMAND is one of: start, stop, restart, status, healthcheck, create, create_core, create_collection, delete, version, zk, auth, assert, config"
- echo ""
- echo " Standalone server example (start Solr running in the background on port 8984):"
- echo ""
- echo " ./solr start -p 8984"
- echo ""
- echo " SolrCloud example (start Solr running in SolrCloud mode using localhost:2181 to connect to Zookeeper, with 1g max heap size and remote Java debug options enabled):"
- echo ""
- echo " ./solr start -c -m 1g -z localhost:2181 -a \"-Xdebug -Xrunjdwp:transport=dt_socket,server=y,suspend=n,address=1044\""
- echo ""
- echo "Pass -help after any COMMAND to see command-specific usage information,"
- echo " such as: ./solr start -help or ./solr stop -help"
- echo ""
- elif [[ "$CMD" == "start" || "$CMD" == "restart" ]]; then
- echo ""
- echo "Usage: solr $CMD [-f] [-c] [-h hostname] [-p port] [-d directory] [-z zkHost] [-m memory] [-e example] [-s solr.solr.home] [-t solr.data.home] [-a \"additional-options\"] [-V]"
- echo ""
- echo " -f Start Solr in foreground; default starts Solr in the background"
- echo " and sends stdout / stderr to solr-PORT-console.log"
- echo ""
- echo " -c or -cloud Start Solr in SolrCloud mode; if -z not supplied, an embedded Zookeeper"
- echo " instance is started on Solr port+1000, such as 9983 if Solr is bound to 8983"
- echo ""
- echo " -h <host> Specify the hostname for this Solr instance"
- echo ""
- echo " -p <port> Specify the port to start the Solr HTTP listener on; default is 8983"
- echo " The specified port (SOLR_PORT) will also be used to determine the stop port"
- echo " STOP_PORT=(\$SOLR_PORT-1000) and JMX RMI listen port RMI_PORT=(\$SOLR_PORT+10000). "
- echo " For instance, if you set -p 8985, then the STOP_PORT=7985 and RMI_PORT=18985"
- echo ""
- echo " -d <dir> Specify the Solr server directory; defaults to server"
- echo ""
- echo " -z <zkHost> Zookeeper connection string; only used when running in SolrCloud mode using -c"
- echo " To launch an embedded Zookeeper instance, don't pass this parameter."
- echo ""
- echo " -m <memory> Sets the min (-Xms) and max (-Xmx) heap size for the JVM, such as: -m 4g"
- echo " results in: -Xms4g -Xmx4g; by default, this script sets the heap size to 512m"
- echo ""
- echo " -s <dir> Sets the solr.solr.home system property; Solr will create core directories under"
- echo " this directory. This allows you to run multiple Solr instances on the same host"
- echo " while reusing the same server directory set using the -d parameter. If set, the"
- echo " specified directory should contain a solr.xml file, unless solr.xml exists in Zookeeper."
- echo " This parameter is ignored when running examples (-e), as the solr.solr.home depends"
- echo " on which example is run. The default value is server/solr. If passed relative dir,"
- echo " validation with current dir will be done, before trying default server/<dir>"
- echo ""
- echo " -t <dir> Sets the solr.data.home system property, where Solr will store index data in <instance_dir>/data subdirectories."
- echo " If not set, Solr uses solr.solr.home for config and data."
- echo ""
- echo " -e <example> Name of the example to run; available examples:"
- echo " cloud: SolrCloud example"
- echo " techproducts: Comprehensive example illustrating many of Solr's core capabilities"
- echo " dih: Data Import Handler"
- echo " schemaless: Schema-less example"
- echo ""
- echo " -a Additional parameters to pass to the JVM when starting Solr, such as to setup"
- echo " Java debug options. For example, to enable a Java debugger to attach to the Solr JVM"
- echo " you could pass: -a \"-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=18983\""
- echo " In most cases, you should wrap the additional parameters in double quotes."
- echo ""
- echo " -j Additional parameters to pass to Jetty when starting Solr."
- echo " For example, to add configuration folder that jetty should read"
- echo " you could pass: -j \"--include-jetty-dir=/etc/jetty/custom/server/\""
- echo " In most cases, you should wrap the additional parameters in double quotes."
- echo ""
- echo " -noprompt Don't prompt for input; accept all defaults when running examples that accept user input"
- echo ""
- echo " -v and -q Verbose (-v) or quiet (-q) logging. Sets default log level to DEBUG or WARN instead of INFO"
- echo ""
- echo " -V/-verbose Verbose messages from this script"
- echo ""
- elif [ "$CMD" == "stop" ]; then
- echo ""
- echo "Usage: solr stop [-k key] [-p port] [-V]"
- echo ""
- echo " -k <key> Stop key; default is solrrocks"
- echo ""
- echo " -p <port> Specify the port the Solr HTTP listener is bound to"
- echo ""
- echo " -all Find and stop all running Solr servers on this host"
- echo ""
- echo " -V/-verbose Verbose messages from this script"
- echo ""
- echo " NOTE: To see if any Solr servers are running, do: solr status"
- echo ""
- elif [ "$CMD" == "healthcheck" ]; then
- echo ""
- echo "Usage: solr healthcheck [-c collection] [-z zkHost] [-V]"
- echo ""
- echo "Can be run from remote (non-Solr) hosts, as long as a proper ZooKeeper connection is provided"
- echo ""
- echo " -c <collection> Collection to run healthcheck against."
- echo ""
- echo " -z <zkHost> Zookeeper connection string; default is localhost:9983"
- echo ""
- echo " -V Enable more verbose output"
- echo ""
- elif [ "$CMD" == "status" ]; then
- echo ""
- echo "Usage: solr status"
- echo ""
- echo " This command will show the status of all running Solr servers."
- echo " It can only detect those Solr servers running on the current host."
- echo ""
- elif [ "$CMD" == "create" ]; then
- echo ""
- echo "Usage: solr create [-c name] [-d confdir] [-n configName] [-shards #] [-replicationFactor #] [-p port] [-V]"
- echo ""
- echo " Create a core or collection depending on whether Solr is running in standalone (core) or SolrCloud"
- echo " mode (collection). In other words, this action detects which mode Solr is running in, and then takes"
- echo " the appropriate action (either create_core or create_collection). For detailed usage instructions, do:"
- echo ""
- echo " bin/solr create_core -help"
- echo ""
- echo " or"
- echo ""
- echo " bin/solr create_collection -help"
- echo ""
- elif [ "$CMD" == "delete" ]; then
- echo ""
- echo "Usage: solr delete [-c name] [-deleteConfig true|false] [-p port] [-V]"
- echo ""
- echo " Deletes a core or collection depending on whether Solr is running in standalone (core) or SolrCloud"
- echo " mode (collection). If you're deleting a collection in SolrCloud mode, the default behavior is to also"
- echo " delete the configuration directory from Zookeeper so long as it is not being used by another collection."
- echo " You can override this behavior by passing -deleteConfig false when running this command."
- echo ""
- echo " Can be run on remote (non-Solr) hosts, as long as a valid SOLR_HOST is provided in solr.in.sh"
- echo ""
- echo " -c <name> Name of the core / collection to delete"
- echo ""
- echo " -deleteConfig <boolean> Delete the configuration directory from Zookeeper; default is true"
- echo ""
- echo " -p <port> Port of a local Solr instance where you want to delete the core/collection"
- echo " If not specified, the script will search the local system for a running"
- echo " Solr instance and will use the port of the first server it finds."
- echo ""
- echo " -V Enables more verbose output."
- echo ""
- elif [ "$CMD" == "create_core" ]; then
- echo ""
- echo "Usage: solr create_core [-c core] [-d confdir] [-p port] [-V]"
- echo ""
- echo "When a configSet is used, this can be run from remote (non-Solr) hosts. If pointing at a non-configSet directory, this"
- echo "must be run from the host that you wish to create the core on"
- echo ""
- echo " -c <core> Name of core to create"
- echo ""
- echo " -d <confdir> Configuration directory to copy when creating the new core, built-in options are:"
- echo ""
- echo " _default: Minimal configuration, which supports enabling/disabling field-guessing support"
- echo " sample_techproducts_configs: Example configuration with many optional features enabled to"
- echo " demonstrate the full power of Solr"
- echo ""
- echo " If not specified, default is: _default"
- echo ""
- echo " Alternatively, you can pass the path to your own configuration directory instead of using"
- echo " one of the built-in configurations, such as: bin/solr create_core -c mycore -d /tmp/myconfig"
- echo ""
- echo " -p <port> Port of a local Solr instance where you want to create the new core"
- echo " If not specified, the script will search the local system for a running"
- echo " Solr instance and will use the port of the first server it finds."
- echo ""
- echo " -V Enable more verbose output."
- echo ""
- elif [ "$CMD" == "create_collection" ]; then
- echo ""
- echo "Usage: solr create_collection [-c collection] [-d confdir] [-n configName] [-shards #] [-replicationFactor #] [-p port] [-V]"
- echo ""
- echo "Can be run from remote (non-Solr) hosts, as long as a valid SOLR_HOST is provided in solr.in.sh"
- echo " -c <collection> Name of collection to create"
- echo ""
- echo " -d <confdir> Configuration directory to copy when creating the new collection, built-in options are:"
- echo ""
- echo " _default: Minimal configuration, which supports enabling/disabling field-guessing support"
- echo " sample_techproducts_configs: Example configuration with many optional features enabled to"
- echo " demonstrate the full power of Solr"
- echo ""
- echo " If not specified, default is: _default"
- echo ""
- echo " Alternatively, you can pass the path to your own configuration directory instead of using"
- echo " one of the built-in configurations, such as: bin/solr create_collection -c mycoll -d /tmp/myconfig"
- echo ""
- echo " By default the script will upload the specified confdir directory into Zookeeper using the same"
- echo " name as the collection (-c) option. Alternatively, if you want to reuse an existing directory"
- echo " or create a confdir in Zookeeper that can be shared by multiple collections, use the -n option"
- echo ""
- echo " -n <configName> Name the configuration directory in Zookeeper; by default, the configuration"
- echo " will be uploaded to Zookeeper using the collection name (-c), but if you want"
- echo " to use an existing directory or override the name of the configuration in"
- echo " Zookeeper, then use the -c option."
- echo ""
- echo " -shards <#> Number of shards to split the collection into; default is 1"
- echo ""
- echo " -replicationFactor <#> Number of copies of each document in the collection, default is 1 (no replication)"
- echo ""
- echo " -p <port> Port of a local Solr instance where you want to create the new collection"
- echo " If not specified, the script will search the local system for a running"
- echo " Solr instance and will use the port of the first server it finds."
- echo ""
- echo " -V Enable more verbose output."
- echo ""
- elif [ "$CMD" == "zk" ]; then
- print_short_zk_usage ""
- echo " Can be run on remote (non-Solr) hosts, as long as valid ZK_HOST information is provided"
- echo " Be sure to check the Solr logs in case of errors."
- echo ""
- echo " -z zkHost Optional Zookeeper connection string for all commands. If specified it"
- echo " overrides the 'ZK_HOST=...'' defined in solr.in.sh."
- echo ""
- echo " -V Enable more verbose output."
- echo ""
- echo " upconfig uploads a configset from the local machine to Zookeeper. (Backcompat: -upconfig)"
- echo ""
- echo " downconfig downloads a configset from Zookeeper to the local machine. (Backcompat: -downconfig)"
- echo ""
- echo " -n configName Name of the configset in Zookeeper that will be the destination of"
- echo " 'upconfig' and the source for 'downconfig'."
- echo ""
- echo " -d confdir The local directory the configuration will be uploaded from for"
- echo " 'upconfig' or downloaded to for 'downconfig'. If 'confdir' is a child of"
- echo " ...solr/server/solr/configsets' then the configs will be copied from/to"
- echo " that directory. Otherwise it is interpreted as a simple local path."
- echo ""
- echo " cp copies files or folders to/from Zookeeper or Zokeeper -> Zookeeper"
- echo " -r Recursively copy <src> to <dst>. Command will fail if <src> has children and "
- echo " -r is not specified. Optional"
- echo ""
- echo " <src>, <dest> : [file:][/]path/to/local/file or zk:/path/to/zk/node"
- echo " NOTE: <src> and <dest> may both be Zookeeper resources prefixed by 'zk:'"
- echo " When <src> is a zk resource, <dest> may be '.'"
- echo " If <dest> ends with '/', then <dest> will be a local folder or parent znode and the last"
- echo " element of the <src> path will be appended unless <src> also ends in a slash. "
- echo " <dest> may be zk:, which may be useful when using the cp -r form to backup/restore "
- echo " the entire zk state."
- echo " You must enclose local paths that end in a wildcard in quotes or just"
- echo " end the local path in a slash. That is,"
- echo " 'bin/solr zk cp -r /some/dir/ zk:/ -z localhost:2181' is equivalent to"
- echo " 'bin/solr zk cp -r \"/some/dir/*\" zk:/ -z localhost:2181'"
- echo " but 'bin/solr zk cp -r /some/dir/* zk:/ -z localhost:2181' will throw an error"
- echo ""
- echo " here's an example of backup/restore for a ZK configuration:"
- echo " to copy to local: 'bin/solr zk cp -r zk:/ /some/dir -z localhost:2181'"
- echo " to restore to ZK: 'bin/solr zk cp -r /some/dir/ zk:/ -z localhost:2181'"
- echo ""
- echo " The 'file:' prefix is stripped, thus 'file:/wherever' specifies an absolute local path and"
- echo " 'file:somewhere' specifies a relative local path. All paths on Zookeeper are absolute."
- echo ""
- echo " Zookeeper nodes CAN have data, so moving a single file to a parent znode"
- echo " will overlay the data on the parent Znode so specifying the trailing slash"
- echo " can be important."
- echo ""
- echo " Wildcards are supported when copying from local, trailing only and must be quoted."
- echo ""
- echo " rm deletes files or folders on Zookeeper"
- echo " -r Recursively delete if <path> is a directory. Command will fail if <path>"
- echo " has children and -r is not specified. Optional"
- echo " <path> : [zk:]/path/to/zk/node. <path> may not be the root ('/')"
- echo ""
- echo " mv moves (renames) znodes on Zookeeper"
- echo " <src>, <dest> : Zookeeper nodes, the 'zk:' prefix is optional."
- echo " If <dest> ends with '/', then <dest> will be a parent znode"
- echo " and the last element of the <src> path will be appended."
- echo " Zookeeper nodes CAN have data, so moving a single file to a parent znode"
- echo " will overlay the data on the parent Znode so specifying the trailing slash"
- echo " is important."
- echo ""
- echo " ls lists the znodes on Zookeeper"
- echo " -r recursively descends the path listing all znodes. Optional"
- echo " <path>: The Zookeeper path to use as the root."
- echo ""
- echo " Only the node names are listed, not data"
- echo ""
- echo " mkroot makes a znode in Zookeeper with no data. Can be used to make a path of arbitrary"
- echo " depth but primarily intended to create a 'chroot'."
- echo ""
- echo " <path>: The Zookeeper path to create. Leading slash is assumed if not present."
- echo " Intermediate nodes are created as needed if not present."
- echo ""
- elif [ "$CMD" == "auth" ]; then
- echo ""
- echo "Usage: solr auth enable [-type basicAuth] -credentials user:pass [-blockUnknown <true|false>] [-updateIncludeFileOnly <true|false>] [-V]"
- echo " solr auth enable [-type basicAuth] -prompt <true|false> [-blockUnknown <true|false>] [-updateIncludeFileOnly <true|false>] [-V]"
- echo " solr auth enable -type kerberos -config \"<kerberos configs>\" [-updateIncludeFileOnly <true|false>] [-V]"
- echo " solr auth disable [-updateIncludeFileOnly <true|false>] [-V]"
- echo ""
- echo " Updates or enables/disables authentication. Must be run on the machine hosting Solr."
- echo ""
- echo " -type <type> The authentication mechanism (basicAuth or kerberos) to enable. Defaults to 'basicAuth'."
- echo ""
- echo " -credentials <user:pass> The username and password of the initial user. Applicable for basicAuth only."
- echo " Note: only one of -prompt or -credentials must be provided"
- echo ""
- echo " -config \"<configs>\" Configuration parameters (Solr startup parameters). Required and applicable only for Kerberos"
- echo ""
- echo " -prompt <true|false> Prompts the user to provide the credentials. Applicable for basicAuth only."
- echo " Note: only one of -prompt or -credentials must be provided"
- echo ""
- echo " -blockUnknown <true|false> When true, this blocks out access to unauthenticated users. When not provided,"
- echo " this defaults to false (i.e. unauthenticated users can access all endpoints, except the"
- echo " operations like collection-edit, security-edit, core-admin-edit etc.). Check the reference"
- echo " guide for Basic Authentication for more details. Applicable for basicAuth only."
- echo ""
- echo " -updateIncludeFileOnly <true|false> Only update the solr.in.sh or solr.in.cmd file, and skip actual enabling/disabling"
- echo " authentication (i.e. don't update security.json)"
- echo ""
- echo " -z zkHost Zookeeper connection string"
- echo ""
- echo " -d <dir> Specify the Solr server directory"
- echo ""
- echo " -s <dir> Specify the Solr home directory. This is where any credentials or authentication"
- echo " configuration files (e.g. basicAuth.conf) would be placed."
- echo ""
- echo " -V Enable more verbose output."
- echo ""
- fi
-} # end print_usage
-
-function print_short_zk_usage() {
-
- if [ "$1" != "" ]; then
- echo -e "\nERROR: $1\n"
- fi
-
- echo " Usage: solr zk upconfig|downconfig -d <confdir> -n <configName> [-z zkHost]"
- echo " solr zk cp [-r] <src> <dest> [-z zkHost]"
- echo " solr zk rm [-r] <path> [-z zkHost]"
- echo " solr zk mv <src> <dest> [-z zkHost]"
- echo " solr zk ls [-r] <path> [-z zkHost]"
- echo " solr zk mkroot <path> [-z zkHost]"
- echo ""
-
- if [ "$1" == "" ]; then
- echo "Type bin/solr zk -help for full usage help"
- else
- exit 1
- fi
-}
-
-# used to show the script is still alive when waiting on work to complete
-function spinner() {
- local pid=$1
- local delay=0.5
- local spinstr='|/-\'
- while [ "$(ps aux | awk '{print $2}' | grep -w $pid)" ]; do
- local temp=${spinstr#?}
- printf " [%c] " "$spinstr"
- local spinstr=$temp${spinstr%"$temp"}
- sleep $delay
- printf "\b\b\b\b\b\b"
- done
- printf " \b\b\b\b"
-}
-
-# given a port, find the pid for a Solr process
-function solr_pid_by_port() {
- THE_PORT="$1"
- if [ -e "$SOLR_PID_DIR/solr-$THE_PORT.pid" ]; then
- PID=`cat "$SOLR_PID_DIR/solr-$THE_PORT.pid"`
- CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $PID | sort -r | tr -d ' '`
- if [ "$CHECK_PID" != "" ]; then
- local solrPID=$PID
- fi
- fi
- echo "$solrPID"
-}
-
-# extract the value of the -Djetty.port parameter from a running Solr process
-function jetty_port() {
- SOLR_PID="$1"
- SOLR_PROC=`ps auxww | grep -w $SOLR_PID | grep start\.jar | grep jetty\.port`
- IFS=' ' read -a proc_args <<< "$SOLR_PROC"
- for arg in "${proc_args[@]}"
- do
- IFS='=' read -a pair <<< "$arg"
- if [ "${pair[0]}" == "-Djetty.port" ]; then
- local jetty_port="${pair[1]}"
- break
- fi
- done
- echo "$jetty_port"
-} # end jetty_port func
-
-# run a Solr command-line tool using the SolrCLI class;
-# useful for doing cross-platform work from the command-line using Java
-function run_tool() {
-
- "$JAVA" $SOLR_SSL_OPTS $AUTHC_OPTS $SOLR_ZK_CREDS_AND_ACLS -Dsolr.install.dir="$SOLR_TIP" \
- -Dlog4j.configurationFile="file:$DEFAULT_SERVER_DIR/scripts/cloud-scripts/log4j2.xml" \
- -classpath "$DEFAULT_SERVER_DIR/solr-webapp/webapp/WEB-INF/lib/*:$DEFAULT_SERVER_DIR/lib/ext/*" \
- org.apache.solr.util.SolrCLI "$@"
-
- return $?
-} # end run_tool function
-
-# get information about any Solr nodes running on this host
-function get_info() {
- CODE=4
- # first, see if Solr is running
- numSolrs=`find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | wc -l | tr -d ' '`
- if [ "$numSolrs" != "0" ]; then
- echo -e "\nFound $numSolrs Solr nodes: "
- while read PIDF
- do
- ID=`cat "$PIDF"`
- port=`jetty_port "$ID"`
- if [ "$port" != "" ]; then
- echo -e "\nSolr process $ID running on port $port"
- run_tool status -solr "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$port/solr"
- CODE=$?
- echo ""
- else
- echo -e "\nSolr process $ID from $PIDF not found."
- CODE=1
- fi
- done < <(find "$SOLR_PID_DIR" -name "solr-*.pid" -type f)
- else
- # no pid files but check using ps just to be sure
- numSolrs=`ps auxww | grep start\.jar | grep solr\.solr\.home | grep -v grep | wc -l | sed -e 's/^[ \t]*//'`
- if [ "$numSolrs" != "0" ]; then
- echo -e "\nFound $numSolrs Solr nodes: "
- PROCESSES=$(ps auxww | grep start\.jar | grep solr\.solr\.home | grep -v grep | awk '{print $2}' | sort -r)
- for ID in $PROCESSES
- do
- port=`jetty_port "$ID"`
- if [ "$port" != "" ]; then
- echo ""
- echo "Solr process $ID running on port $port"
- run_tool status -solr "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$port/solr"
- CODE=$?
- echo ""
- fi
- done
- else
- echo -e "\nNo Solr nodes are running.\n"
- CODE=3
- fi
- fi
-
- return $CODE
-} # end get_info
-
-# tries to gracefully stop Solr using the Jetty
-# stop command and if that fails, then uses kill -9
-function stop_solr() {
-
- DIR="$1"
- SOLR_PORT="$2"
- THIS_STOP_PORT="${STOP_PORT:-$(expr $SOLR_PORT - 1000)}"
- STOP_KEY="$3"
- SOLR_PID="$4"
-
- if [ "$SOLR_PID" != "" ]; then
- echo -e "Sending stop command to Solr running on port $SOLR_PORT ... waiting up to $SOLR_STOP_WAIT seconds to allow Jetty process $SOLR_PID to stop gracefully."
- "$JAVA" $SOLR_SSL_OPTS $AUTHC_OPTS -jar "$DIR/start.jar" "STOP.PORT=$THIS_STOP_PORT" "STOP.KEY=$STOP_KEY" --stop || true
- (loops=0
- while true
- do
- CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $SOLR_PID | sort -r | tr -d ' '`
- if [ "$CHECK_PID" != "" ]; then
- slept=$((loops * 2))
- if [ $slept -lt $SOLR_STOP_WAIT ]; then
- sleep 2
- loops=$[$loops+1]
- else
- exit # subshell!
- fi
- else
- exit # subshell!
- fi
- done) &
- spinner $!
- rm -f "$SOLR_PID_DIR/solr-$SOLR_PORT.pid"
- else
- echo -e "No Solr nodes found to stop."
- exit 0
- fi
-
- CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $SOLR_PID | sort -r | tr -d ' '`
- if [ "$CHECK_PID" != "" ]; then
- echo -e "Solr process $SOLR_PID is still running; forcefully killing it now."
- kill -9 $SOLR_PID
- echo "Killed process $SOLR_PID"
- rm -f "$SOLR_PID_DIR/solr-$SOLR_PORT.pid"
- sleep 1
- fi
-
- CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $SOLR_PID | sort -r | tr -d ' '`
- if [ "$CHECK_PID" != "" ]; then
- echo "ERROR: Failed to kill previous Solr Java process $SOLR_PID ... script fails."
- exit 1
- fi
-} # end stop_solr
-
-if [ $# -eq 1 ]; then
- case $1 in
- -help|-usage|-h|--help)
- print_usage ""
- exit
- ;;
- -info|-i|status)
- get_info
- exit $?
- ;;
- -version|-v|version)
- run_tool version
- exit
- ;;
- esac
-fi
-
-if [ $# -gt 0 ]; then
- # if first arg starts with a dash (and it's not -help or -info),
- # then assume they are starting Solr, such as: solr -f
- if [[ $1 == -* ]]; then
- SCRIPT_CMD="start"
- else
- SCRIPT_CMD="$1"
- shift
- fi
-else
- # no args - just show usage and exit
- print_usage ""
- exit
-fi
-
-if [ "$SCRIPT_CMD" == "status" ]; then
- # hacky - the script hits this if the user passes additional args with the status command,
- # which is not supported but also not worth complaining about either
- get_info
- exit
-fi
-
-# assert tool
-if [ "$SCRIPT_CMD" == "assert" ]; then
- run_tool assert $*
- exit $?
-fi
-
-# run a healthcheck and exit if requested
-if [ "$SCRIPT_CMD" == "healthcheck" ]; then
-
- VERBOSE=""
-
- if [ $# -gt 0 ]; then
- while true; do
- case "$1" in
- -c|-collection)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Collection name is required when using the $1 option!"
- exit 1
- fi
- HEALTHCHECK_COLLECTION="$2"
- shift 2
- ;;
- -z|-zkhost)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "ZooKeeper connection string is required when using the $1 option!"
- exit 1
- fi
- ZK_HOST="$2"
- shift 2
- ;;
- -help|-usage)
- print_usage "$SCRIPT_CMD"
- exit 0
- ;;
- -V|--verbose)
- VERBOSE="-verbose"
- shift
- ;;
- --)
- shift
- break
- ;;
- *)
- if [ "$1" != "" ]; then
- print_usage "$SCRIPT_CMD" "Unrecognized or misplaced argument: $1!"
- exit 1
- else
- break # out-of-args, stop looping
- fi
- ;;
- esac
- done
- fi
-
- if [ -z "$ZK_HOST" ]; then
- ZK_HOST=localhost:9983
- fi
-
- if [ -z "$HEALTHCHECK_COLLECTION" ]; then
- echo "collection parameter is required!"
- print_usage "healthcheck"
- exit 1
- fi
-
- run_tool healthcheck -zkHost "$ZK_HOST" -collection "$HEALTHCHECK_COLLECTION" $VERBOSE
-
- exit $?
-fi
-
-if [[ "$SCRIPT_CMD" == "config" ]]; then
- run_tool config $*
- exit $?
-fi
-
-# create a core or collection
-if [[ "$SCRIPT_CMD" == "create" || "$SCRIPT_CMD" == "create_core" || "$SCRIPT_CMD" == "create_collection" ]]; then
-
- CREATE_NUM_SHARDS=1
- CREATE_REPFACT=1
- FORCE=false
- VERBOSE=""
-
- if [ $# -gt 0 ]; then
- while true; do
- case "$1" in
- -c|-core|-collection)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "name is required when using the $1 option!"
- exit 1
- fi
- CREATE_NAME="$2"
- shift 2
- ;;
- -n|-confname)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Configuration name is required when using the $1 option!"
- exit 1
- fi
- CREATE_CONFNAME="$2"
- shift 2
- ;;
- -d|-confdir)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Configuration directory is required when using the $1 option!"
- exit 1
- fi
- CREATE_CONFDIR="$2"
- shift 2
- ;;
- -s|-shards)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Shard count is required when using the $1 option!"
- exit 1
- fi
- CREATE_NUM_SHARDS="$2"
- shift 2
- ;;
- -rf|-replicationFactor)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Replication factor is required when using the $1 option!"
- exit 1
- fi
- CREATE_REPFACT="$2"
- shift 2
- ;;
- -p|-port)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Solr port is required when using the $1 option!"
- exit 1
- fi
- CREATE_PORT="$2"
- shift 2
- ;;
- -V|--verbose)
- VERBOSE="-verbose"
- shift
- ;;
- -force)
- FORCE=true
- shift
- ;;
- -help|-usage)
- print_usage "$SCRIPT_CMD"
- exit 0
- ;;
- --)
- shift
- break
- ;;
- *)
- if [ "$1" != "" ]; then
- print_usage "$SCRIPT_CMD" "Unrecognized or misplaced argument: $1!"
- exit 1
- else
- break # out-of-args, stop looping
- fi
- ;;
- esac
- done
- fi
-
- if [ -z "$CREATE_CONFDIR" ]; then
- CREATE_CONFDIR='_default'
- fi
-
- # validate the confdir arg (if provided)
- if [[ ! -d "$SOLR_TIP/server/solr/configsets/$CREATE_CONFDIR" && ! -d "$CREATE_CONFDIR" ]]; then
- echo -e "\nSpecified configuration directory $CREATE_CONFDIR not found!\n"
- exit 1
- fi
-
- if [ -z "$CREATE_NAME" ]; then
- echo "Name (-c) argument is required!"
- print_usage "$SCRIPT_CMD"
- exit 1
- fi
-
- if [ -z "$CREATE_PORT" ]; then
- for ID in `ps auxww | grep java | grep start\.jar | awk '{print $2}' | sort -r`
- do
- port=`jetty_port "$ID"`
- if [ "$port" != "" ]; then
- CREATE_PORT=$port
- break
- fi
- done
- fi
-
- if [ -z "$CREATE_PORT" ]; then
- echo "Failed to determine the port of a local Solr instance, cannot create $CREATE_NAME!"
- exit 1
- fi
-
- if [[ "$CREATE_CONFDIR" == "_default" ]] && ([[ "$CREATE_CONFNAME" == "" ]] || [[ "$CREATE_CONFNAME" == "_default" ]]); then
- echo "WARNING: Using _default configset with data driven schema functionality. NOT RECOMMENDED for production use."
- echo " To turn off: bin/solr config -c $CREATE_NAME -p $CREATE_PORT -property update.autoCreateFields -value false"
- fi
-
- if [[ "$(whoami)" == "root" ]] && [[ "$FORCE" == "false" ]] ; then
- echo "WARNING: Creating cores as the root user can cause Solr to fail and is not advisable. Exiting."
- echo " If you started Solr as root (not advisable either), force core creation by adding argument -force"
- exit 1
- fi
- if [ "$SCRIPT_CMD" == "create_core" ]; then
- run_tool create_core -name "$CREATE_NAME" -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$CREATE_PORT/solr" \
- -confdir "$CREATE_CONFDIR" -configsetsDir "$SOLR_TIP/server/solr/configsets" \
- $VERBOSE
- exit $?
- else
- run_tool "$SCRIPT_CMD" -name "$CREATE_NAME" -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$CREATE_PORT/solr" \
- -shards "$CREATE_NUM_SHARDS" -replicationFactor "$CREATE_REPFACT" \
- -confname "$CREATE_CONFNAME" -confdir "$CREATE_CONFDIR" \
- -configsetsDir "$SOLR_TIP/server/solr/configsets" \
- $VERBOSE
- exit $?
- fi
-fi
-
-# delete a core or collection
-if [[ "$SCRIPT_CMD" == "delete" ]]; then
-
- VERBOSE=""
-
- if [ $# -gt 0 ]; then
- while true; do
- case "$1" in
- -c|-core|-collection)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "name is required when using the $1 option!"
- exit 1
- fi
- DELETE_NAME="$2"
- shift 2
- ;;
- -p|-port)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Solr port is required when using the $1 option!"
- exit 1
- fi
- DELETE_PORT="$2"
- shift 2
- ;;
- -deleteConfig)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "true|false is required when using the $1 option!"
- exit 1
- fi
- DELETE_CONFIG="$2"
- shift 2
- ;;
- -V|--verbose)
- VERBOSE="-verbose"
- shift
- ;;
- -help|-usage)
- print_usage "$SCRIPT_CMD"
- exit 0
- ;;
- --)
- shift
- break
- ;;
- *)
- if [ "$1" != "" ]; then
- print_usage "$SCRIPT_CMD" "Unrecognized or misplaced argument: $1!"
- exit 1
- else
- break # out-of-args, stop looping
- fi
- ;;
- esac
- done
- fi
-
- if [ -z "$DELETE_NAME" ]; then
- echo "Name (-c) argument is required!"
- print_usage "$SCRIPT_CMD"
- exit 1
- fi
-
- # If not defined, use the collection name for the name of the configuration in Zookeeper
- if [ -z "$DELETE_CONFIG" ]; then
- DELETE_CONFIG=true
- fi
-
- if [ -z "$DELETE_PORT" ]; then
- for ID in `ps auxww | grep java | grep start\.jar | awk '{print $2}' | sort -r`
- do
- port=`jetty_port "$ID"`
- if [ "$port" != "" ]; then
- DELETE_PORT=$port
- break
- fi
- done
- fi
-
- if [ -z "$DELETE_PORT" ]; then
- echo "Failed to determine the port of a local Solr instance, cannot delete $DELETE_NAME!"
- exit 1
- fi
-
- run_tool delete -name "$DELETE_NAME" -deleteConfig "$DELETE_CONFIG" \
- -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$DELETE_PORT/solr" \
- $VERBOSE
- exit $?
-fi
-
-ZK_RECURSE=false
-# Zookeeper file maintenance (upconfig, downconfig, files up/down etc.)
-# It's a little clumsy to have the parsing go round and round for upconfig and downconfig, but that's
-# necessary for back-compat
-if [[ "$SCRIPT_CMD" == "zk" ]]; then
-
- VERBOSE=""
-
- if [ $# -gt 0 ]; then
- while true; do
- case "$1" in
- -upconfig|upconfig|-downconfig|downconfig|cp|rm|mv|ls|mkroot)
- if [ "${1:0:1}" == "-" ]; then
- ZK_OP=${1:1}
- else
- ZK_OP=$1
- fi
- shift 1
- ;;
- -z|-zkhost)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_short_zk_usage "$SCRIPT_CMD" "ZooKeeper connection string is required when using the $1 option!"
- fi
- ZK_HOST="$2"
- shift 2
- ;;
- -n|-confname)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_short_zk_usage "$SCRIPT_CMD" "Configuration name is required when using the $1 option!"
- fi
- CONFIGSET_CONFNAME="$2"
- shift 2
- ;;
- -d|-confdir)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_short_zk_usage "$SCRIPT_CMD" "Configuration directory is required when using the $1 option!"
- fi
- CONFIGSET_CONFDIR="$2"
- shift 2
- ;;
- -r)
- ZK_RECURSE="true"
- shift
- ;;
- -V|--verbose)
- VERBOSE="-verbose"
- shift
- ;;
- -help|-usage|-h)
- print_usage "$SCRIPT_CMD"
- exit 0
- ;;
- --)
- shift
- break
- ;;
- *) # Pick up <src> <dst> or <path> params for rm, ls, cp, mv, mkroot.
- if [ "$1" == "" ]; then
- break # out-of-args, stop looping
- fi
- if [ -z "$ZK_SRC" ]; then
- ZK_SRC=$1
- else
- if [ -z "$ZK_DST" ]; then
- ZK_DST=$1
- else
- print_short_zk_usage "Unrecognized or misplaced command $1. 'cp' with trailing asterisk requires quoting, see help text."
- fi
- fi
- shift
- ;;
- esac
- done
- fi
-
- if [ -z "$ZK_OP" ]; then
- print_short_zk_usage "Zookeeper operation (one of 'upconfig', 'downconfig', 'rm', 'mv', 'cp', 'ls', 'mkroot') is required!"
- fi
-
- if [ -z "$ZK_HOST" ]; then
- print_short_zk_usage "Zookeeper address (-z) argument is required or ZK_HOST must be specified in the solr.in.sh file."
- fi
-
- if [[ "$ZK_OP" == "upconfig" || "$ZK_OP" == "downconfig" ]]; then
- if [ -z "$CONFIGSET_CONFDIR" ]; then
- print_short_zk_usage "Local directory of the configset (-d) argument is required!"
- fi
-
- if [ -z "$CONFIGSET_CONFNAME" ]; then
- print_short_zk_usage "Configset name on Zookeeper (-n) argument is required!"
- fi
- fi
-
- if [[ "$ZK_OP" == "cp" || "$ZK_OP" == "mv" ]]; then
- if [[ -z "$ZK_SRC" || -z "$ZK_DST" ]]; then
- print_short_zk_usage "<source> and <destination> must be specified when using either the 'mv' or 'cp' commands."
- fi
- if [[ "$ZK_OP" == "cp" && "${ZK_SRC:0:3}" != "zk:" && "${ZK_DST:0:3}" != "zk:" ]]; then
- print_short_zk_usage "One of the source or desintation paths must be prefixed by 'zk:' for the 'cp' command."
- fi
- fi
-
- if [[ "$ZK_OP" == "mkroot" ]]; then
- if [[ -z "$ZK_SRC" ]]; then
- print_short_zk_usage "<path> must be specified when using the 'mkroot' command."
- fi
- fi
-
-
- case "$ZK_OP" in
- upconfig)
- run_tool "$ZK_OP" -confname "$CONFIGSET_CONFNAME" -confdir "$CONFIGSET_CONFDIR" -zkHost "$ZK_HOST" -configsetsDir "$SOLR_TIP/server/solr/configsets" $VERBOSE
- ;;
- downconfig)
- run_tool "$ZK_OP" -confname "$CONFIGSET_CONFNAME" -confdir "$CONFIGSET_CONFDIR" -zkHost "$ZK_HOST" $VERBOSE
- ;;
- rm)
- if [ -z "$ZK_SRC" ]; then
- print_short_zk_usage "Zookeeper path to remove must be specified when using the 'rm' command"
- fi
- run_tool "$ZK_OP" -path "$ZK_SRC" -zkHost "$ZK_HOST" -recurse "$ZK_RECURSE" $VERBOSE
- ;;
- mv)
- run_tool "$ZK_OP" -src "$ZK_SRC" -dst "$ZK_DST" -zkHost "$ZK_HOST" $VERBOSE
- ;;
- cp)
- run_tool "$ZK_OP" -src "$ZK_SRC" -dst "$ZK_DST" -zkHost "$ZK_HOST" -recurse "$ZK_RECURSE" $VERBOSE
- ;;
- ls)
- if [ -z "$ZK_SRC" ]; then
- print_short_zk_usage "Zookeeper path to list must be specified when using the 'ls' command"
- fi
- run_tool "$ZK_OP" -path "$ZK_SRC" -recurse "$ZK_RECURSE" -zkHost "$ZK_HOST" $VERBOSE
- ;;
- mkroot)
- if [ -z "$ZK_SRC" ]; then
- print_short_zk_usage "Zookeeper path to list must be specified when using the 'mkroot' command"
- fi
- run_tool "$ZK_OP" -path "$ZK_SRC" -zkHost "$ZK_HOST" $VERBOSE
- ;;
- *)
- print_short_zk_usage "Unrecognized Zookeeper operation $ZK_OP"
- ;;
- esac
-
- exit $?
-fi
-
-if [[ "$SCRIPT_CMD" == "auth" ]]; then
-
- VERBOSE=""
-
- declare -a AUTH_PARAMS
- if [ $# -gt 0 ]; then
- while true; do
- case "$1" in
- enable|disable)
- AUTH_OP=$1
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "$AUTH_OP")
- shift
- ;;
- -z|-zkhost|zkHost)
- ZK_HOST="$2"
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-zkHost" "$ZK_HOST")
- shift 2
- ;;
- -t|-type)
- AUTH_TYPE="$2"
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-type" "$AUTH_TYPE")
- shift 2
- ;;
- -credentials)
- AUTH_CREDENTIALS="$2"
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-credentials" "$AUTH_CREDENTIALS")
- shift 2
- ;;
- -config)
- AUTH_CONFIG="`echo $2| base64`"
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-config" "$AUTH_CONFIG")
- shift 2
- ;;
- -solrIncludeFile)
- SOLR_INCLUDE="$2"
- shift 2
- ;;
- -prompt)
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-prompt" "$2")
- shift
- ;;
- -blockUnknown)
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-blockUnknown" "$2")
- shift
- break
- ;;
- -updateIncludeFileOnly)
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-updateIncludeFileOnly" "$2")
- shift
- break
- ;;
- -V|--verbose)
- VERBOSE="-verbose"
- shift
- ;;
- -d|-dir)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Server directory is required when using the $1 option!"
- exit 1
- fi
-
- if [[ "$2" == "." || "$2" == "./" || "$2" == ".." || "$2" == "../" ]]; then
- SOLR_SERVER_DIR="$(pwd)/$2"
- else
- # see if the arg value is relative to the tip vs full path
- if [[ "$2" != /* ]] && [[ -d "$SOLR_TIP/$2" ]]; then
- SOLR_SERVER_DIR="$SOLR_TIP/$2"
- else
- SOLR_SERVER_DIR="$2"
- fi
- fi
- # resolve it to an absolute path
- SOLR_SERVER_DIR="$(cd "$SOLR_SERVER_DIR"; pwd)"
- shift 2
- ;;
- -s|-solr.home)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Solr home directory is required when using the $1 option!"
- exit 1
- fi
-
- SOLR_HOME="$2"
- shift 2
- ;;
- -help|-usage|-h)
- print_usage "$SCRIPT_CMD"
- exit 0
- ;;
- --)
- shift
- break
- ;;
- *)
- shift
- break
- ;;
- esac
- done
- fi
-
- if [ -z "$SOLR_SERVER_DIR" ]; then
- SOLR_SERVER_DIR="$DEFAULT_SERVER_DIR"
- fi
- if [ ! -e "$SOLR_SERVER_DIR" ]; then
- echo -e "\nSolr server directory $SOLR_SERVER_DIR not found!\n"
- exit 1
- fi
-
- if [ -z "$SOLR_HOME" ]; then
- SOLR_HOME="$SOLR_SERVER_DIR/solr"
- elif [[ $SOLR_HOME != /* ]]; then
- if [[ -d "`pwd`/$SOLR_HOME" ]]; then
- SOLR_HOME="$(pwd)/$SOLR_HOME"
- elif [[ -d "$SOLR_SERVER_DIR/$SOLR_HOME" ]]; then
- SOLR_HOME="$SOLR_SERVER_DIR/$SOLR_HOME"
- SOLR_PID_DIR="$SOLR_HOME"
- fi
- fi
-
- if [ -z "$AUTH_OP" ]; then
- print_usage "$SCRIPT_CMD"
- exit 0
- fi
-
- AUTH_PARAMS=("${AUTH_PARAMS[@]}" "-solrIncludeFile" "$SOLR_INCLUDE")
-
- if [ -z "$AUTH_PORT" ]; then
- for ID in `ps auxww | grep java | grep start\.jar | awk '{print $2}' | sort -r`
- do
- port=`jetty_port "$ID"`
- if [ "$port" != "" ]; then
- AUTH_PORT=$port
- break
- fi
- done
- fi
- run_tool auth ${AUTH_PARAMS[@]} -solrUrl "$SOLR_URL_SCHEME://$SOLR_TOOL_HOST:$AUTH_PORT/solr" -authConfDir "$SOLR_HOME" $VERBOSE
- exit $?
-fi
-
-
-# verify the command given is supported
-if [ "$SCRIPT_CMD" != "stop" ] && [ "$SCRIPT_CMD" != "start" ] && [ "$SCRIPT_CMD" != "restart" ] && [ "$SCRIPT_CMD" != "status" ] && [ "$SCRIPT_CMD" != "assert" ]; then
- print_usage "" "$SCRIPT_CMD is not a valid command!"
- exit 1
-fi
-
-#Check current Ulimits for Open Files and Max Processes. Warn if they are below the recommended values.
-
-if [ -z "$SOLR_RECOMMENDED_MAX_PROCESSES" ]; then
- SOLR_RECOMMENDED_MAX_PROCESSES=65000
-fi
-
-if [ -z "$SOLR_RECOMMENDED_OPEN_FILES" ]; then
- SOLR_RECOMMENDED_OPEN_FILES=65000
-fi
-
-if [ -z "$SOLR_ULIMIT_CHECKS" ] || [ "$SOLR_ULIMIT_CHECKS" != "false" ]; then
- if [ "$SCRIPT_CMD" == "start" ] || [ "$SCRIPT_CMD" == "restart" ] || [ "$SCRIPT_CMD" == "status" ]; then
- if hash ulimit 2>/dev/null; then
- openFiles=$(ulimit -n)
- maxProcs=$(ulimit -u)
- if [ $openFiles != "unlimited" ] && [ $openFiles -lt "$SOLR_RECOMMENDED_OPEN_FILES" ]; then
- echo "*** [WARN] *** Your open file limit is currently $openFiles. "
- echo " It should be set to $SOLR_RECOMMENDED_OPEN_FILES to avoid operational disruption. "
- echo " If you no longer wish to see this warning, set SOLR_ULIMIT_CHECKS to false in your profile or solr.in.sh"
- fi
-
- if [ $maxProcs != "unlimited" ] && [ $maxProcs -lt "$SOLR_RECOMMENDED_MAX_PROCESSES" ]; then
- echo "*** [WARN] *** Your Max Processes Limit is currently $maxProcs. "
- echo " It should be set to $SOLR_RECOMMENDED_MAX_PROCESSES to avoid operational disruption. "
- echo " If you no longer wish to see this warning, set SOLR_ULIMIT_CHECKS to false in your profile or solr.in.sh"
- fi
- else
- echo "Could not check ulimits for processes and open files, recommended values are"
- echo " max processes: $SOLR_RECOMMENDED_MAX_PROCESSES "
- echo " open files: $SOLR_RECOMMENDED_OPEN_FILES"
- fi
- fi
-fi
-
-# Run in foreground (default is to run in the background)
-FG="false"
-FORCE=false
-noprompt=false
-SOLR_OPTS=($SOLR_OPTS)
-PASS_TO_RUN_EXAMPLE=
-
-if [ $# -gt 0 ]; then
- while true; do
- case "$1" in
- -c|-cloud)
- SOLR_MODE="solrcloud"
- PASS_TO_RUN_EXAMPLE+=" -c"
- shift
- ;;
- -d|-dir)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Server directory is required when using the $1 option!"
- exit 1
- fi
-
- if [[ "$2" == "." || "$2" == "./" || "$2" == ".." || "$2" == "../" ]]; then
- SOLR_SERVER_DIR="$(pwd)/$2"
- else
- # see if the arg value is relative to the tip vs full path
- if [[ "$2" != /* ]] && [[ -d "$SOLR_TIP/$2" ]]; then
- SOLR_SERVER_DIR="$SOLR_TIP/$2"
- else
- SOLR_SERVER_DIR="$2"
- fi
- fi
- # resolve it to an absolute path
- SOLR_SERVER_DIR="$(cd "$SOLR_SERVER_DIR"; pwd)"
- shift 2
- ;;
- -s|-solr.home)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Solr home directory is required when using the $1 option!"
- exit 1
- fi
-
- SOLR_HOME="$2"
- shift 2
- ;;
- -t|-data.home)
- SOLR_DATA_HOME="$2"
- shift 2
- ;;
- -e|-example)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Example name is required when using the $1 option!"
- exit 1
- fi
- EXAMPLE="$2"
- shift 2
- ;;
- -f|-foreground)
- FG="true"
- shift
- ;;
- -h|-host)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Hostname is required when using the $1 option!"
- exit 1
- fi
- SOLR_HOST="$2"
- PASS_TO_RUN_EXAMPLE+=" -h $SOLR_HOST"
- shift 2
- ;;
- -m|-memory)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Memory setting is required when using the $1 option!"
- exit 1
- fi
- SOLR_HEAP="$2"
- PASS_TO_RUN_EXAMPLE+=" -m $SOLR_HEAP"
- shift 2
- ;;
- -p|-port)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Port number is required when using the $1 option!"
- exit 1
- fi
- SOLR_PORT="$2"
- PASS_TO_RUN_EXAMPLE+=" -p $SOLR_PORT"
- shift 2
- ;;
- -z|-zkhost)
- if [[ -z "$2" || "${2:0:1}" == "-" ]]; then
- print_usage "$SCRIPT_CMD" "Zookeeper connection string is required when using the $1 option!"
- exit 1
- fi
- ZK_HOST="$2"
- SOLR_MODE="solrcloud"
- PASS_TO_RUN_EXAMPLE+=" -z $ZK_HOST"
- shift 2
- ;;
- -a|-addlopts)
- ADDITIONAL_CMD_OPTS="$2"
- PASS_TO_RUN_EXAMPLE+=" -a \"$ADDITIONAL_CMD_OPTS\""
- shift 2
- ;;
- -j|-jettyconfig)
- ADDITIONAL_JETTY_CONFIG="$2"
- PASS_TO_RUN_EXAMPLE+=" -j \"$ADDITIONAL_JETTY_CONFIG\""
- shift 2
- ;;
- -k|-key)
- STOP_KEY="$2"
- shift 2
- ;;
- -help|-usage)
- print_usage "$SCRIPT_CMD"
- exit 0
- ;;
- -noprompt)
- noprompt=true
- PASS_TO_RUN_EXAMPLE+=" -noprompt"
- shift
- ;;
- -V|-verbose)
- verbose=true
- PASS_TO_RUN_EXAMPLE+=" --verbose"
- shift
- ;;
- -v)
- SOLR_LOG_LEVEL=DEBUG
- shift
- ;;
- -q)
- SOLR_LOG_LEVEL=WARN
- shift
- ;;
- -all)
- stop_all=true
- shift
- ;;
- -force)
- FORCE=true
- PASS_TO_RUN_EXAMPLE+=" -force"
- shift
- ;;
- --)
- shift
- break
- ;;
- *)
- if [ "${1:0:2}" == "-D" ]; then
- # pass thru any opts that begin with -D (java system props)
- SOLR_OPTS+=("$1")
- PASS_TO_RUN_EXAMPLE+=" $1"
- shift
- else
- if [ "$1" != "" ]; then
- print_usage "$SCRIPT_CMD" "$1 is not supported by this script"
- exit 1
- else
- break # out-of-args, stop looping
- fi
- fi
- ;;
- esac
- done
-fi
-
-if [[ $SOLR_LOG_LEVEL ]] ; then
- SOLR_LOG_LEVEL_OPT="-Dsolr.log.level=$SOLR_LOG_LEVEL"
-fi
-
-if [ -z "$SOLR_SERVER_DIR" ]; then
- SOLR_SERVER_DIR="$DEFAULT_SERVER_DIR"
-fi
-
-if [ ! -e "$SOLR_SERVER_DIR" ]; then
- echo -e "\nSolr server directory $SOLR_SERVER_DIR not found!\n"
- exit 1
-fi
-
-if [[ "$FG" == 'true' && "$EXAMPLE" != "" ]]; then
- FG='false'
- echo -e "\nWARNING: Foreground mode (-f) not supported when running examples.\n"
-fi
-
+##### End Setup
#
-# If the user specified an example to run, invoke the run_example tool (Java app) and exit
-# otherwise let this script proceed to process the user request
-#
-if [ -n "$EXAMPLE" ] && [ "$SCRIPT_CMD" == "start" ]; then
- run_tool run_example -e $EXAMPLE -d "$SOLR_SERVER_DIR" -urlScheme $SOLR_URL_SCHEME $PASS_TO_RUN_EXAMPLE
- exit $?
+#----
+# DO NOT EDIT BELOW THIS LINE WITHOUT GUIDANCE
+#----
+
+# If the variable for the which command isn't set, set
+# it to the default.
+if [ -z "${X_WHICH}" ]; then
+ X_WHICH="${DEFAULT_X_WHICH}"
fi
-############# start/stop logic below here ################
-
-if $verbose ; then
- echo "Using Solr root directory: $SOLR_TIP"
- echo "Using Java: $JAVA"
- "$JAVA" -version
-fi
-
-if [ "$SOLR_HOST" != "" ]; then
- SOLR_HOST_ARG=("-Dhost=$SOLR_HOST")
-else
- SOLR_HOST_ARG=()
-fi
-
-if [ -z "$STOP_KEY" ]; then
- STOP_KEY='solrrocks'
-fi
-
-# stop all if no port specified
-if [[ "$SCRIPT_CMD" == "stop" && -z "$SOLR_PORT" ]]; then
- if $stop_all; then
- none_stopped=true
- find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | while read PIDF
- do
- NEXT_PID=`cat "$PIDF"`
- port=`jetty_port "$NEXT_PID"`
- if [ "$port" != "" ]; then
- stop_solr "$SOLR_SERVER_DIR" "$port" "$STOP_KEY" "$NEXT_PID"
- none_stopped=false
- fi
- rm -f "$PIDF"
- done
- # TODO: none_stopped doesn't get reflected across the subshell
- # This can be uncommented once we find a clean way out of it
- # 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
- none_stopped=true
- numSolrs=`find "$SOLR_PID_DIR" -name "solr-*.pid" -type f | wc -l | tr -d ' '`
- if [ $numSolrs -eq 1 ]; then
- # only do this if there is only 1 node running, otherwise they must provide the -p or -all
- PID="$(cat "$(find "$SOLR_PID_DIR" -name "solr-*.pid" -type f)")"
- CHECK_PID=`ps auxww | awk '{print $2}' | grep -w $PID | sort -r | tr -d ' '`
- if [ "$CHECK_PID" != "" ]; then
- port=`jetty_port "$CHECK_PID"`
- if [ "$port" != "" ]; then
- stop_solr "$SOLR_SERVER_DIR" "$port" "$STOP_KEY" "$CHECK_PID"
- none_stopped=false
- fi
- fi
- fi
-
- if $none_stopped; then
- if [ $numSolrs -gt 0 ]; then
- echo -e "\nFound $numSolrs Solr nodes running! Must either specify a port using -p or -all to stop all Solr nodes on this host.\n"
- else
- echo -e "\nNo Solr nodes found to stop.\n"
- fi
- exit 1
- fi
- fi
- exit
-fi
-
-if [ -z "$SOLR_PORT" ]; then
- SOLR_PORT=8983
-fi
-
-if [ -z "$STOP_PORT" ]; then
- STOP_PORT=`expr $SOLR_PORT - 1000`
-fi
-
-if [ "$SCRIPT_CMD" == "start" ] || [ "$SCRIPT_CMD" == "restart" ] ; then
- if [[ "$(whoami)" == "root" ]] && [[ "$FORCE" == "false" ]] ; then
- echo "WARNING: Starting Solr as the root user is a security risk and not considered best practice. Exiting."
- echo " Please consult the Reference Guide. To override this check, start with argument '-force'"
+# Abort if certain required commands are are not found.
+if [ ! -x "${X_WHICH}" ]; then
+ # last-ditch effort for locating which, will succeed if it's
+ # on the path.
+ X_WHICH="`which which`"
+ RET=$?
+ # TODO: Consider only relying on the exit code.
+ if [ ${RET} -ne 0 ] || [ ! -x "${X_WHICH}" ]; then
+ echo >&2 "The "which" command is not found or not executable."
+ echo >&2 "This command is required. Aborting."
+ echo >&2 "The X_WHICH env variable can explicitly set its location."
exit 1
fi
fi
-if [[ "$SCRIPT_CMD" == "start" ]]; then
- # see if Solr is already running
- SOLR_PID=`solr_pid_by_port "$SOLR_PORT"`
-
- if [ -z "$SOLR_PID" ]; then
- # not found using the pid file ... but use ps to ensure not found
- SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
- fi
-
- if [ "$SOLR_PID" != "" ]; then
- echo -e "\nPort $SOLR_PORT is already being used by another process (pid: $SOLR_PID)\nPlease choose a different port using the -p option.\n"
- exit 1
- fi
-else
- # either stop or restart
- # see if Solr is already running
- SOLR_PID=`solr_pid_by_port "$SOLR_PORT"`
- if [ -z "$SOLR_PID" ]; then
- # not found using the pid file ... but use ps to ensure not found
- SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
- fi
- if [ "$SOLR_PID" != "" ]; then
- stop_solr "$SOLR_SERVER_DIR" "$SOLR_PORT" "$STOP_KEY" "$SOLR_PID"
- else
- if [ "$SCRIPT_CMD" == "stop" ]; then
- echo -e "No process found for Solr node running on port $SOLR_PORT"
- exit 1
- fi
- fi
-fi
-
-if [ -z "$SOLR_HOME" ]; then
- SOLR_HOME="$SOLR_SERVER_DIR/solr"
-elif [[ $SOLR_HOME != /* ]]; then
- if [[ -d "`pwd`/$SOLR_HOME" ]]; then
- SOLR_HOME="$(pwd)/$SOLR_HOME"
- elif [[ -d "$SOLR_SERVER_DIR/$SOLR_HOME" ]]; then
- SOLR_HOME="$SOLR_SERVER_DIR/$SOLR_HOME"
- SOLR_PID_DIR="$SOLR_HOME"
- fi
-fi
-
-# Set the default configset dir to be bootstrapped as _default
-if [ -z "$DEFAULT_CONFDIR" ]; then
- DEFAULT_CONFDIR="$SOLR_SERVER_DIR/solr/configsets/_default/conf"
-fi
-
-# This is quite hacky, but examples rely on a different log4j2.xml
-# so that we can write logs for examples to $SOLR_HOME/../logs
-if [ -z "$SOLR_LOGS_DIR" ]; then
- SOLR_LOGS_DIR="$SOLR_SERVER_DIR/logs"
-fi
-EXAMPLE_DIR="$SOLR_TIP/example"
-if [ "${SOLR_HOME:0:${#EXAMPLE_DIR}}" = "$EXAMPLE_DIR" ]; then
- LOG4J_PROPS="$EXAMPLE_DIR/resources/log4j2.xml"
- SOLR_LOGS_DIR="$SOLR_HOME/../logs"
-fi
-
-LOG4J_CONFIG=()
-if [ -n "$LOG4J_PROPS" ]; then
- LOG4J_CONFIG+=("-Dlog4j.configurationFile=file:$LOG4J_PROPS")
-fi
-
-if [ "$SCRIPT_CMD" == "stop" ]; then
- # already stopped, script is done.
- exit 0
-fi
-
-# NOTE: If the script gets to here, then it is starting up a Solr node.
-
-if [ ! -e "$SOLR_HOME" ]; then
- echo -e "\nSolr home directory $SOLR_HOME not found!\n"
+X_DIRNAME=`"${X_WHICH}" dirname`
+# The which command should only return files that are executable,
+# so we are only checking that the value is present.
+if [ -z "${X_DIRNAME}" ]; then
+ echo >&2 "The dirname command is not found or not executable."
+ echo >&2 "This command is required. Aborting."
+ echo >&2 "The X_DIRNAME env variable can explicitly set its location."
exit 1
fi
-if [[ $SOLR_DATA_HOME ]] && [ ! -e "$SOLR_DATA_HOME" ]; then
- echo -e "\nSolr data home directory $SOLR_DATA_HOME not found!\n"
+
+# Figure out where this script is and load function definitions.
+# Abort the script if not found.
+THIS_SCRIPT="$0"
+cd `"${X_DIRNAME}" "${THIS_SCRIPT}"`
+SCRIPT_DIR="`pwd`"
+SCRIPT_FUNCTIONS="${SCRIPT_DIR}/functions.sh"
+if [ -r "${SCRIPT_FUNCTIONS}" ]; then
+ . ${SCRIPT_FUNCTIONS}
+else
+ echo >&2 "Function include file ${SCRIPT_FUNCTIONS} not found or not readable."
+ echo >&2 "These functions are critical for script operation. Aborting."
exit 1
fi
-if $verbose ; then
- q=""
-else
- q="-q"
-fi
-# Rotate and clean on startup. Default to false since 7.4 as log4j2 handles startup rotation
-if [ "${SOLR_LOG_PRESTART_ROTATION:=false}" == "true" ]; then
- # Enable any of these if you require old remove/archive behavior
- #run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -remove_old_solr_logs 7 || echo "Failed removing old solr logs"
- #run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -archive_gc_logs $q || echo "Failed archiving old GC logs"
- #run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -archive_console_logs || echo "Failed archiving old console logs"
- run_tool utils -s "$DEFAULT_SERVER_DIR" -l "$SOLR_LOGS_DIR" $q -rotate_solr_logs 10 || echo "Failed rotating old solr logs"
+
+# Exit if bash not found or too old.
+exit_if_no_bash
+exit_if_bash_too_old
+
+# Running this script from cygwin is not supported.
+# If somebody creates a bulletproof implementation,
+# This might be reconsidered.
+THIS_OS="`uname -s`"
+if [ -z "${SOLR_FORCE_FLAG}" ] && [[ "${THIS_OS,,}" = *cygwin* ]]; then
+ echo >&2 "This script does not support cygwin."
+ echo >&2 "Use the native solr.cmd script on Windows."
+ echo >&2 "You can continue by setting SOLR_FORCE_FLAG,"
+ echo >&2 "but you'll be in unsupported territory."
+ err_msg_contact_community
+ exit 1
fi
-# Establish default GC logging opts if no env var set (otherwise init to sensible default)
-if [ -z ${GC_LOG_OPTS+x} ]; then
- if [[ "$JAVA_VER_NUM" -lt "9" ]] ; then
- GC_LOG_OPTS=('-verbose:gc' '-XX:+PrintHeapAtGC' '-XX:+PrintGCDetails' \
- '-XX:+PrintGCDateStamps' '-XX:+PrintGCTimeStamps' '-XX:+PrintTenuringDistribution' \
- '-XX:+PrintGCApplicationStoppedTime')
- else
- GC_LOG_OPTS=('-Xlog:gc*')
- fi
-else
- GC_LOG_OPTS=($GC_LOG_OPTS)
+# If there are other platforms that are not supported, detect above this line.
+
+# Call function to set location variables, including SOLR_TIP. The
+# function will also change the current directory to SOLR_TIP.
+find_dirs_and_change_cwd ${SCRIPT_DIR}
+
+# Find required system executables and assign variables to access them.
+# Exit the script if something critical is not found.
+find_system_programs_or_exit
+
+# Call the included function for locating Java, exit if not found.
+find_java_or_exit
+
+# Create and then delete a tempfile for this script run.
+# We will then use the filename later in the script.
+mkdir -p ${SOLR_TMP_DIR}
+RET=$?
+if [ ${RET} -ne 0 ]; then
+ echo >&2 "Error creating temp directory ${SOLR_TMP_DIR}. Aborting."
+ err_msg_contact_community
+ exit 1
+fi
+TMP_FILE=`"${X_TEMPFILE}" -d "${SOLR_TMP_DIR}"`
+RET=$?
+if [ ${RET} -ne 0 ]; then
+ echo >&2 "Unable to create tempfile. Aborting."
+ err_msg_contact_community
+ exit 1
+fi
+rm -rf ${TMP_FILE}
+
+# Ask the agent for commands to set environment variables.
+# Write the commands to the tempfile, source the file, and
+# then delete it. This step will also do validation of the
+# JVM and OS, setting environment variables for further action.
+agent_get_env > ${TMP_FILE}
+RET=$?
+RET=0
+if [ ${RET} -ne 0 ]; then
+ rm -rf ${TMP_FILE}
+ echo >&2 "Error getting env variables from agent. Aborting."
+ err_msg_contact_community
+ exit 1
+fi
+. ${TMP_FILE}
+rm -rf ${TMP_FILE}
+
+# If set, display generic message from the agent on stdout.
+if [ -n "${SOLR_AGENT_MESSAGE}" ]; then
+ echo -e "${SOLR_AGENT_MESSAGE}"
fi
-# if verbose gc logging enabled, setup the location of the log file and rotation
-if [ "$GC_LOG_OPTS" != "" ]; then
- if [[ "$JAVA_VER_NUM" -lt "9" ]] ; then
- gc_log_flag="-Xloggc"
- if [ "$JAVA_VENDOR" == "IBM J9" ]; then
- gc_log_flag="-Xverbosegclog"
- fi
- GC_LOG_OPTS+=("$gc_log_flag:$SOLR_LOGS_DIR/solr_gc.log" '-XX:+UseGCLogFileRotation' '-XX:NumberOfGCLogFiles=9' '-XX:GCLogFileSize=20M')
- else
- # http://openjdk.java.net/jeps/158
- for i in "${!GC_LOG_OPTS[@]}";
- do
- # for simplicity, we only look at the prefix '-Xlog:gc'
- # (if 'all' or multiple tags are used starting with anything other then 'gc' the user is on their own)
- # if a single additional ':' exists in param, then there is already an explicit output specifier
- GC_LOG_OPTS[$i]=$(echo ${GC_LOG_OPTS[$i]} | sed "s|^\(-Xlog:gc[^:]*$\)|\1:file=$SOLR_LOGS_DIR/solr_gc.log:time,uptime:filecount=9,filesize=20000|")
- done
- fi
+# If the environment variables set by the previous step indicate
+# exit is required, display the exit message and then exit.
+if [ -n "${SOLR_AGENT_NEEDS_EXIT}" ]; then
+ echo >&2 -e "${SOLR_AGENT_EXIT_MESSAGE}"
+ err_msg_contact_community
+ exit 1;
fi
-# If ZK_HOST is defined, the assume SolrCloud mode
-if [[ -n "$ZK_HOST" ]]; then
- SOLR_MODE="solrcloud"
-fi
-
-if [ "$SOLR_MODE" == 'solrcloud' ]; then
- if [ -z "$ZK_CLIENT_TIMEOUT" ]; then
- ZK_CLIENT_TIMEOUT="15000"
- fi
-
- CLOUD_MODE_OPTS=("-DzkClientTimeout=$ZK_CLIENT_TIMEOUT")
-
- if [ "$ZK_HOST" != "" ]; then
- CLOUD_MODE_OPTS+=("-DzkHost=$ZK_HOST")
- else
- if $verbose ; then
- echo "Configuring SolrCloud to launch an embedded Zookeeper using -DzkRun"
- fi
-
- CLOUD_MODE_OPTS+=('-DzkRun')
- fi
-
- # and if collection1 needs to be bootstrapped
- if [ -e "$SOLR_HOME/collection1/core.properties" ]; then
- CLOUD_MODE_OPTS+=('-Dbootstrap_confdir=./solr/collection1/conf' '-Dcollection.configName=myconf' '-DnumShards=1')
- fi
-
-else
- if [ ! -e "$SOLR_HOME/solr.xml" ]; then
- echo -e "\nSolr home directory $SOLR_HOME must contain a solr.xml file!\n"
- exit 1
- fi
-fi
-
-# These are useful for attaching remote profilers like VisualVM/JConsole
-if [ "$ENABLE_REMOTE_JMX_OPTS" == "true" ]; then
-
- if [ -z "$RMI_PORT" ]; then
- RMI_PORT=`expr $SOLR_PORT + 10000`
- if [ $RMI_PORT -gt 65535 ]; then
- echo -e "\nRMI_PORT is $RMI_PORT, which is invalid!\n"
- exit 1
- fi
- fi
-
- REMOTE_JMX_OPTS=('-Dcom.sun.management.jmxremote' \
- '-Dcom.sun.management.jmxremote.local.only=false' \
- '-Dcom.sun.management.jmxremote.ssl=false' \
- '-Dcom.sun.management.jmxremote.authenticate=false' \
- "-Dcom.sun.management.jmxremote.port=$RMI_PORT" \
- "-Dcom.sun.management.jmxremote.rmi.port=$RMI_PORT")
-
- # if the host is set, then set that as the rmi server hostname
- if [ "$SOLR_HOST" != "" ]; then
- REMOTE_JMX_OPTS+=("-Djava.rmi.server.hostname=$SOLR_HOST")
- fi
-else
- REMOTE_JMX_OPTS=()
-fi
-
-JAVA_MEM_OPTS=()
-if [ -z "$SOLR_HEAP" ] && [ -n "$SOLR_JAVA_MEM" ]; then
- JAVA_MEM_OPTS=($SOLR_JAVA_MEM)
-else
- SOLR_HEAP="${SOLR_HEAP:-512m}"
- JAVA_MEM_OPTS=("-Xms$SOLR_HEAP" "-Xmx$SOLR_HEAP")
-fi
-
-# Pick default for Java thread stack size, and then add to SOLR_OPTS
-if [ -z ${SOLR_JAVA_STACK_SIZE+x} ]; then
- SOLR_JAVA_STACK_SIZE='-Xss256k'
-fi
-SOLR_OPTS+=($SOLR_JAVA_STACK_SIZE)
-
-if [ -z "$SOLR_TIMEZONE" ]; then
- SOLR_TIMEZONE='UTC'
-fi
-
-# Launches Solr in foreground/background depending on parameters
-function launch_solr() {
-
- run_in_foreground="$1"
- stop_port="$STOP_PORT"
-
- SOLR_ADDL_ARGS="$2"
- SOLR_JETTY_ADDL_CONFIG="$3"
-
- # define default GC_TUNE
- if [ -z ${GC_TUNE+x} ]; then
- GC_TUNE=('-XX:NewRatio=3' \
- '-XX:SurvivorRatio=4' \
- '-XX:TargetSurvivorRatio=90' \
- '-XX:MaxTenuringThreshold=8' \
- '-XX:+UseConcMarkSweepGC' \
- '-XX:ConcGCThreads=4' '-XX:ParallelGCThreads=4' \
- '-XX:+CMSScavengeBeforeRemark' \
- '-XX:PretenureSizeThreshold=64m' \
- '-XX:+UseCMSInitiatingOccupancyOnly' \
- '-XX:CMSInitiatingOccupancyFraction=50' \
- '-XX:CMSMaxAbortablePrecleanTime=6000' \
- '-XX:+CMSParallelRemarkEnabled' \
- '-XX:+ParallelRefProcEnabled' \
- '-XX:-OmitStackTraceInFastThrow')
- else
- GC_TUNE=($GC_TUNE)
- fi
-
- if [ -n "$SOLR_WAIT_FOR_ZK" ]; then
- WAIT_FOR_ZK_PROP="-DwaitForZk=$SOLR_WAIT_FOR_ZK"
- SOLR_OPTS+=($WAIT_FOR_ZK_PROP)
- fi
-
- # If SSL-related system props are set, add them to SOLR_OPTS
- if [ "$SOLR_SSL_ENABLED" ]; then
- # If using SSL and solr.jetty.https.port not set explicitly, use the jetty.port
- SSL_PORT_PROP="-Dsolr.jetty.https.port=$SOLR_PORT"
- SOLR_OPTS+=($SOLR_SSL_OPTS "$SSL_PORT_PROP")
- fi
-
- # If authentication system props are set, add them to SOLR_OPTS
- if [ -n "$AUTHC_OPTS" ]; then
- SOLR_OPTS+=($AUTHC_OPTS)
- fi
-
- if $verbose ; then
- echo -e "\nStarting Solr using the following settings:"
- echo -e " JAVA = $JAVA"
- echo -e " SOLR_SERVER_DIR = $SOLR_SERVER_DIR"
- echo -e " SOLR_HOME = $SOLR_HOME"
- echo -e " SOLR_HOST = $SOLR_HOST"
- echo -e " SOLR_PORT = $SOLR_PORT"
- echo -e " STOP_PORT = $STOP_PORT"
- echo -e " JAVA_MEM_OPTS = ${JAVA_MEM_OPTS[@]}"
- echo -e " GC_TUNE = ${GC_TUNE[@]}"
- echo -e " GC_LOG_OPTS = ${GC_LOG_OPTS[@]}"
- echo -e " SOLR_TIMEZONE = $SOLR_TIMEZONE"
-
- if [ "$SOLR_MODE" == "solrcloud" ]; then
- echo -e " CLOUD_MODE_OPTS = ${CLOUD_MODE_OPTS[@]}"
- fi
-
- if [ "$SOLR_OPTS" != "" ]; then
- echo -e " SOLR_OPTS = ${SOLR_OPTS[@]}"
- fi
-
- if [ "$SOLR_ADDL_ARGS" != "" ]; then
- echo -e " SOLR_ADDL_ARGS = $SOLR_ADDL_ARGS"
- fi
-
- if [ "$ENABLE_REMOTE_JMX_OPTS" == "true" ]; then
- echo -e " RMI_PORT = $RMI_PORT"
- echo -e " REMOTE_JMX_OPTS = ${REMOTE_JMX_OPTS[@]}"
- fi
-
- if [ "$SOLR_LOG_LEVEL" != "" ]; then
- echo -e " SOLR_LOG_LEVEL = $SOLR_LOG_LEVEL"
- fi
-
- if [ "$SOLR_DATA_HOME" != "" ]; then
- echo -e " SOLR_DATA_HOME = $SOLR_DATA_HOME"
- fi
- echo -e "\n"
- fi
-
- # need to launch solr from the server dir
- cd "$SOLR_SERVER_DIR"
-
- if [ ! -e "$SOLR_SERVER_DIR/start.jar" ]; then
- echo -e "\nERROR: start.jar file not found in $SOLR_SERVER_DIR!\nPlease check your -d parameter to set the correct Solr server directory.\n"
- exit 1
- fi
-
- SOLR_START_OPTS=('-server' "${JAVA_MEM_OPTS[@]}" "${GC_TUNE[@]}" "${GC_LOG_OPTS[@]}" \
- "${REMOTE_JMX_OPTS[@]}" "${CLOUD_MODE_OPTS[@]}" $SOLR_LOG_LEVEL_OPT -Dsolr.log.dir="$SOLR_LOGS_DIR" \
- "-Djetty.port=$SOLR_PORT" "-DSTOP.PORT=$stop_port" "-DSTOP.KEY=$STOP_KEY" \
- "${SOLR_HOST_ARG[@]}" "-Duser.timezone=$SOLR_TIMEZONE" \
- "-Djetty.home=$SOLR_SERVER_DIR" "-Dsolr.solr.home=$SOLR_HOME" "-Dsolr.data.home=$SOLR_DATA_HOME" "-Dsolr.install.dir=$SOLR_TIP" \
- "-Dsolr.default.confdir=$DEFAULT_CONFDIR" "${LOG4J_CONFIG[@]}" "${SOLR_OPTS[@]}")
-
- if [ "$SOLR_MODE" == "solrcloud" ]; then
- IN_CLOUD_MODE=" in SolrCloud mode"
- fi
-
- mkdir -p "$SOLR_LOGS_DIR" 2>/dev/null
- if [ $? -ne 0 ]; then
- echo -e "\nERROR: Logs directory $SOLR_LOGS_DIR could not be created. Exiting"
- exit 1
- fi
- if [ ! -w "$SOLR_LOGS_DIR" ]; then
- echo -e "\nERROR: Logs directory $SOLR_LOGS_DIR is not writable. Exiting"
- exit 1
- fi
- case "$SOLR_LOGS_DIR" in
- contexts|etc|lib|modules|resources|scripts|solr|solr-webapp)
- echo -e "\nERROR: Logs directory $SOLR_LOGS_DIR is invalid. Reserved for the system. Exiting"
- exit 1
- ;;
- esac
-
- if [ "$run_in_foreground" == "true" ]; then
- exec "$JAVA" "${SOLR_START_OPTS[@]}" $SOLR_ADDL_ARGS -jar start.jar "${SOLR_JETTY_CONFIG[@]}" $SOLR_JETTY_ADDL_CONFIG
- else
- # run Solr in the background
- nohup "$JAVA" "${SOLR_START_OPTS[@]}" $SOLR_ADDL_ARGS -Dsolr.log.muteconsole \
- "-XX:OnOutOfMemoryError=$SOLR_TIP/bin/oom_solr.sh $SOLR_PORT $SOLR_LOGS_DIR" \
- -jar start.jar "${SOLR_JETTY_CONFIG[@]}" $SOLR_JETTY_ADDL_CONFIG \
- 1>"$SOLR_LOGS_DIR/solr-$SOLR_PORT-console.log" 2>&1 & echo $! > "$SOLR_PID_DIR/solr-$SOLR_PORT.pid"
-
- # check if /proc/sys/kernel/random/entropy_avail exists then check output of cat /proc/sys/kernel/random/entropy_avail to see if less than 300
- if [[ -f /proc/sys/kernel/random/entropy_avail ]] && (( `cat /proc/sys/kernel/random/entropy_avail` < 300)); then
- echo "Warning: Available entropy is low. As a result, use of the UUIDField, SSL, or any other features that require"
- echo "RNG might not work properly. To check for the amount of available entropy, use 'cat /proc/sys/kernel/random/entropy_avail'."
- echo ""
- fi
- # no lsof on cygwin though
- if hash lsof 2>/dev/null ; then # hash returns true if lsof is on the path
- echo -n "Waiting up to $SOLR_STOP_WAIT seconds to see Solr running on port $SOLR_PORT"
- # Launch in a subshell to show the spinner
- (loops=0
- while true
- do
- running=`lsof -PniTCP:$SOLR_PORT -sTCP:LISTEN`
- if [ -z "$running" ]; then
- slept=$((loops * 2))
- if [ $slept -lt $SOLR_STOP_WAIT ]; then
- sleep 2
- loops=$[$loops+1]
- else
- echo -e "Still not seeing Solr listening on $SOLR_PORT after $SOLR_STOP_WAIT seconds!"
- tail -30 "$SOLR_LOGS_DIR/solr.log"
- exit # subshell!
- fi
- else
- SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
- echo -e "\nStarted Solr server on port $SOLR_PORT (pid=$SOLR_PID). Happy searching!\n"
- exit # subshell!
- fi
- done) &
- spinner $!
- else
- echo -e "NOTE: Please install lsof as this script needs it to determine if Solr is listening on port $SOLR_PORT."
- sleep 10
- SOLR_PID=`ps auxww | grep start\.jar | grep -w "\-Djetty\.port=$SOLR_PORT" | grep -v grep | awk '{print $2}' | sort -r`
- echo -e "\nStarted Solr server on port $SOLR_PORT (pid=$SOLR_PID). Happy searching!\n"
- return;
- fi
- fi
-}
-
-launch_solr "$FG" "$ADDITIONAL_CMD_OPTS" "$ADDITIONAL_JETTY_CONFIG"
-
-exit $?
+# Call a function to locate the agent properties. If the function is
+# unable to analyze things to decide how to operate, it will abort the
+# script.
+find_agent_properties_or_exit
diff --git a/solr/start/build.xml b/solr/start/build.xml
new file mode 100644
index 0000000..8641f0c
--- /dev/null
+++ b/solr/start/build.xml
@@ -0,0 +1,90 @@
+<?xml version="1.0"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one or more
+ contributor license agreements. See the NOTICE file distributed with
+ this work for additional information regarding copyright ownership.
+ The ASF licenses this file to You under the Apache License, Version 2.0
+ the "License"); you may not use this file except in compliance with
+ the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing, software
+ distributed under the License is distributed on an "AS IS" BASIS,
+ WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
+ See the License for the specific language governing permissions and
+ limitations under the License.
+ -->
+<project name="solr-start" default="default" xmlns:ivy="antlib:org.apache.ivy.ant">
+ <!-- TODO: This script copied from SolrJ and modified. Get it ready. -->
+ <description>Start - Main method for Solr</description>
+
+ <property name="test.lib.dir" location="test-lib"/>
+
+ <import file="../common-build.xml"/>
+
+ <!-- Specialized compile classpath: to only depend on what start should depend on (e.g. not lucene) -->
+ <path id="classpath">
+ <fileset dir="${common-solr.dir}/start/lib" excludes="${common.classpath.excludes}"/>
+ </path>
+
+ <!-- Specialized common-solr.test.classpath, to remove the Solr core test output -->
+ <path id="test.classpath">
+ <fileset dir="${test.lib.dir}" includes="*.jar"/>
+ <pathelement path="${common-solr.dir}/build/solr-test-framework/classes/java"/>
+ <pathelement path="${tests.userdir}"/>
+ <path refid="test.base.classpath"/>
+ <path refid="solr.base.classpath"/>
+ <pathelement path="${example}/resources"/>
+ </path>
+
+ <target name="resolve" depends="ivy-availability-check,ivy-fail,ivy-configure">
+ <sequential>
+ <ivy:retrieve conf="compile" type="jar,bundle" sync="${ivy.sync}" log="download-only" symlink="${ivy.symlink}"/>
+ <ivy:retrieve conf="test" type="jar,bundle,test" sync="${ivy.sync}" log="download-only" symlink="${ivy.symlink}"
+ pattern="${test.lib.dir}/[artifact]-[revision](-[classifier]).[ext]"/>
+ </sequential>
+ </target>
+
+ <!-- Specialized to depend on nothing -->
+ <target name="javadocs" depends="compile-core,define-lucene-javadoc-url,check-javadocs-uptodate"
+ unless="javadocs-uptodate-${name}">
+ <sequential>
+ <mkdir dir="${javadoc.dir}/${name}"/>
+ <solr-invoke-javadoc>
+ <solrsources>
+ <packageset dir="${src.dir}"/>
+ </solrsources>
+ </solr-invoke-javadoc>
+ <solr-jarify basedir="${javadoc.dir}/${name}" destfile="${build.dir}/${final.name}-javadoc.jar"/>
+ </sequential>
+ </target>
+
+ <!-- Specialized to use lucene's classpath too, because it refs e.g. qp syntax
+ (even though it doesnt compile with it)
+ TODO: would be nice to fix this up better, but it's hard because of
+ the different ways solr links to lucene javadocs -->
+ <target name="-ecj-javadoc-lint-src" depends="-ecj-resolve">
+ <ecj-macro srcdir="${src.dir}" configuration="${common.dir}/tools/javadoc/ecj.javadocs.prefs">
+ <classpath>
+ <path refid="classpath"/>
+ <path refid="solr.lucene.libs"/>
+ </classpath>
+ </ecj-macro>
+ </target>
+
+ <target name="dist" depends="common-solr.dist">
+ <!-- TODO: Fix or remove this.
+ <mkdir dir="${dist}/solrj-lib" />
+ <copy todir="${dist}/solrj-lib">
+ <fileset dir="${common-solr.dir}/start/lib">
+ <include name="*.jar"/>
+ </fileset>
+ </copy>
+ -->
+ </target>
+
+ <target name="-dist-maven" depends="-dist-maven-src-java"/>
+
+ <target name="-install-to-maven-local-repo" depends="-install-src-java-to-maven-local-repo"/>
+</project>
diff --git a/solr/start/ivy.xml b/solr/start/ivy.xml
new file mode 100644
index 0000000..ed9823c
--- /dev/null
+++ b/solr/start/ivy.xml
@@ -0,0 +1,34 @@
+<?xml version="1.0" encoding="utf-8"?>
+<!--
+ Licensed to the Apache Software Foundation (ASF) under one
+ or more contributor license agreements. See the NOTICE file
+ distributed with this work for additional information
+ regarding copyright ownership. The ASF licenses this file
+ to you under the Apache License, Version 2.0 (the
+ "License"); you may not use this file except in compliance
+ with the License. You may obtain a copy of the License at
+
+ http://www.apache.org/licenses/LICENSE-2.0
+
+ Unless required by applicable law or agreed to in writing,
+ software distributed under the License is distributed on an
+ "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY
+ KIND, either express or implied. See the License for the
+ specific language governing permissions and limitations
+ under the License.
+-->
+<ivy-module version="2.0">
+ <info organisation="org.apache.solr" module="solrj"/>
+
+ <configurations defaultconfmapping="compile->master;test->master">
+ <!-- artifacts in the "compile" configuration will go into solr/solrj/lib/ -->
+ <conf name="compile" transitive="false"/>
+ <!-- artifacts in the "test" configuration will go into solr/solrj/test-lib/ -->
+ <conf name="test" transitive="false"/>
+ </configurations>
+
+ <dependencies>
+ <dependency org="org.slf4j" name="slf4j-api" rev="${/org.slf4j/slf4j-api}" conf="compile"/>
+ <exclude org="*" ext="*" matcher="regexp" type="${ivy.exclude.types}"/>
+ </dependencies>
+</ivy-module>
diff --git a/solr/start/src/java/org/apache/solr/start/Main.java b/solr/start/src/java/org/apache/solr/start/Main.java
new file mode 100644
index 0000000..cec908f
--- /dev/null
+++ b/solr/start/src/java/org/apache/solr/start/Main.java
@@ -0,0 +1,159 @@
+package org.apache.solr.start;
+
+import java.io.IOException;
+import java.util.HashMap;
+import java.util.Map;
+import java.util.Objects;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServlet;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.eclipse.jetty.alpn.server.ALPNServerConnectionFactory;
+import org.eclipse.jetty.http2.HTTP2Cipher;
+import org.eclipse.jetty.http2.server.HTTP2ServerConnectionFactory;
+import org.eclipse.jetty.server.AsyncNCSARequestLog;
+import org.eclipse.jetty.server.HttpConfiguration;
+import org.eclipse.jetty.server.HttpConnectionFactory;
+import org.eclipse.jetty.server.NegotiatingServerConnectionFactory;
+import org.eclipse.jetty.server.SecureRequestCustomizer;
+import org.eclipse.jetty.server.Server;
+import org.eclipse.jetty.server.ServerConnector;
+import org.eclipse.jetty.server.SslConnectionFactory;
+import org.eclipse.jetty.server.handler.HandlerWrapper;
+import org.eclipse.jetty.server.handler.gzip.GzipHandler;
+import org.eclipse.jetty.servlet.FilterHolder;
+import org.eclipse.jetty.servlet.ServletContextHandler;
+import org.eclipse.jetty.servlets.PushCacheFilter;
+import org.eclipse.jetty.util.log.Log;
+import org.eclipse.jetty.util.log.Logger;
+import org.eclipse.jetty.util.ssl.SslContextFactory;
+
+public class Main {
+
+ private static final Logger LOG = Log.getLogger(Main.class);
+
+ public static void main(String[] args) throws Exception {
+ try (JettyStarter starter = new JettyStarter();) {
+ starter.start();
+ LOG.info("Press any key to stop Jetty.");
+ System.in.read();
+ }
+ }
+
+ public static class NoopServlet extends HttpServlet {
+
+ private static final long serialVersionUID = 1L;
+
+ @Override
+ protected void doGet(HttpServletRequest req, HttpServletResponse resp)
+ throws ServletException, IOException {
+ resp.setContentType("text/html;charset=UTF-8");
+ resp.getWriter().append("OK+");
+ }
+
+ }
+
+ private static class JettyStarter implements AutoCloseable {
+
+ private static final int SSL_PORT = 8443;
+ private final Server server;
+ private final HttpConfiguration config = createHttpConfiguration();
+
+ public JettyStarter() {
+ HttpConnectionFactory httpFactory = new HttpConnectionFactory(config);
+ HTTP2ServerConnectionFactory http2Factory = new HTTP2ServerConnectionFactory(
+ config);
+ ALPNServerConnectionFactory alpn = createAlpnProtocolFactory(httpFactory);
+ Server server = createServer(httpFactory, http2Factory, alpn);
+
+ HandlerWrapper servletHandler = createServletHandlerWithServlet();
+ HandlerWrapper gzipHandler = createGzipHandler();
+ gzipHandler.setHandler(servletHandler);
+ server.setHandler(gzipHandler);
+
+ this.server = server;
+ }
+
+ private Server createServer(HttpConnectionFactory httpConnectionFactory,
+ HTTP2ServerConnectionFactory http2ConnectionFactory,
+ ALPNServerConnectionFactory alpn) {
+ Server server = new Server();
+ server.setRequestLog(new AsyncNCSARequestLog());
+
+ ServerConnector connector = new ServerConnector(server, prepareSsl(alpn),
+ alpn, http2ConnectionFactory, httpConnectionFactory);
+ connector.setPort(SSL_PORT);
+ server.addConnector(connector);
+
+ return server;
+ }
+
+ private GzipHandler createGzipHandler() {
+ GzipHandler gzipHandler = new GzipHandler();
+ gzipHandler.setIncludedPaths("/*");
+ gzipHandler.setMinGzipSize(0);
+ gzipHandler.setIncludedMimeTypes("text/plain", "text/html");
+ return gzipHandler;
+ }
+
+ private ServletContextHandler createServletHandlerWithServlet() {
+ ServletContextHandler context = new ServletContextHandler(
+ ServletContextHandler.SESSIONS);
+
+ FilterHolder pushCacheFilter = context.addFilter(PushCacheFilter.class, "/*",
+ null);
+ Map<String, String> config = new HashMap<>();
+ config.put("maxAssociations", "32");
+ config.put("ports", Objects.toString(SSL_PORT));
+ pushCacheFilter.setInitParameters(config);
+
+ context.addServlet(NoopServlet.class, "/*");
+ context.setContextPath("/");
+
+ return context;
+ }
+
+ private ALPNServerConnectionFactory createAlpnProtocolFactory(
+ HttpConnectionFactory httpConnectionFactory) {
+ NegotiatingServerConnectionFactory.checkProtocolNegotiationAvailable();
+ ALPNServerConnectionFactory alpn = new ALPNServerConnectionFactory();
+ alpn.setDefaultProtocol(httpConnectionFactory.getProtocol());
+ return alpn;
+ }
+
+ private SslConnectionFactory prepareSsl(ALPNServerConnectionFactory alpn) {
+ SslContextFactory sslContextFactory = new SslContextFactory();
+ sslContextFactory.setKeyStorePath(
+ Main.class.getResource("/keystore").toExternalForm());
+ sslContextFactory.setKeyStorePassword("changeit");
+ sslContextFactory.setCipherComparator(HTTP2Cipher.COMPARATOR);
+ sslContextFactory.setUseCipherSuitesOrder(true);
+ SslConnectionFactory ssl = new SslConnectionFactory(sslContextFactory,
+ alpn.getProtocol());
+ return ssl;
+ }
+
+ private static HttpConfiguration createHttpConfiguration() {
+ HttpConfiguration config = new HttpConfiguration();
+ config.setSecureScheme("https");
+ config.setSecurePort(SSL_PORT);
+ config.setSendXPoweredBy(false);
+ config.setSendServerVersion(false);
+ config.addCustomizer(new SecureRequestCustomizer());
+ return config;
+ }
+
+ public void start() throws Exception {
+ server.start();
+ }
+
+ @Override
+ public void close() throws Exception {
+ server.stop();
+ }
+
+ }
+
+}
\ No newline at end of file
