Skip to content

Commit 5a658d7

Browse files
epughCopilot
andauthored
SOLR-18179: Better highlight and expand upon our Cluster concepts in the Ref Guide (#4246)
Co-authored-by: copilot-swe-agent[bot] <198982749+Copilot@users.noreply.github.com> Co-authored-by: epugh <22395+epugh@users.noreply.github.com>
1 parent 1af33ac commit 5a658d7

35 files changed

Lines changed: 289 additions & 191 deletions
Lines changed: 7 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,7 @@
1+
title: Move cluster concepts into Getting Started in Ref Guide
2+
type: changed
3+
authors:
4+
- name: Eric Pugh
5+
links:
6+
- name: SOLR-18179
7+
url: https://issues.apache.org/jira/browse/SOLR-18179

solr/solr-ref-guide/modules/configuration-guide/pages/config-api.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@
1919

2020
The Config API enables manipulating various aspects of your `solrconfig.xml` using REST-like API calls.
2121

22-
This feature is enabled by default and works similarly in both SolrCloud, user-managed clusters, and single-node installations.
22+
This feature is enabled by default and works similarly in both SolrCloud and user-managed clusters installations.
2323
Many commonly edited properties (such as cache sizes and commit settings) and request handler definitions can be changed with this API.
2424

2525
When using this API, `solrconfig.xml` is not changed.
@@ -847,7 +847,7 @@ In order to be able to `update` and `delete` of the same item in `configoverlay.
847847
When using SolrCloud, every core watches the ZooKeeper directory for the configset being used with that core.
848848
If there are multiple cores in the same node using the same configset, only one ZooKeeper watch is used.
849849

850-
TIP:: In a user-managed cluster or single-node installation, there is no watch (because ZooKeeper is not running).
850+
TIP:: In a user-managed cluster or standalone installation, there is no watch (because ZooKeeper is not running).
851851

852852
For instance, if the configset 'myconf' is used by a core, the node would watch `/configs/myconf`.
853853
Every write operation performed through the API would 'touch' the directory and all watchers are notified.

solr/solr-ref-guide/modules/configuration-guide/pages/config-sets.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,9 +60,9 @@ However, users can impose stricter or looser limits on their systems by providin
6060
- System Property: `-Dsolr.configset.forbidden.file.types`
6161
- Environment Variable: `SOLR_CONFIG_SET_FORBIDDEN_FILE_TYPES`
6262

63-
== Configsets in User-Managed Clusters or Single-Node Installations
63+
== Configsets in User-Managed Clusters or Standalone Installations
6464

65-
If you are using Solr in a user-managed cluster or a single-node installation, configsets are managed on the filesystem.
65+
If you are using Solr in a user-managed cluster or a standalone installation, configsets are managed on the filesystem.
6666

6767
Each Solr core can have it's very own configset located beneath it in a `<instance_dir>/conf/` dir.
6868
Here, it is not named or shared and the word _configset_ isn't found.

solr/solr-ref-guide/modules/configuration-guide/pages/configuration-files.adoc

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -27,11 +27,11 @@ When you first install Solr, your home directory is `server/solr`.
2727
However, some examples may change this location (such as, if you run `bin/solr start -e cloud`, your home directory will be `example/cloud`).
2828

2929
The home directory contains important configuration information and is the place where Solr will store its index.
30-
The layout of the home directory will look a little different when you are running Solr in a user-managed cluster or single-node installation vs. when you are running a SolrCloud cluster.
30+
The layout of the home directory will look a little different when you are running Solr in a user-managed cluster or standalone installation vs. when you are running a SolrCloud cluster.
3131

3232
The crucial parts of the Solr home directory are shown in these examples:
3333

34-
.User-Managed Cluster or Single-Node
34+
.User-Managed Cluster or Standalone
3535
[source,plain]
3636
----
3737
<solr-home-directory>/
@@ -96,8 +96,8 @@ The Files screen in the Admin UI lets you browse & view configuration files (suc
9696
.The Files Screen
9797
image::configuration-files/files-screen.png[Files screen,height=400]
9898

99-
If you are using xref:deployment-guide:cluster-types.adoc#solrcloud-mode[SolrCloud], the files displayed are the configuration files for this collection stored in ZooKeeper.
100-
In user-managed clusters or single-node installations, all files in the `conf` directory are displayed.
99+
If you are using xref:getting-started:cluster-types.adoc#solrcloud-clusters[SolrCloud], the files displayed are the configuration files for this collection stored in ZooKeeper.
100+
In user-managed clusters or standalone installations, all files in the `conf` directory are displayed.
101101

102102
The configuration files shown may or may not be used by the collection as use of the file depends on how they are referenced in either `solrconfig.xml` or your schema.
103103

solr/solr-ref-guide/modules/configuration-guide/pages/coreadmin-api.adoc

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -18,9 +18,9 @@
1818
// specific language governing permissions and limitations
1919
// under the License.
2020

21-
The Core Admin API is primarily used under the covers by the xref:collections-api.adoc[] when running a xref:deployment-guide:cluster-types.adoc#solrcloud-mode[SolrCloud] cluster.
21+
The Core Admin API is primarily used under the covers by the xref:collections-api.adoc[] when running a xref:getting-started:cluster-types.adoc#solrcloud-clusters[SolrCloud] cluster.
2222

23-
SolrCloud users should not typically use the CoreAdmin API directly, but the API may be useful for users of user-managed clusters or single-node installations for core maintenance operations.
23+
SolrCloud users should not typically use the CoreAdmin API directly, but the API may be useful for users of user-managed clusters or standalone installations for core maintenance operations.
2424

2525
The CoreAdmin API is implemented by the CoreAdminHandler, which is a special purpose xref:requesthandlers-searchcomponents.adoc[request handler] that is used to manage Solr cores.
2626
Unlike other request handlers, the CoreAdminHandler is not attached to a single core.

solr/solr-ref-guide/modules/configuration-guide/pages/libs.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -34,7 +34,7 @@ There are several special places you can place Solr plugin `.jar` files, describ
3434
|Location |Visible To |Purpose |Additional Notes
3535
|`<solr_install>/lib/` | Everything (Node-level plugins, Core-level plugins, `bin/solr` tools) |Any plugins that administrators want to make available to all of Solrand its tooling, esp. when building a custom Solr package or Dockerfile. |N/A
3636
|`<solr_home/lib/` | Node-level plugins, Core-level plugins |Useful when plugins should be made available to all of Solr, but cannot be put in `<solr_install>/lib/` for whatever reason (e.g. Solr installed on read-only file system) | Directory not present by default and must be created by administrators. See xref:deployment-guide:taking-solr-to-production.adoc[].
37-
|`<core_instance>/lib/` |Core-level plugins (for a specific core) |User-managed clusters or single-node installations that want to make a plugin visible to a specific Solr core, but not others. |Directory is not created by default, and must be created by administrators adjacent to `<core_instance>/conf/`
37+
|`<core_instance>/lib/` |Core-level plugins (for a specific core) |User-managed clusters or standalone installations that want to make a plugin visible to a specific Solr core, but not others. |Directory is not created by default, and must be created by administrators adjacent to `<core_instance>/conf/`
3838
|`<solr_install>/server/solr-webapp/webapp/WEB-INF/lib/` |Everything (Node-level plugins, Core-level plugins, `bin/solr` tools) |Intended for Solr's own jars and dependencies |Should not be used for plugins, except in the case of a few rare plugin typs whose documentation explicitly calls out the need for placement here.
3939
|`<solr_install>/server/lib/ext` |Everything (Node-level plugins, Core-level plugins, `bin/solr` tools) |Intended to contain Jetty jars and other things needed by the Jetty servlet classpath. Not typically used for plugins |N/A
4040
|===

solr/solr-ref-guide/modules/configuration-guide/pages/request-parameters-api.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -24,7 +24,7 @@ It is really another endpoint of the xref:config-api.adoc[] instead of a separat
2424
It does not replace or modify any sections of `solrconfig.xml`, but instead provides another approach to handling parameters used in requests.
2525
It behaves in the same way as the Config API, by storing parameters in another file that will be used at runtime.
2626
In this case, the parameters are stored in a file named `params.json`.
27-
This file is kept in ZooKeeper when running SolrCloud or in the `conf` directory of a user-managed cluster or single-node installation.
27+
This file is kept in ZooKeeper when running SolrCloud or in the `conf` directory of a user-managed cluster or standalone installation.
2828

2929
The settings stored in `params.json` are used at query time to override settings defined in `solrconfig.xml` in some cases as described below.
3030

solr/solr-ref-guide/modules/configuration-guide/pages/resource-loading.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -31,7 +31,7 @@ xref:managed-resources.adoc[] can be manipulated via APIs and do not need an exp
3131

3232
xref:config-sets.adoc[] are the directories containing `solrconfig.xml`, the schema, and resources referenced by them.
3333
In SolrCloud they are stored in ZooKeeper.
34-
In a user-managed cluster and a single-node installation they are stored on the file system.
34+
In a user-managed cluster or standalone installation they are stored on the file system.
3535
In any mode, resources may be shared or may be dedicated to a configSet.
3636
Prefer to put resources here.
3737

solr/solr-ref-guide/modules/configuration-guide/pages/update-request-processors.adoc

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -132,7 +132,7 @@ Once the above has been specified in `solrconfig.xml`, we can be refer to them i
132132

133133
== Update Processors in SolrCloud
134134

135-
In a user-managed cluster or a single-node installation, each update is run through all the update processors in a chain exactly once.
135+
In a user-managed cluster or standalone installation, each update is run through all the update processors in a chain exactly once.
136136
In SolrCloud, however, the behavior of update request processors deserves special consideration.
137137

138138
A critical SolrCloud functionality is the routing and distributing of requests.

solr/solr-ref-guide/modules/deployment-guide/deployment-nav.adoc

Lines changed: 0 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -30,7 +30,6 @@
3030
*** xref:docker-faq.adoc[]
3131
3232
* Scaling Solr
33-
** xref:cluster-types.adoc[]
3433
** SolrCloud Clusters
3534
*** xref:solrcloud-shards-indexing.adoc[]
3635
*** xref:solrcloud-recoveries-and-write-tolerance.adoc[]

0 commit comments

Comments
 (0)