This is an automated email from the ASF dual-hosted git repository. dsmiley pushed a commit to branch branch_10x in repository https://gitbox.apache.org/repos/asf/solr.git
commit 6cad0552b64d8a319cff40ed45af714c5d5c31f7 Author: Eric Pugh <[email protected]> AuthorDate: Tue Oct 27 23:45:27 2026 -0400 Rework installing-solr.adoc's Preparing for Installation recommendations (#5177) (cherry picked from commit 35e2be2a7de9855a0f909613065ba22243097102) --- .../modules/deployment-guide/pages/installing-solr.adoc | 6 ------ .../pages/taking-solr-to-production.adoc | 14 ++++++++++---- .../getting-started/pages/tutorial-five-minutes.adoc | 16 ++++++++++------ 3 files changed, 20 insertions(+), 16 deletions(-) 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 ea296cc2712..61f90aaa7e2 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 @@ -44,8 +44,6 @@ When getting started with Solr, all you need to do is extract the Solr distribut This will suffice as an initial development environment, but take care not to overtax this "toy" installation before setting up your true development and production environments. When you've progressed past initial evaluation of Solr, you'll want to take care to plan your implementation. -You may need to reinstall Solr on another server or make a clustered SolrCloud environment. - When you're ready to setup Solr for a production environment, please refer to the instructions provided on the xref:taking-solr-to-production.adoc[] page. .What Size Server Do I Need? @@ -57,10 +55,6 @@ It's highly recommended that you spend a bit of time thinking about the factors A very good blog post that discusses the issues to consider is https://lucidworks.com/blog/solr-sizing-guide-estimating-solr-sizing-hardware/[Sizing Hardware in the Abstract: Why We Don't have a Definitive Answer]. ==== -One thing to note when planning your installation is that a hard limit exists in Lucene for the number of documents in a single index: approximately 2.14 billion documents (2,147,483,647 to be exact). -In practice, it is highly unlikely that such a large number of documents would fit and perform well in a single index, and you will likely need to distribute your index across a cluster before you ever approach this number. -If you know you will exceed this number of documents in total before you've even started indexing, it's best to plan your installation with xref:getting-started:cluster-types.adoc#solrcloud-clusters[SolrCloud] as part of your design from the start. - == Package Installation To keep things simple for now, extract the Solr distribution archive to your local home directory: diff --git a/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc b/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc index f3574a4b443..72359571c00 100644 --- a/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc +++ b/solr/solr-ref-guide/modules/deployment-guide/pages/taking-solr-to-production.adoc @@ -251,11 +251,17 @@ You can also refer to xref:jvm-settings.adoc[] for tuning your memory and garbag The `bin/solr` script uses the `-XX:+CrashOnOutOfMemoryError` JVM option to crash Solr on `OutOfMemoryError` exceptions. This behavior is recommended. In SolrCloud mode ZooKeeper will be immediately notified that a node has experienced a non-recoverable error. -=== Going to Production with SolrCloud +=== Going to Production with Single-Node SolrCloud -To run Solr in SolrCloud mode, you need to set the `ZK_HOST` variable in the include file to point to your ZooKeeper ensemble. -Running the embedded ZooKeeper is not supported in production environments. -For instance, if you have a ZooKeeper ensemble hosted on the following three hosts on the default client port 2181 (zk1, zk2, and zk3), then you would set: +For most new single node installations, start with xref:getting-started:cluster-types.adoc#solrcloud-clusters[SolrCloud] using its embedded ZooKeeper, which is the default mode. + +A single-node xref:getting-started:cluster-types.adoc#user-managed-cluster[User-Managed] (standalone) installation is still a reasonable choice if you know you'll only ever run one node, but migrating from User-Managed to SolrCloud later is more work than starting with SolrCloud from the beginning. +Plus you get better API and additional features with SolrCloud. + +=== Going to Production with Multi-Node SolrCloud + +For a production SolrCloud cluster with multiple Solr nodes, configure every node to use the same external ZooKeeper ensemble by setting `ZK_HOST` in each node's include file. +For instance, if you have a ZooKeeper ensemble hosted on the following three hosts on the default client port 2181 (zk1, zk2, and zk3), set: [source,bash] ---- diff --git a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-five-minutes.adoc b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-five-minutes.adoc index 46fad681334..b24031a6af2 100644 --- a/solr/solr-ref-guide/modules/getting-started/pages/tutorial-five-minutes.adoc +++ b/solr/solr-ref-guide/modules/getting-started/pages/tutorial-five-minutes.adoc @@ -19,16 +19,17 @@ This exercise will walk you through how to start using Solr in just 5 Minutes! -== Launch Solr -To launch Solr, run: `bin/solr start` on Unix or MacOS; `bin\solr.cmd start` on Windows. +== Download and Launch Solr -To start another Solr node and have it join the cluster alongside the first node, - -[,bash] +[source,bash,subs="attributes"] ---- -bin/solr start -z localhost:9983 -p 8984 +curl -fsSL https://dlcdn.apache.org/solr/solr/{solr-full-version}/solr-{solr-full-version}-slim.tgz -o solr-{solr-full-version}-slim.tgz && \ +tar -xzf solr-{solr-full-version}-slim.tgz && \ +cd solr-{solr-full-version}-slim && \ +bin/solr start ---- +On Windows download and unpack into a temp directory. Start with `bin\solr start`. == Create a collection @@ -154,3 +155,6 @@ You can now try searching your documents like: ---- curl 'http://localhost:8983/solr/techproducts/select?q=name%3Alightning' ---- + +== Shut Solr Down +To stop Solr, run: `bin/solr stop` on Unix or MacOS; `bin\solr.cmd stop` on Windows.
