From: Milind Changire Date: Tue, 29 Nov 2022 08:06:17 +0000 (+0530) Subject: doc/cephfs: add note about path usage in snap-schedule X-Git-Tag: v18.1.0~38^2~1 X-Git-Url: http://git-server-git.apps.pok.os.sepia.ceph.com/?a=commitdiff_plain;h=9cabf1344fac806bded7556dac7345041e8b80b7;p=ceph.git doc/cephfs: add note about path usage in snap-schedule Signed-off-by: Milind Changire (cherry picked from commit f4be802e8e3db0b72a273d6da3efbce76c2ae198) --- diff --git a/doc/cephfs/snap-schedule.rst b/doc/cephfs/snap-schedule.rst index ffde505533b..74e2e2fd96b 100644 --- a/doc/cephfs/snap-schedule.rst +++ b/doc/cephfs/snap-schedule.rst @@ -149,6 +149,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