From b099303dbd5063f1b53dd4d10f12c56842156574 Mon Sep 17 00:00:00 2001 From: Jos Collin Date: Mon, 17 Feb 2025 17:08:57 +0530 Subject: [PATCH] doc: update --sync-latest-snapshot and --sync_from_snapshot options Fixes: https://tracker.ceph.com/issues/69966 Fixes: https://tracker.ceph.com/issues/69187 Fixes: https://tracker.ceph.com/issues/69188 Signed-off-by: Jos Collin --- doc/cephfs/cephfs-mirroring.rst | 13 ++++++++++++- doc/dev/cephfs-mirroring.rst | 13 ++++++++++++- 2 files changed, 24 insertions(+), 2 deletions(-) diff --git a/doc/cephfs/cephfs-mirroring.rst b/doc/cephfs/cephfs-mirroring.rst index 509ff4d8f38..13ad06f2fe6 100644 --- a/doc/cephfs/cephfs-mirroring.rst +++ b/doc/cephfs/cephfs-mirroring.rst @@ -192,7 +192,7 @@ To configure a directory for mirroring, run a command of the following form: .. prompt:: bash $ - ceph fs snapshot mirror add + ceph fs snapshot mirror add [--sync_from_snapshot ] [<--sync-latest-snapshot>] To list the configured directories, run a command of the following form: @@ -232,6 +232,17 @@ The :ref:`Mirroring Status` section contains information about the commands for checking the directory mapping (to mirror daemons) and for checking the directory distribution. +Adding a directory starts mirroring of the already existing snapshots of a directory, +starting from the first (by default) and follows the order of snapshot creation. +``--sync_from_snapshot`` option is used to start mirroring from a specified snapshot. + +``--sync-latest-snapshot`` option picks only the latest snapshots for syncing. +When numerous snapshots are created at once, it picks only the last snapshot for syncing. +This option is useful when mirroring each snapshot would take several hours to finish and the user +has taken new snapshots in the mean time, which are unimportant. So when the current snapshot sync is +finished, the mirror daemon picks the then latest snapshot for syncing. Thus only the latest snapshots +are being mirrored. + .. _cephfs_mirroring_bootstrap_peers: Bootstrap Peers diff --git a/doc/dev/cephfs-mirroring.rst b/doc/dev/cephfs-mirroring.rst index 9fe072967f3..89d1866b229 100644 --- a/doc/dev/cephfs-mirroring.rst +++ b/doc/dev/cephfs-mirroring.rst @@ -192,7 +192,7 @@ To configure a directory for mirroring, run a command of the following form: .. prompt:: bash $ - ceph fs snapshot mirror add + ceph fs snapshot mirror add [--sync_from_snapshot ] [<--sync-latest-snapshot>] To stop a directory from mirroring snapshots, run a command of the following form: @@ -236,6 +236,17 @@ directories are not allowed to be added for mirroring: Commands for checking directory mapping (to mirror daemons) and directory distribution are detailed in the `Mirror Daemon Status` section. +Adding a directory starts mirroring of the already existing snapshots of a directory, +starting from the first snapshot (by default) and follows the order of snapshot creation. +``--sync_from_snapshot`` option is used to start mirroring from a specified snapshot. + +``--sync-latest-snapshot`` option picks only the latest snapshots for syncing. +When numerous snapshots are created at once, it picks only the last snapshot for syncing. +This option is useful when each snapshot mirroring would take several hours to finish and the user +has taken snapshots in the mean time, which are unimportant. So when the current snapshot sync is +finished, the mirror daemon picks the then latest snapshot for syncing. Thus only the latest snapshots +are being mirrored. + Bootstrap Peers --------------- -- 2.47.3