From 288c000c2b4261cc1a5ea7e77e06bcbd88bc7554 Mon Sep 17 00:00:00 2001 From: Milind Changire Date: Tue, 29 Nov 2022 13:36:17 +0530 Subject: [PATCH] doc/cephfs: add note about path usage in snap-schedule Signed-off-by: Milind Changire (cherry picked from commit f4be802e8e3db0b72a273d6da3efbce76c2ae198) --- doc/cephfs/snap-schedule.rst | 13 +++++++++++++ 1 file changed, 13 insertions(+) diff --git a/doc/cephfs/snap-schedule.rst b/doc/cephfs/snap-schedule.rst index 2728203f49c5..fb9c85b5a44c 100644 --- a/doc/cephfs/snap-schedule.rst +++ b/doc/cephfs/snap-schedule.rst @@ -142,6 +142,19 @@ Examples:: ceph fs snap-schedule retention add / 24h4w # add 24 hourly and 4 weekly to retention ceph fs snap-schedule retention remove / 7d4w # remove 7 daily and 4 weekly, leaves 24 hourly +.. note: When adding a path to snap-schedule, remember to strip off the mount + point path prefix. Paths to snap-schedule should start at the appropriate + CephFS file system root and not at the host file system root. + e.g. if the Ceph File System is mounted at ``/mnt`` and the path under which + snapshots need to be taken is ``/mnt/some/path`` then the acutal path required + by snap-schedule is only ``/some/path``. + +.. note: It should be noted that the "created" field in the snap-schedule status + command output is the timestamp at which the schedule was created. The "created" + timestamp has nothing to do with the creation of actual snapshots. The actual + snapshot creation is accounted for in the "created_count" field, which is a + cumulative count of the total number of snapshots created so far. + Active and inactive schedules ----------------------------- Snapshot schedules can be added for a path that doesn't exist yet in the -- 2.47.3