lucene-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From ctarg...@apache.org
Subject lucene-solr:master: SOLR-12448: Fix outdated docs that say autoAddReplicas is for shared FS only in Ref Guide and v2 API specs
Date Tue, 31 Jul 2018 17:26:00 GMT
Repository: lucene-solr
Updated Branches:
  refs/heads/master 6fbaf698b -> ecad9198d


SOLR-12448: Fix outdated docs that say autoAddReplicas is for shared FS only in Ref Guide
and v2 API specs


Project: http://git-wip-us.apache.org/repos/asf/lucene-solr/repo
Commit: http://git-wip-us.apache.org/repos/asf/lucene-solr/commit/ecad9198
Tree: http://git-wip-us.apache.org/repos/asf/lucene-solr/tree/ecad9198
Diff: http://git-wip-us.apache.org/repos/asf/lucene-solr/diff/ecad9198

Branch: refs/heads/master
Commit: ecad9198d83b9454aeb140d59a769196b9a913e0
Parents: 6fbaf69
Author: Cassandra Targett <ctargett@apache.org>
Authored: Tue Jul 31 12:02:58 2018 -0500
Committer: Cassandra Targett <ctargett@apache.org>
Committed: Tue Jul 31 12:25:45 2018 -0500

----------------------------------------------------------------------
 solr/solr-ref-guide/src/collections-api.adoc                 | 8 ++++++--
 solr/solr-ref-guide/src/running-solr-on-hdfs.adoc            | 2 +-
 solr/solrj/src/resources/apispec/collections.Commands.json   | 3 ++-
 .../apispec/collections.collection.Commands.modify.json      | 4 +++-
 4 files changed, 12 insertions(+), 5 deletions(-)
----------------------------------------------------------------------


http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ecad9198/solr/solr-ref-guide/src/collections-api.adoc
----------------------------------------------------------------------
diff --git a/solr/solr-ref-guide/src/collections-api.adoc b/solr/solr-ref-guide/src/collections-api.adoc
index 527f4c7..b94509d 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 <<shards-and-indexing-data-in-solrcloud.adoc#types-of-replicas,Types
of Replicas>> 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 <<shards-and-indexing-data-in-solrcloud.adoc#types-of-replicas,Types
of Replicas>> 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 <<realtime-get.adoc#realtime-get,RealTime Get>>
or retrieval by
 Set core property _name_ to _value_. See the section <<defining-core-properties.adoc#defining-core-properties,Defining
core.properties>> 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 <<running-solr-on-hdfs.adoc#automatically-add-replicas-in-solrcloud,autoAddReplicas
Settings>> 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 <<solrcloud-autoscaling-auto-add-replicas.adoc#the-autoaddreplicas-parameter,SolrCloud
Autoscaling Automatically Adding Replicas>> for more details about this option and how
it can be used.
 
 `async`::
 Request ID to track this action which will be <<Asynchronous Calls,processed asynchronously>>.

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ecad9198/solr/solr-ref-guide/src/running-solr-on-hdfs.adoc
----------------------------------------------------------------------
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 c468058..92c32b7 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 <<solrcloud-autoscaling-triggers.adoc#auto-add-replicas-trigger,Auto
Add Replicas Trigger>> 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 <<solrcloud-autoscaling-auto-add-replicas.adoc#the-autoaddreplicas-parameter,SolrCloud
Autoscaling Automatically Adding Replicas>> for details on how to enable and disable
this feature.
 
 [WARNING]
 ====

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ecad9198/solr/solrj/src/resources/apispec/collections.Commands.json
----------------------------------------------------------------------
diff --git a/solr/solrj/src/resources/apispec/collections.Commands.json b/solr/solrj/src/resources/apispec/collections.Commands.json
index 0268227..ed55a1e 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": {

http://git-wip-us.apache.org/repos/asf/lucene-solr/blob/ecad9198/solr/solrj/src/resources/apispec/collections.collection.Commands.modify.json
----------------------------------------------------------------------
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 658b4eb..62e35cc 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",


Mime
View raw message