diff --git a/solr/solr-ref-guide/src/collections-api.adoc b/solr/solr-ref-guide/src/collections-api.adoc index 527f4c7c9c5..b94509dee73 100644 --- a/solr/solr-ref-guide/src/collections-api.adoc +++ b/solr/solr-ref-guide/src/collections-api.adoc @@ -52,7 +52,9 @@ The number of shards to be created as part of the collection. This is a required A comma separated list of shard names, e.g., `shard-x,shard-y,shard-z`. This is a required parameter when the `router.name` is `implicit`. `replicationFactor`:: -The number of replicas to be created for each shard. The default is `1`. This will create a NRT type of replica. If you want another type of replica, see the `tlogReplicas` and `pullReplica` parameters. See the section <> for more information about replica types. +The number of replicas to be created for each shard. The default is `1`. ++ +This will create a NRT type of replica. If you want another type of replica, see the `tlogReplicas` and `pullReplica` parameters below. See the section <> for more information about replica types. `nrtReplicas`:: The number of NRT (Near-Real-Time) replicas to create for this collection. This type of replica maintains a transaction log and updates its index locally. If you want all of your replicas to be of this type, you can simply use `replicationFactor` instead. @@ -96,7 +98,9 @@ Please note that <> or retrieval by Set core property _name_ to _value_. See the section <> for details on supported properties and values. `autoAddReplicas`:: -When set to `true`, enables automatic addition of replicas on shared file systems (such as HDFS) only. See the section <> for more details on settings and overrides. The default is `false`. +When set to `true`, enables automatic addition of replicas when the number of active replicas falls below the value set for `replicationFactor`. This may occur if a replica goes down, for example. The default is `false`, which means new replicas will not be added. ++ +While this parameter is provided as part of Solr's set of features to provide autoscaling of clusters, it is available even when you have not implemented any other part of autoscaling (such as a policy). See the section <> for more details about this option and how it can be used. `async`:: Request ID to track this action which will be <>. diff --git a/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc index c4680587537..92c32b70d37 100644 --- a/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc +++ b/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc @@ -181,7 +181,7 @@ If using Kerberos, you will need to add the three Kerberos related properties to == Automatically Add Replicas in SolrCloud -The ability to automatically add new replicas when the Overseer notices that a shard has gone down was previously only available to users running Solr in HDFS, but it is now available to all users via Solr's autoscaling framework. See the section <> for details on how to enable and disable this feature. +The ability to automatically add new replicas when the Overseer notices that a shard has gone down was previously only available to users running Solr in HDFS, but it is now available to all users via Solr's autoscaling framework. See the section <> for details on how to enable and disable this feature. [WARNING] ==== diff --git a/solr/solrj/src/resources/apispec/collections.Commands.json b/solr/solrj/src/resources/apispec/collections.Commands.json index 026822715b8..ed55a1e95fb 100644 --- a/solr/solrj/src/resources/apispec/collections.Commands.json +++ b/solr/solrj/src/resources/apispec/collections.Commands.json @@ -82,7 +82,8 @@ }, "autoAddReplicas": { "type": "boolean", - "description": "When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://lucene.apache.org/solr/guide/running-solr-on-hdfs.html for more details on settings and overrides.", + "description": "When set to true, enables auto addition of replicas when the number of active replicas falls below the value set for replicationFactor.", + "documentation": "https://lucene.apache.org/solr/guide/solrcloud-autoscaling-auto-add-replicas.html", "default": "false" }, "rule": { diff --git a/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json b/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json index 658b4ebe3dc..62e35cc46a8 100644 --- a/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json +++ b/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json @@ -26,7 +26,9 @@ }, "autoAddReplicas": { "type": "boolean", - "description": "When set to true, enables auto addition of replicas on shared file systems (such as HDFS). See https://lucene.apache.org/solr/guide/running-solr-on-hdfs.html for more details on settings and overrides." + "description": "When set to true, enables auto addition of replicas when the number of active replicas falls below the value set for replicationFactor.", + "documentation": "https://lucene.apache.org/solr/guide/solrcloud-autoscaling-auto-add-replicas.html", + "default": "false" }, "replicationFactor": { "type": "integer",