summaryrefslogtreecommitdiffstats
path: root/doc/cephfs/snap-schedule.rst
diff options
context:
space:
mode:
authorMilind Changire <mchangir@redhat.com>2023-08-24 04:19:43 +0200
committerMilind Changire <mchangir@redhat.com>2023-09-12 10:41:03 +0200
commit7431b813a52a80fccf60cf14234d38b61907ecaf (patch)
tree29f113d6b78c63b77b3c9849f631e273bfe3c2d2 /doc/cephfs/snap-schedule.rst
parentqa: update minute period multiplier to m (diff)
downloadceph-7431b813a52a80fccf60cf14234d38b61907ecaf.tar.xz
ceph-7431b813a52a80fccf60cf14234d38b61907ecaf.zip
doc/cephfs: add note about monthly scheduling and retention period
Fixes: https://tracker.ceph.com/issues/62494 Signed-off-by: Milind Changire <mchangir@redhat.com>
Diffstat (limited to 'doc/cephfs/snap-schedule.rst')
-rw-r--r--doc/cephfs/snap-schedule.rst10
1 files changed, 5 insertions, 5 deletions
diff --git a/doc/cephfs/snap-schedule.rst b/doc/cephfs/snap-schedule.rst
index 2b887369979..ef746be2359 100644
--- a/doc/cephfs/snap-schedule.rst
+++ b/doc/cephfs/snap-schedule.rst
@@ -30,9 +30,9 @@ assumed to be keyword arguments too.
Snapshot schedules are identified by path, their repeat interval and their start
time. The
repeat interval defines the time between two subsequent snapshots. It is
-specified by a number and a period multiplier, one of `h(our)`, `d(ay)` and
-`w(eek)`. E.g. a repeat interval of `12h` specifies one snapshot every 12
-hours.
+specified by a number and a period multiplier, one of `h(our)`, `d(ay)`,
+`w(eek)`, `M(onth)` and `Y(ear)`. E.g. a repeat interval of `12h` specifies one
+snapshot every 12 hours.
The start time is specified as a time string (more details about passing times
below). By default
the start time is last midnight. So when a snapshot schedule with repeat
@@ -52,8 +52,8 @@ space or concatenated pairs of `<number><time period>`.
The semantics are that a spec will ensure `<number>` snapshots are kept that are
at least `<time period>` apart. For Example `7d` means the user wants to keep 7
snapshots that are at least one day (but potentially longer) apart from each other.
-The following time periods are recognized: `h(our), d(ay), w(eek), m(onth),
-y(ear)` and `n`. The latter is a special modifier where e.g. `10n` means keep
+The following time periods are recognized: `h(our)`, `d(ay)`, `w(eek)`, `M(onth)`,
+`Y(ear)` and `n`. The latter is a special modifier where e.g. `10n` means keep
the last 10 snapshots regardless of timing,
All subcommands take optional `fs` argument to specify paths in