Skip to content

Commit a35e37c

Browse files
authored
(DOCSP-30191) Clarify the time for scheduling snapshots (#218)
Merging.
1 parent 551af0b commit a35e37c

File tree

4 files changed

+37
-31
lines changed

4 files changed

+37
-31
lines changed

source/includes/list-tables/backup/edit-snapshot.rst

Lines changed: 31 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -48,30 +48,39 @@
4848
* - Allow point-in-time restores going back
4949

5050
- Sets the number of days that |mms| retains oplogs alongside
51-
snapshots.
52-
53-
.. seealso::
54-
55-
To learn how snapshots and point-in-time restores work,
56-
see :doc:`/tutorial/nav/restore-overview`.
51+
snapshots. To learn how snapshots and point-in-time restores work,
52+
see :ref:`restore-overview`.
5753

5854
* - Reference Time of Day (UTC)
5955

6056
- Sets the time of day at
6157
`UTC <https://www.timeanddate.com/time/aboututc.html>`_ from
62-
which the snapshot schedule starts. When you change the
63-
:guilabel:`Reference Time of Day`, snapshots that are in
64-
progress remain unaffected. Only snapshots taken after you
65-
change the reference time follow the updated schedule.
66-
67-
.. note::
68-
69-
Changing the reference time changes the time of the next scheduled snapshot.
70-
You can't make the next scheduled snapshot happen sooner than the current
71-
next snapshot time. The current next snapshot time is the current reference
72-
time plus the interval between snapshots.
73-
74-
.. seealso::
75-
76-
To review more examples, see
77-
:ref:`Snapshot Frequency and Retention <snapshot-frequency-and-retention>`.
58+
which the snapshot schedule starts. When you change the value in
59+
:guilabel:`Reference Time of Day`, snapshots that are in progress
60+
or that are already scheduled remain unaffected. Only snapshots
61+
taken after you change the reference time follow the updated schedule.
62+
63+
The following statements describe how |mms| behaves in relation
64+
to the value you specify in :guilabel:`Reference Time of Day`:
65+
66+
- This value acts as a timer that |mms| uses for scheduling and then
67+
taking the next snapshot. This value isn't the same as the time
68+
when |mms| takes the next snapshot, but it is close to it. This
69+
value differs from the actual time that |mms| uses to take a
70+
snapshot by a small interval. You can't control this interval.
71+
- If you leave this value blank, |mms| interprets it as ``null``,
72+
starts the timer for scheduling the next snapshot, and then takes
73+
the next snapshot after a short interval from the time when it
74+
took the previous snapshot.
75+
76+
- If you change the time value in this field, |mms| uses the new
77+
time value as the starting time for scheduling the snapshot that
78+
will occur *after the currently scheduled snapshot*.
79+
In other words, for each snapshot that is already scheduled, |mms| uses
80+
the time it already established: either based on the ``null`` value
81+
plus a short interval, or based on the custom reference time value
82+
plus a short interval. If you change the reference time value in
83+
this field, the next scheduled snapshot will not happen sooner
84+
than the snapshot that is already scheduled.
85+
86+
To review examples, see :ref:`Snapshot Frequency and Retention <snapshot-frequency-and-retention>`.

source/includes/steps-edit-backup-snapshot-schedule.yaml

Lines changed: 1 addition & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -14,11 +14,7 @@ level: 4
1414
ref: configure-snapshot-schedule
1515
content: |
1616
a. Enter the following information as needed.
17-
18-
.. seealso::
19-
20-
To learn about retention values, see
21-
:ref:`snapshot-frequency-and-retention`.
17+
To learn about retention values, see :ref:`snapshot-frequency-and-retention`.
2218
2319
.. include:: /includes/list-tables/backup/edit-snapshot.rst
2420

source/reference/monitoring.txt

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -6,11 +6,10 @@ Database Commands Used by {+magent+}
66

77
.. default-domain:: mongodb
88

9-
The {+magent+} uses a set of MongoDB diagnostic, administrative, and
10-
other :manual:`database commands </reference/command>` to report on the status
11-
of your MongoDB deployment. The agent uses these commands:
9+
The {+magent+} uses a set of the following MongoDB diagnostic, administrative,
10+
and other :manual:`database commands </reference/command>` to report on
11+
the status of your MongoDB deployment.
1212

13-
- :dbcommand:`_isSelf`
1413
- :dbcommand:`buildInfo`
1514

1615
- :dbcommand:`collStats` on the following :manual:`local database

source/tutorial/nav/restore-overview.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,5 @@
1+
.. _restore-overview:
2+
13
================
24
Restore Overview
35
================

0 commit comments

Comments
 (0)