From: Venky Shankar <vshankar@redhat.com>
Date: Mon, 19 Apr 2021 10:12:21 +0000 (+0530)
Subject: doc: document cephfs-mirror configuration options
X-Git-Tag: v16.2.5~85^2~14
X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=fac870a5269e241a036e482d3ff69c34a533ae1d;p=ceph.git

doc: document cephfs-mirror configuration options

NOTE: Docs in pacific *do not* use confval directive. So,
brute force document cephfs-mirror options.

Fixes: http://tracker.ceph.com/issues/50035
Signed-off-by: Venky Shankar <vshankar@redhat.com>
(cherry picked from commit ffeb048006408215dab9cdb34a89a56e7fe286bc)
---

diff --git a/doc/cephfs/cephfs-mirroring.rst b/doc/cephfs/cephfs-mirroring.rst
index cb3bac18659..0b0d7bdd6df 100644
--- a/doc/cephfs/cephfs-mirroring.rst
+++ b/doc/cephfs/cephfs-mirroring.rst
@@ -301,6 +301,72 @@ synchronization.
 When mirroring is disabled, the respective `fs mirror status` command for the file system
 will not show up in command help.
 
+Configuration Options
+---------------------
+
+``cephfs_mirror_max_concurrent_directory_syncs``
+
+:Description: Maximum number of directory snapshots that can be synchronized concurrently by
+              cephfs-mirror daemon. Controls the number of synchronization threads.
+:Type:  64-bit Integer Unsigned
+:Default: ``3``
+
+``cephfs_mirror_action_update_interval``
+
+:Description: Interval in seconds to process pending mirror update actions.
+:Type:  Float
+:Default: ``2``
+
+``cephfs_mirror_restart_mirror_on_blocklist_interval``
+
+:Description: Interval in seconds to restart blocklisted mirror instances. Setting to zero (0)
+              disables restarting blocklisted instances.
+:Type:  Float
+:Default: ``30``
+
+``cephfs_mirror_max_snapshot_sync_per_cycle``
+
+:Description: Maximum number of snapshots to mirror when a directory is picked up for mirroring
+              by worker threads.
+:Type:  64-bit Integer Unsigned
+:Default: ``3``
+
+``cephfs_mirror_directory_scan_interval``
+
+:Description: Interval in seconds to scan configured directories for snapshot mirroring.
+:Type:  64-bit Integer Unsigned
+:Default: ``10``
+
+``cephfs_mirror_max_consecutive_failures_per_directory``
+
+:Description: Number of consecutive snapshot synchronization failues to mark a directory as
+              "failed". Failed directories are retried for synchronization less frequently.
+:Type:  64-bit Integer Unsigned
+:Default: ``10``
+
+``cephfs_mirror_retry_failed_directories_interval``
+
+:Description: Interval in seconds to retry synchronization for failed directories.
+:Type:  64-bit Integer Unsigned
+:Default: ``60``
+
+``cephfs_mirror_restart_mirror_on_failure_interval``
+
+:Description: Interval in seconds to restart failed mirror instances. Setting to zero (0)
+              disables restarting failed mirror instances.
+:Type:  Float
+:Default: ``20``
+
+``cephfs_mirror_mount_timeout``
+
+:Description: Timeout in seconds for mounting primary or secondary (remote) ceph file system
+              by the cephfs-mirror daemon. Setting this to a higher value could result in the
+              mirror daemon getting stalled when mounting a file system if the cluster is not
+              reachable. This option is used to override the usual client_mount_timeout.
+:Type:  Float
+:Default: ``10``
+
+
 Re-adding Peers
 ---------------