This is an automated email from the ASF dual-hosted git repository.
epugh pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/solr.git
The following commit(s) were added to refs/heads/main by this push:
new 943e02236ad Update docs to reflect SolrCloud is now default mode.
(#2780)
943e02236ad is described below
commit 943e02236ad8f9ae5a842189a135046d6f2b3bfa
Author: Eric Pugh <[email protected]>
AuthorDate: Mon Oct 21 15:55:28 2024 -0400
Update docs to reflect SolrCloud is now default mode. (#2780)
---
README.md | 3 +--
.../deployment-guide/pages/enabling-ssl.adoc | 4 ++--
.../deployment-guide/pages/installing-solr.adoc | 6 ++---
.../pages/solr-control-script-reference.adoc | 26 +++++++++++-----------
.../deployment-guide/pages/solr-on-hdfs.adoc | 2 +-
.../getting-started/pages/tutorial-solrcloud.adoc | 14 ++++++------
.../pages/tutorial-techproducts.adoc | 4 ++--
7 files changed, 29 insertions(+), 30 deletions(-)
diff --git a/README.md b/README.md
index 920a4fa3005..cf08fa329a5 100644
--- a/README.md
+++ b/README.md
@@ -94,7 +94,7 @@ Solr uses [Gradle](https://gradle.org/) for its build system.
Here are some usef
```
cd ./solr/packaging/build/dev
-bin/solr start -c
+bin/solr start
```
- Open a web browser and go to http://localhost:8983/solr/ to access the Solr
Admin interface. You can also use the `bin/solr` script to create and manage
Solr collections. For example use the `bin/solr post` tool to index some sample
data.
@@ -108,4 +108,3 @@ To get involved in the developer community:
- Slack: `#solr-dev` in the `the-asf` organization. Sign up at
https://the-asf.slack.com/messages/CE70MDPMF
- [Issue Tracker (JIRA)](https://issues.apache.org/jira/browse/SOLR)
- IRC: `#solr-dev` on
[libera.chat](https://web.libera.chat/?channels=#solr-dev)
-
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc
index 55aa2bde610..34d540975a6 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/enabling-ssl.adoc
@@ -286,7 +286,7 @@ If you created the SSL key without all DNS names or IP
addresses on which Solr n
====
[source,terminal]
----
-$ bin/solr start --cloud --solr-home cloud/node1 -z
server1:2181,server2:2181,server3:2181 -p 8984
+$ bin/solr start --solr-home cloud/node1 -z
server1:2181,server2:2181,server3:2181 -p 8984
----
====
@@ -295,7 +295,7 @@ Windows::
====
[source,powershell]
----
-C:\> bin\solr.cmd --cloud --solr-home cloud\node1 -z
server1:2181,server2:2181,server3:2181
+C:\> bin\solr.cmd --solr-home cloud\node1 -z
server1:2181,server2:2181,server3:2181
----
====
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc
index 8dceba13dbe..497006c4de2 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/installing-solr.adoc
@@ -171,14 +171,14 @@ To use it to start Solr you can simply enter:
[source,bash]
----
-bin/solr start --cloud
+bin/solr start
----
If you are running Windows, you can start Solr by running `bin\solr.cmd`
instead.
[source,plain]
----
-bin\solr.cmd start --cloud
+bin\solr.cmd start
----
This will start Solr in the background, listening on port 8983.
@@ -195,7 +195,7 @@ For instance, to launch the "techproducts" example, you
would do:
[source,bash]
----
-bin/solr start --cloud -e techproducts
+bin/solr start -e techproducts
----
Currently, the available examples you can run are: techproducts, schemaless,
and cloud.
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
index 7dd6bd418ce..e66b591280b 100644
---
a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
+++
b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-control-script-reference.adoc
@@ -80,21 +80,18 @@ 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.
-`--cloud` or `-c`::
+`--user-managed`::
+
[%autowidth,frame=none]
|===
|Optional |Default: none
|===
+
-Start Solr in SolrCloud mode, which will also launch the embedded ZooKeeper
instance included with Solr.
-The embedded ZooKeeper instance is started on Solr port+1000, so 9983 if Solr
is bound to 8983.
+Start Solr in User Managed mode (AKA Standalone mode). This is the style of
Solr that supports only cores, not collections.
+
-If you are already running a ZooKeeper ensemble that you want to use instead
of the embedded (single-node) ZooKeeper, you should also either specify
`ZK_HOST` in `solr.in.sh`/`solr.in.cmd` (see
xref:zookeeper-ensemble.adoc#updating-solr-include-files[Updating Solr Include
Files]) or pass the `-z` parameter.
+For more details, see the section <<User Managed Mode>> below.
+
-For more details, see the section <<SolrCloud Mode>> below.
-+
-*Example*: `bin/solr start -c`
+*Example*: `bin/solr start --user-managed`
`--server-dir <dir>`::
+
@@ -303,11 +300,7 @@ the `SOLR_TOOL_OPTS` environment variable should be used.
==== SolrCloud Mode
-The `-c` and `--cloud` options are equivalent:
-
-`bin/solr start -c`
-
-`bin/solr start --cloud`
+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.
@@ -327,6 +320,13 @@ When starting in SolrCloud mode, the interactive script
session will prompt you
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:deployment-guide:cluster-types.adoc[].
+
+
==== Running with Example Configurations
`bin/solr start -e <name>`
@@ -337,7 +337,7 @@ Each example launches Solr with a managed schema, which
allows use of the xref:i
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
SolrCloud nor xref:indexing-guide:schemaless-mode.adoc[].
+Unless otherwise noted in the descriptions below, the examples do not enable
xref:indexing-guide:schemaless-mode.adoc[].
The following examples are provided:
diff --git
a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-on-hdfs.adoc
b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-on-hdfs.adoc
index f2b7f5a4f63..25548bfac2c 100644
--- a/solr/solr-ref-guide/modules/deployment-guide/pages/solr-on-hdfs.adoc
+++ b/solr/solr-ref-guide/modules/deployment-guide/pages/solr-on-hdfs.adoc
@@ -46,7 +46,7 @@ All dynamically created collections will create the
appropriate directories auto
[source,bash]
----
-bin/solr start --cloud -Dsolr.directoryFactory=HdfsDirectoryFactory
+bin/solr start -Dsolr.directoryFactory=HdfsDirectoryFactory
-Dsolr.lock.type=hdfs
-Dsolr.hdfs.home=hdfs://host:port/path
----
diff --git
a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc
b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc
index b1dd0b2c04f..3e966f929ec 100644
--- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc
+++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-solrcloud.adoc
@@ -1,4 +1,4 @@
-= Getting Started with SolrCloud
+= Exercise 6: Getting Deeper with SolrCloud
:tabs-sync-option:
// Licensed to the Apache Software Foundation (ASF) under one
// or more contributor license agreements. See the NOTICE file
@@ -17,7 +17,7 @@
// specific language governing permissions and limitations
// under the License.
-SolrCloud is designed to provide a highly available, fault tolerant
environment for distributing your indexed content and query requests across
multiple servers.
+SolrCloud is designed to provide a highly available, fault tolerant
environment for distributing your indexed content and query requests across
multiple servers. It is the default mode for running Solr, even with a single
node!
It's a system in which data is organized into multiple pieces, or shards, that
can be hosted on multiple machines, with replicas providing redundancy for both
scalability and fault tolerance, and a ZooKeeper server that helps manage the
overall structure so that both indexing and search requests can be routed
properly.
@@ -82,7 +82,7 @@ The script will start each node in order and show you the
command it uses to sta
[,console]
----
-$ bin/solr start --cloud --solr-home example/cloud/node1/solr -p 8983
+$ bin/solr start --solr-home example/cloud/node1/solr -p 8983
----
The first node will also start an embedded ZooKeeper server bound to port 9983.
@@ -176,14 +176,14 @@ For instance, to restart node1 running on port 8983 (with
an embedded ZooKeeper
[,console]
----
-$ bin/solr restart -c -p 8983 --solr-home example/cloud/node1/solr
+$ bin/solr restart -p 8983 --solr-home example/cloud/node1/solr
----
To restart node2 running on port 7574, you can do:
[,console]
----
-$ bin/solr restart -c -p 7574 -z localhost:9983 --solr-home
example/cloud/node2/solr
+$ bin/solr restart -p 7574 -z localhost:9983 --solr-home
example/cloud/node2/solr
----
Notice that you need to specify the ZooKeeper address (`-z localhost:9983`)
when starting node2 so that it can join the cluster with node1.
@@ -196,7 +196,7 @@ Once you start a SolrCloud cluster using the startup
scripts, you can add a new
[,console]
----
$ mkdir <solr.home for new Solr node>
-$ bin/solr start --cloud --solr-home <solr.home>/solr -p <port num> -z <zk
hosts string>
+$ bin/solr start --solr-home <solr.home>/solr -p <port num> -z <zk hosts
string>
----
Notice that the above requires you to create a Solr home directory.
@@ -206,7 +206,7 @@ Example (with directory structure) that adds a node to an
example started with "
[,console]
----
$ mkdir -p example/cloud/node3/solr
-$ bin/solr start --cloud --solr-home example/cloud/node3/solr -p 8987 -z
localhost:9983
+$ bin/solr start --solr-home example/cloud/node3/solr -p 8987 -z localhost:9983
----
The previous command will start another Solr node on port 8987 with Solr home
set to `example/cloud/node3/solr`.
diff --git
a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc
b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc
index ef9fab4d0cc..e397ccf9db9 100644
---
a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc
+++
b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-techproducts.adoc
@@ -71,14 +71,14 @@ Cloning /solr-{solr-full-version}/example/cloud/node1 into
/solr-{solr-full-version}/example/cloud/node2
Starting up Solr on port 8983 using command:
-"bin/solr" start --cloud -p 8983 --solr-home "example/cloud/node1/solr"
+"bin/solr" start -p 8983 --solr-home "example/cloud/node1/solr"
Waiting up to 180 seconds to see Solr running on port 8983 [\]
Started Solr server on port 8983 (pid=34942). Happy searching!
Starting up Solr on port 7574 using command:
-"bin/solr" start --cloud -p 7574 --solr-home "example/cloud/node2/solr" -z
localhost:9983
+"bin/solr" start -p 7574 --solr-home "example/cloud/node2/solr" -z
localhost:9983
Waiting up to 180 seconds to see Solr running on port 7574 [\]
Started Solr server on port 7574 (pid=35036). Happy searching!
