[lucene-solr] branch branch_8x updated: Ref Guide: clarify backup location requirements for SolrCloud backups

[ct...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

ctargett pushed a commit to branch branch_8x
in repository https://gitbox.apache.org/repos/asf/lucene-solr.git


The following commit(s) were added to refs/heads/branch_8x by this push:
     new c245392  Ref Guide: clarify backup location requirements for SolrCloud backups
c245392 is described below

commit c2453921d7390b3c4d8b5042b7d42e9bf4b0ac00
Author: Cassandra Targett <ct...@apache.org>
AuthorDate: Mon Jan 11 14:36:14 2021 -0600

    Ref Guide: clarify backup location requirements for SolrCloud backups
---
 solr/solr-ref-guide/src/collection-management.adoc        | 5 ++++-
 solr/solr-ref-guide/src/making-and-restoring-backups.adoc | 6 ++++--
 2 files changed, 8 insertions(+), 3 deletions(-)

diff --git a/solr/solr-ref-guide/src/collection-management.adoc b/solr/solr-ref-guide/src/collection-management.adoc
index 20aa515..a626345 100644
--- a/solr/solr-ref-guide/src/collection-management.adoc
+++ b/solr/solr-ref-guide/src/collection-management.adoc
@@ -1250,6 +1250,9 @@ What to name the backup that is created.  This is checked to make sure it doesn'
 
 `location`::
 The location on a shared drive for the backup command to write to. Alternately it can be set as a <<cluster-node-management.adoc#clusterprop,cluster property>>.
++
+If the location path is on a mounted drive, the mount must be available on the node that serves as the overseer, even if the overseer node does not host a replica of the collection being backed up.
+Since any node can take the overseer role at any time, a best practice to avoid possible backup failures is to ensure the mount point is available on all nodes of the cluster.
 
 `async`::
 Request ID to track this action which will be <<collections-api.adoc#asynchronous-calls,processed asynchronously>>.
@@ -1289,7 +1292,7 @@ Request ID to track this action which will be <<collections-api.adoc#asynchronou
 `repository`::
 The name of a repository to be used for the backup. If no repository is specified then the local filesystem repository will be used automatically.
 
-There's a number of optional parameters that determine the target collection layout.
+There are also optional parameters that determine the target collection layout.
 The following parameters are currently supported (described in detail in the <<create,CREATE collection>> section):
 `createNodeSet`, `createNodeSet.shuffle`.
 
diff --git a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
index b39a6af..9c4e7fb 100644
--- a/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
+++ b/solr/solr-ref-guide/src/making-and-restoring-backups.adoc
@@ -62,7 +62,9 @@ The backup request can also take the following additional parameters:
 
 `location`::
 The path where the backup will be created. If the path is not absolute then the backup path will be relative to Solr's instance directory.
-|name |The snapshot will be created in a directory called `snapshot.<name>`. If a name is not specified then the directory name would have the following format: `snapshot.<yyyyMMddHHmmssSSS>`.
+
+`name`::
+The snapshot will be created in a directory called `snapshot.<name>`. If a name is not specified then the directory name will have the following format: `snapshot.<yyyyMMddHHmmssSSS>`.
 
 `numberToKeep`::
 The number of backups to keep. If `maxNumberOfBackups` has been specified on the replication handler in `solrconfig.xml`, `maxNumberOfBackups` is always used and attempts to use `numberToKeep` will cause an error. Also, this parameter is not taken into consideration if the backup name is specified. More information about `maxNumberOfBackups` can be found in the section <<index-replication.adoc#configuring-the-replicationhandler,Configuring the ReplicationHandler>>.
@@ -117,7 +119,7 @@ The `restore` request can take these additional parameters:
 The location of the backup snapshot file. If not specified, it looks for backups in Solr's data directory.
 
 `name`::
-The name of the backed up index snapshot to be restored. If the name is not provided it looks for backups with `snapshot.<timestamp>` format in the location directory. It picks the latest timestamp backup in that case.
+The name of the backup index snapshot to be restored. If the name is not provided it looks for backups with `snapshot.<timestamp>` format in the location directory. It picks the latest timestamp backup in that case.
 
 `repository`::
 The name of the repository to be used for the backup. If no repository is specified then the local filesystem repository will be used automatically.