janhoy commented on code in PR #5190: URL: https://github.com/apache/solr/pull/5190#discussion_r4459218305
########## solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc: ########## @@ -27,2059 +27,10 @@ More examples of SolrCLI in use are available throughout this Guide, particularl [NOTE] ==== -This page documents the `bin/solr` script as it behaves by default. +By default, `bin/solr` uses a picocli-based implementation. +See xref:cli/index.adoc[] for its commands and options. -An experimental re-implementation of the command line interface, built on picocli, is also included in this release. -It is disabled by default, and the options it accepts differ in places from those documented here. -See xref:cli/index.adoc[] if you would like to try it. +xref:cli/commons-cli-reference.adoc[] describes the Apache Commons CLI implementation, which you can switch to by setting `SOLR_PICOCLI=false` in case you run into a problem with the default. +Options and the output may differ from the default CLI. ==== -== Starting and Stopping - -=== Start and Restart - -The `start` command starts Solr. -The `restart` command allows you to restart Solr while it is already running or if it has been stopped already. - -The `start` and `restart` commands have several options to allow you to run in SolrCloud mode, use an example configuration set, start with a hostname or port that is not the default and point to a local ZooKeeper ensemble. - -`bin/solr start [options]` - -`bin/solr start --help` - -`bin/solr restart [options]` - -`bin/solr restart --help` - -When using the `restart` command, you must pass all of the parameters you initially passed when you started Solr. -Behind the scenes, a stop request is initiated, so Solr will be stopped before being started again. -If no nodes are already running, restart will skip the step to stop and proceed to starting Solr. - -==== Start Parameters - -The `bin/solr` script provides many options to allow you to customize the server in common ways, such as changing the listening port. -However, most of the defaults are adequate for most Solr installations, especially when just getting started. - -`--jvm-opts <jvmParams>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr with additional JVM parameters, such as those starting with `-X`. -For example setting up Java debugger to attach to the Solr JVM you could pass: `--jvm-opts "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=18983"`. -In most cases, you should wrap the additional parameters in double quotes. -+ -If you are passing JVM parameters that begin with `-D`, you can omit the `--jvm-opts` option. -+ -*Example*: -+ -[source,bash] -bin/solr start --jvm-opts "-Xdebug -Xrunjdwp:transport=dt_socket, server=y,suspend=n,address=1044" - -`-j <jettyParams>` or `--jettyconfig <jettyParams>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Additional parameters to pass to Jetty when starting Solr. -For example, to add configuration folder that Jetty should read you could pass: `-j "--include-jetty-dir=/etc/jetty/custom/server/"`. -In most cases, you should wrap the additional parameters in double quotes. - -`--user-managed`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr in User Managed mode (AKA Standalone mode). This is the style of Solr that supports only cores, not collections. -+ -For more details, see the section <<User Managed Mode>> below. -+ -*Example*: `bin/solr start --user-managed` - -`--server-dir <dir>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `server/` -|=== -+ -Define a server directory, defaults to `server` (as in, `$SOLR_TIP/server`). -It is uncommon to override this option. -When running multiple instances of Solr on the same host, it is more common to use the same server directory for each instance and use a unique Solr home directory using the `--solr-home` option. -+ -*Example*: `bin/solr start --server-dir newServerDir` - -`-f`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr in the foreground and sends stdout / stderr to `solr-PORT-console.log`. -You cannot use this option when running examples with the `-e` option. -+ -*Example*: `bin/solr start -f` - -`--host <hostname>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `localhost` -|=== -+ -Specify the hostname for this Solr instance. -If this is not specified, `localhost` is assumed. -+ -*Example*: `bin/solr start --host search.mysolr.com` - -`-m <memory>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: 512m -|=== -+ -Sets the min (`-Xms`) and max (`-Xmx`) heap size for the JVM running Solr. -+ -*Example*: `bin/solr start -m 4g` results in `-Xms4g -Xmx4g` settings. - -`-p <port>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `8983` -|=== -+ -Specify the port to start the Solr HTTP listener on; with the classic default port for Solr being 8983. -The specified port (SOLR_PORT) will also be used to determine the stop port. -The stop port is defined as STOP_PORT=($SOLR_PORT-1000) and JMX RMI listen port is defined as RMI_PORT=($SOLR_PORT+10000). -For instance, if you set -p 8985, then the STOP_PORT=7985 and RMI_PORT=18985. -If this is not specified, `8983` will be used. -+ -*Example*: `bin/solr start -p 8655` - -`--solr-home <dir>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `server/solr` -|=== -+ -Sets the `solr.solr.home` system property. -Solr will create core directories under this directory. -This allows you to run multiple Solr instances on the same host while reusing the same server directory set using the `--server-dir` parameter. -If set, the specified directory should contain a solr.xml file, unless solr.xml exists in Zookeeper. -+ -This parameter is ignored when running examples (`-e`), as the `solr.solr.home` depends on which example is run. -+ -The default value is `server/solr`. -If passed relative dir, validation with current dir will be done, before trying default `server/<dir>`. -+ -*Example*: `bin/solr start --solr-home newHome` - -`--data-home <dir>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `solr.solr.home` -|=== -+ -Sets the `solr.data.home` system property, where Solr will store index data in <instance_dir>/data subdirectories. -If not set, Solr uses solr.solr.home for config and data. - -`--verbose`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -This does two things. It provides additional debugging information on how the script is configured to start Solr. -It also changes the logging level of Log4j in Solr from `INFO` to `DEBUG`, having the same effect as if you edited `log4j2.xml`. -+ -*Example*: `bin/solr start -f --verbose` - -`-q` or `--quiet`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Be more quiet. -This changes the logging level of Log4j in Solr from `INFO` to `WARN`, having the same effect as if you edited `log4j2.xml`. -This can be useful in a production setting where you want to limit logging to warnings and errors. -+ -*Example*: `bin/solr start -f -q` - -`-z <zkHost>` or `--zk-host <zkHost>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: _see description_ -|=== -+ -Zookeeper connection string, this option is only used with the `-c` option, to start Solr in SolrCloud mode. -If `ZK_HOST` is not specified in `solr.in.sh`/`solr.in.cmd` and this option is not provided, Solr will start the embedded ZooKeeper instance and use that instance for SolrCloud operations. -+ -Set the `ZK_CREATE_CHROOT` environment variable to true if your ZK host has a chroot path, and you want to create it automatically. -+ -*Example*: `bin/solr start -z server1:2181,server2:2181` - -`--force`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -If attempting to start Solr as the root user, the script will exit with a warning that running Solr as "root" can cause problems. -It is possible to override this warning with the `--force` parameter. -+ -*Example*: `sudo bin/solr start --force` - -To emphasize how the default settings work take a moment to understand that the following commands are equivalent: - -`bin/solr start` - -`bin/solr start --host localhost -p 8983 --server-dir server --solr-home solr -m 512m` - -`-e <name>` or `--example <name>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr with an example configuration. -These examples are provided to help you get started faster with Solr generally, or just try a specific feature. -+ -The available options are: - -* `cloud`: SolrCloud example -* `techproducts`: Comprehensive example illustrating many of Solr's core capabilities -* `schemaless`: Schema-less example (schema is inferred from data during indexing) -* `films`: Example of starting with _default configset and adding explicit fields dynamically -+ -See the section <<Running with Example Configurations>> below for more details on the example configurations. -+ -*Example*: `bin/solr start -e schemaless` - -`--no-prompt`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Don't prompt for input; accept all defaults when running examples that accept input. -+ -For example, when using the "cloud" example, an interactive session guides you through several options for your SolrCloud cluster. -If you want to accept all of the defaults, you can simply add the `--no-prompt` option to your request. -+ -*Example*: `bin/solr start -e cloud --no-prompt` - -`--script-inputs <values>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Don't prompt for input; instead supply ordered answers in comma delimited format when running examples that accept input. -+ -For example, when using the "cloud" example, you can answer the interactive session's questions non-interactively to start a three node cluster on specific ports: -+ -*Example*: `bin/solr start -e cloud --script-inputs 3,9000,9001,9002,"mycollection",2,2,_default` - -On Windows please wrap the script-inputs value in double quotes to preserve the comma delimited format. - -It is not necessary to define all of the options when starting if the defaults are fine for your needs. - -==== Setting Java System Properties - -The `bin/solr` script will pass any additional parameters that begin with `-D` to the JVM, which allows you to set arbitrary Java system properties. - -For example, to set the auto soft-commit frequency to 3 seconds, you can do: - -`bin/solr start -Dsolr.autoSoftCommit.maxTime=3000` - -Solr will also convert any environment variable on the format `SOLR_FOO_BAR` to -system property `solr.foo.bar`, making it possible to inject most properties -through the environment, e.g: - -`SOLR_LOG_LEVEL=debug bin/solr start` - -The `SOLR_OPTS` environment variable is also available to set additional System Properties for Solr. - -In order to set custom System Properties when running any Solr utility other than `start` (e.g. `stop`, `create`, `auth`, `status`, `api`), -the `SOLR_TOOL_OPTS` environment variable should be used. - -==== SolrCloud Mode - -This is the default mode for running Solr. - -If you specify a ZooKeeper connection string, such as `-z 192.168.1.4:2181`, then Solr will connect to ZooKeeper and join the cluster. - -NOTE: If you have defined `ZK_HOST` in `solr.in.sh`/`solr.in.cmd` (see xref:zookeeper-ensemble.adoc#updating-solr-include-files[Updating Solr Include Files]) you can omit `-z <zk host string>` from all `bin/solr` commands. - -When starting Solr in SolrCloud mode, if you do not define `ZK_HOST` in `solr.in.sh`/`solr.in.cmd` nor specify the `-z` option, then Solr will launch an embedded ZooKeeper server listening on the Solr port + 1000. -For example, if Solr is running on port 8983, then the embedded ZooKeeper will listen on port 9983. - -[IMPORTANT] -==== -If your ZooKeeper connection string uses a chroot, such as `localhost:2181/solr`, then you need to create the /solr znode before launching SolrCloud using the `bin/solr` script. - -To do this use the `mkroot` command outlined below, for example: `bin/solr zk mkroot /solr -z 192.168.1.4:2181` -==== - -When starting in SolrCloud mode, the interactive script session will prompt you to choose a configset to use. - -For more information about starting Solr in SolrCloud mode, see also the section xref:getting-started:tutorial-solrcloud.adoc[]. - -==== User Managed Mode - -`bin/solr start --user-managed` starts Solr in User Managed mode (AKA Standalone mode). This was the default mode up until Solr 10x. - -For more information about the different modes, see the section xref:getting-started:cluster-types.adoc[]. - - -==== Running with Example Configurations - -`bin/solr start -e <name>` - -The example configurations allow you to get started quickly with a configuration that mirrors what you hope to accomplish with Solr. - -Each example launches Solr with a managed schema, which allows use of the xref:indexing-guide:schema-api.adoc[] to make schema edits, but does not allow manual editing of a Schema file. - -If you would prefer to manually modify a `schema.xml` file directly, you can change this default as described in the section xref:configuration-guide:schema-factory.adoc[]. - -Unless otherwise noted in the descriptions below, the examples do not enable xref:indexing-guide:schemaless-mode.adoc[]. - -The following examples are provided: - -* *cloud*: This example starts a 1-4 node SolrCloud cluster on a single machine. -When chosen, an interactive session will start to guide you through options to select the initial configset to use, the number of nodes for your example cluster, the ports to use, and name of the collection to be created. -+ -When using this example, you can choose from any of the available configsets found in `$SOLR_TIP/server/solr/configsets`. - -* *techproducts*: This example starts a standalone Solr instance with a schema designed for the sample documents included in the `$SOLR_HOME/example/exampledocs` directory. -+ -The configset used can be found in `$SOLR_TIP/server/solr/configsets/sample_techproducts_configs`. -+ -The data used can be found in `$SOLR_HOME/example/exampledocs/`. - -* *schemaless*: This example starts a standalone Solr instance using a managed schema, as described in the section xref:configuration-guide:schema-factory.adoc[], and provides a very minimal pre-defined schema. -Solr will run in xref:indexing-guide:schemaless-mode.adoc[] with this configuration, where Solr will create fields in the schema on the fly and will guess field types used in incoming documents. -+ -The configset used can be found in `$SOLR_TIP/server/solr/configsets/_default`. - -* *films*: This example starts a standalone Solr instance using a managed schema, as described in the section xref:configuration-guide:schema-factory.adoc[], and then uses the Schema API to create some custom fields. -Solr will run in xref:indexing-guide:schemaless-mode.adoc[] with this configuration, where Solr will create fields in the schema on the fly and will guess field types used in incoming documents as well. -It then loads some sample film data. -+ -The configset used can be found in `$SOLR_TIP/server/solr/configsets/_default`. -+ -The film data used can be found in `$SOLR_HOME/example/films/films.json`. - -[IMPORTANT] -==== -The run in-foreground option (`-f`) is not compatible with the `-e` option since the script needs to perform additional tasks after starting the Solr server. -==== Review Comment: This entire section is not pure MAN page but generic CLI related topics which are valid independent of parser. It should likely be moved back to this page. ########## solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc: ########## @@ -27,2059 +27,10 @@ More examples of SolrCLI in use are available throughout this Guide, particularl [NOTE] ==== -This page documents the `bin/solr` script as it behaves by default. +By default, `bin/solr` uses a picocli-based implementation. +See xref:cli/index.adoc[] for its commands and options. -An experimental re-implementation of the command line interface, built on picocli, is also included in this release. -It is disabled by default, and the options it accepts differ in places from those documented here. -See xref:cli/index.adoc[] if you would like to try it. +xref:cli/commons-cli-reference.adoc[] describes the Apache Commons CLI implementation, which you can switch to by setting `SOLR_PICOCLI=false` in case you run into a problem with the default. +Options and the output may differ from the default CLI. ==== -== Starting and Stopping - -=== Start and Restart - -The `start` command starts Solr. -The `restart` command allows you to restart Solr while it is already running or if it has been stopped already. - -The `start` and `restart` commands have several options to allow you to run in SolrCloud mode, use an example configuration set, start with a hostname or port that is not the default and point to a local ZooKeeper ensemble. - -`bin/solr start [options]` - -`bin/solr start --help` - -`bin/solr restart [options]` - -`bin/solr restart --help` - -When using the `restart` command, you must pass all of the parameters you initially passed when you started Solr. -Behind the scenes, a stop request is initiated, so Solr will be stopped before being started again. -If no nodes are already running, restart will skip the step to stop and proceed to starting Solr. - -==== Start Parameters - -The `bin/solr` script provides many options to allow you to customize the server in common ways, such as changing the listening port. -However, most of the defaults are adequate for most Solr installations, especially when just getting started. - -`--jvm-opts <jvmParams>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr with additional JVM parameters, such as those starting with `-X`. -For example setting up Java debugger to attach to the Solr JVM you could pass: `--jvm-opts "-agentlib:jdwp=transport=dt_socket,server=y,suspend=n,address=18983"`. -In most cases, you should wrap the additional parameters in double quotes. -+ -If you are passing JVM parameters that begin with `-D`, you can omit the `--jvm-opts` option. -+ -*Example*: -+ -[source,bash] -bin/solr start --jvm-opts "-Xdebug -Xrunjdwp:transport=dt_socket, server=y,suspend=n,address=1044" - -`-j <jettyParams>` or `--jettyconfig <jettyParams>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Additional parameters to pass to Jetty when starting Solr. -For example, to add configuration folder that Jetty should read you could pass: `-j "--include-jetty-dir=/etc/jetty/custom/server/"`. -In most cases, you should wrap the additional parameters in double quotes. - -`--user-managed`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr in User Managed mode (AKA Standalone mode). This is the style of Solr that supports only cores, not collections. -+ -For more details, see the section <<User Managed Mode>> below. -+ -*Example*: `bin/solr start --user-managed` - -`--server-dir <dir>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `server/` -|=== -+ -Define a server directory, defaults to `server` (as in, `$SOLR_TIP/server`). -It is uncommon to override this option. -When running multiple instances of Solr on the same host, it is more common to use the same server directory for each instance and use a unique Solr home directory using the `--solr-home` option. -+ -*Example*: `bin/solr start --server-dir newServerDir` - -`-f`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr in the foreground and sends stdout / stderr to `solr-PORT-console.log`. -You cannot use this option when running examples with the `-e` option. -+ -*Example*: `bin/solr start -f` - -`--host <hostname>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `localhost` -|=== -+ -Specify the hostname for this Solr instance. -If this is not specified, `localhost` is assumed. -+ -*Example*: `bin/solr start --host search.mysolr.com` - -`-m <memory>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: 512m -|=== -+ -Sets the min (`-Xms`) and max (`-Xmx`) heap size for the JVM running Solr. -+ -*Example*: `bin/solr start -m 4g` results in `-Xms4g -Xmx4g` settings. - -`-p <port>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `8983` -|=== -+ -Specify the port to start the Solr HTTP listener on; with the classic default port for Solr being 8983. -The specified port (SOLR_PORT) will also be used to determine the stop port. -The stop port is defined as STOP_PORT=($SOLR_PORT-1000) and JMX RMI listen port is defined as RMI_PORT=($SOLR_PORT+10000). -For instance, if you set -p 8985, then the STOP_PORT=7985 and RMI_PORT=18985. -If this is not specified, `8983` will be used. -+ -*Example*: `bin/solr start -p 8655` - -`--solr-home <dir>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `server/solr` -|=== -+ -Sets the `solr.solr.home` system property. -Solr will create core directories under this directory. -This allows you to run multiple Solr instances on the same host while reusing the same server directory set using the `--server-dir` parameter. -If set, the specified directory should contain a solr.xml file, unless solr.xml exists in Zookeeper. -+ -This parameter is ignored when running examples (`-e`), as the `solr.solr.home` depends on which example is run. -+ -The default value is `server/solr`. -If passed relative dir, validation with current dir will be done, before trying default `server/<dir>`. -+ -*Example*: `bin/solr start --solr-home newHome` - -`--data-home <dir>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: `solr.solr.home` -|=== -+ -Sets the `solr.data.home` system property, where Solr will store index data in <instance_dir>/data subdirectories. -If not set, Solr uses solr.solr.home for config and data. - -`--verbose`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -This does two things. It provides additional debugging information on how the script is configured to start Solr. -It also changes the logging level of Log4j in Solr from `INFO` to `DEBUG`, having the same effect as if you edited `log4j2.xml`. -+ -*Example*: `bin/solr start -f --verbose` - -`-q` or `--quiet`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Be more quiet. -This changes the logging level of Log4j in Solr from `INFO` to `WARN`, having the same effect as if you edited `log4j2.xml`. -This can be useful in a production setting where you want to limit logging to warnings and errors. -+ -*Example*: `bin/solr start -f -q` - -`-z <zkHost>` or `--zk-host <zkHost>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: _see description_ -|=== -+ -Zookeeper connection string, this option is only used with the `-c` option, to start Solr in SolrCloud mode. -If `ZK_HOST` is not specified in `solr.in.sh`/`solr.in.cmd` and this option is not provided, Solr will start the embedded ZooKeeper instance and use that instance for SolrCloud operations. -+ -Set the `ZK_CREATE_CHROOT` environment variable to true if your ZK host has a chroot path, and you want to create it automatically. -+ -*Example*: `bin/solr start -z server1:2181,server2:2181` - -`--force`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -If attempting to start Solr as the root user, the script will exit with a warning that running Solr as "root" can cause problems. -It is possible to override this warning with the `--force` parameter. -+ -*Example*: `sudo bin/solr start --force` - -To emphasize how the default settings work take a moment to understand that the following commands are equivalent: - -`bin/solr start` - -`bin/solr start --host localhost -p 8983 --server-dir server --solr-home solr -m 512m` - -`-e <name>` or `--example <name>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Start Solr with an example configuration. -These examples are provided to help you get started faster with Solr generally, or just try a specific feature. -+ -The available options are: - -* `cloud`: SolrCloud example -* `techproducts`: Comprehensive example illustrating many of Solr's core capabilities -* `schemaless`: Schema-less example (schema is inferred from data during indexing) -* `films`: Example of starting with _default configset and adding explicit fields dynamically -+ -See the section <<Running with Example Configurations>> below for more details on the example configurations. -+ -*Example*: `bin/solr start -e schemaless` - -`--no-prompt`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Don't prompt for input; accept all defaults when running examples that accept input. -+ -For example, when using the "cloud" example, an interactive session guides you through several options for your SolrCloud cluster. -If you want to accept all of the defaults, you can simply add the `--no-prompt` option to your request. -+ -*Example*: `bin/solr start -e cloud --no-prompt` - -`--script-inputs <values>`:: -+ -[%autowidth,frame=none] -|=== -|Optional |Default: none -|=== -+ -Don't prompt for input; instead supply ordered answers in comma delimited format when running examples that accept input. -+ -For example, when using the "cloud" example, you can answer the interactive session's questions non-interactively to start a three node cluster on specific ports: -+ -*Example*: `bin/solr start -e cloud --script-inputs 3,9000,9001,9002,"mycollection",2,2,_default` - -On Windows please wrap the script-inputs value in double quotes to preserve the comma delimited format. - -It is not necessary to define all of the options when starting if the defaults are fine for your needs. - -==== Setting Java System Properties - -The `bin/solr` script will pass any additional parameters that begin with `-D` to the JVM, which allows you to set arbitrary Java system properties. - -For example, to set the auto soft-commit frequency to 3 seconds, you can do: - -`bin/solr start -Dsolr.autoSoftCommit.maxTime=3000` - -Solr will also convert any environment variable on the format `SOLR_FOO_BAR` to -system property `solr.foo.bar`, making it possible to inject most properties -through the environment, e.g: - -`SOLR_LOG_LEVEL=debug bin/solr start` - -The `SOLR_OPTS` environment variable is also available to set additional System Properties for Solr. - -In order to set custom System Properties when running any Solr utility other than `start` (e.g. `stop`, `create`, `auth`, `status`, `api`), -the `SOLR_TOOL_OPTS` environment variable should be used. - -==== SolrCloud Mode - -This is the default mode for running Solr. - -If you specify a ZooKeeper connection string, such as `-z 192.168.1.4:2181`, then Solr will connect to ZooKeeper and join the cluster. - -NOTE: If you have defined `ZK_HOST` in `solr.in.sh`/`solr.in.cmd` (see xref:zookeeper-ensemble.adoc#updating-solr-include-files[Updating Solr Include Files]) you can omit `-z <zk host string>` from all `bin/solr` commands. - -When starting Solr in SolrCloud mode, if you do not define `ZK_HOST` in `solr.in.sh`/`solr.in.cmd` nor specify the `-z` option, then Solr will launch an embedded ZooKeeper server listening on the Solr port + 1000. -For example, if Solr is running on port 8983, then the embedded ZooKeeper will listen on port 9983. - -[IMPORTANT] -==== -If your ZooKeeper connection string uses a chroot, such as `localhost:2181/solr`, then you need to create the /solr znode before launching SolrCloud using the `bin/solr` script. - -To do this use the `mkroot` command outlined below, for example: `bin/solr zk mkroot /solr -z 192.168.1.4:2181` -==== - -When starting in SolrCloud mode, the interactive script session will prompt you to choose a configset to use. - -For more information about starting Solr in SolrCloud mode, see also the section xref:getting-started:tutorial-solrcloud.adoc[]. - -==== User Managed Mode - -`bin/solr start --user-managed` starts Solr in User Managed mode (AKA Standalone mode). This was the default mode up until Solr 10x. - -For more information about the different modes, see the section xref:getting-started:cluster-types.adoc[]. - - -==== Running with Example Configurations - -`bin/solr start -e <name>` - -The example configurations allow you to get started quickly with a configuration that mirrors what you hope to accomplish with Solr. - -Each example launches Solr with a managed schema, which allows use of the xref:indexing-guide:schema-api.adoc[] to make schema edits, but does not allow manual editing of a Schema file. - -If you would prefer to manually modify a `schema.xml` file directly, you can change this default as described in the section xref:configuration-guide:schema-factory.adoc[]. - -Unless otherwise noted in the descriptions below, the examples do not enable xref:indexing-guide:schemaless-mode.adoc[]. - -The following examples are provided: - -* *cloud*: This example starts a 1-4 node SolrCloud cluster on a single machine. -When chosen, an interactive session will start to guide you through options to select the initial configset to use, the number of nodes for your example cluster, the ports to use, and name of the collection to be created. -+ -When using this example, you can choose from any of the available configsets found in `$SOLR_TIP/server/solr/configsets`. - -* *techproducts*: This example starts a standalone Solr instance with a schema designed for the sample documents included in the `$SOLR_HOME/example/exampledocs` directory. -+ -The configset used can be found in `$SOLR_TIP/server/solr/configsets/sample_techproducts_configs`. -+ -The data used can be found in `$SOLR_HOME/example/exampledocs/`. - -* *schemaless*: This example starts a standalone Solr instance using a managed schema, as described in the section xref:configuration-guide:schema-factory.adoc[], and provides a very minimal pre-defined schema. -Solr will run in xref:indexing-guide:schemaless-mode.adoc[] with this configuration, where Solr will create fields in the schema on the fly and will guess field types used in incoming documents. -+ -The configset used can be found in `$SOLR_TIP/server/solr/configsets/_default`. - -* *films*: This example starts a standalone Solr instance using a managed schema, as described in the section xref:configuration-guide:schema-factory.adoc[], and then uses the Schema API to create some custom fields. -Solr will run in xref:indexing-guide:schemaless-mode.adoc[] with this configuration, where Solr will create fields in the schema on the fly and will guess field types used in incoming documents as well. -It then loads some sample film data. -+ -The configset used can be found in `$SOLR_TIP/server/solr/configsets/_default`. -+ -The film data used can be found in `$SOLR_HOME/example/films/films.json`. - -[IMPORTANT] -==== -The run in-foreground option (`-f`) is not compatible with the `-e` option since the script needs to perform additional tasks after starting the Solr server. -==== Review Comment: This entire section is not pure MAN page but generic CLI related topics which are valid independent of parser. It should likely be moved back to this page. -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected] --------------------------------------------------------------------- To unsubscribe, e-mail: [email protected] For additional commands, e-mail: [email protected]
