[GitHub] [couchdb-documentation] flimzy commented on a change in pull request #404: Add _reshard HTTP API reference documentation

[GitBox <gi...@apache.org>]

flimzy commented on a change in pull request #404: Add _reshard HTTP API reference documentation
URL: https://github.com/apache/couchdb-documentation/pull/404#discussion_r271598709
 
 

 ##########
 File path: src/config/resharding.rst
 ##########
 @@ -0,0 +1,79 @@
+.. Licensed under the Apache License, Version 2.0 (the "License"); you may not
+.. use this file except in compliance with the License. You may obtain a copy of
+.. the License at
+..
+..   http://www.apache.org/licenses/LICENSE-2.0
+..
+.. Unless required by applicable law or agreed to in writing, software
+.. distributed under the License is distributed on an "AS IS" BASIS, WITHOUT
+.. WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the
+.. License for the specific language governing permissions and limitations under
+.. the License.
+
+.. highlight:: ini
+
+==========
+Resharding
+==========
+
+.. _config/reshard:
+
+Resharding Configuration
+========================
+
+.. config:section:: resharding :: Resharding Configuration
+
+    .. config:option:: max_jobs
+
+        Maximum number of resharding jobs per cluster node. This includes
+        completed, failed, and running jobs. If the job appears in the
+        _reshard/jobs HTTP API results it will be counted towards the limit.
+        When more than ``max_jobs`` jobs have been created, subsequent requests
+        will start to fail with the ``max_jobs_exceeded`` error::
+
+             [reshard]
+             max_jobs = 25
+
+    .. config:option:: max_retries
+
+        How many times to retry shard splitting steps if they fail. For
+        example, if indexing or topping off fails, it will be retried up to
+        these many times before the whole resharding job fails::
+
+             [reshard]
+             max_retries = 1
+
+    .. config:option:: retry_interval_sec
+
+        How to long to wait between subsequent retries::
 
 Review comment:
   ```suggestion
           How long to wait between subsequent retries::
   ```

----------------------------------------------------------------
This is an automated message from the Apache Git Service.
To respond to the message, please log on to GitHub and use the
URL above to go to the specific comment.
 
For queries about this service, please contact Infrastructure at:
users@infra.apache.org


With regards,
Apache Git Services