Skip to content

Commit 221f5c6

Browse files
authored
Backports #449 to v8.0 (#451)
Some pages ported changes from CM to OM but missed OM-specific nested components. This PR fixes those Backports #449
1 parent cc1da0e commit 221f5c6

17 files changed

+82
-132
lines changed

source/includes/api/list-tables/events/query-params/get-one.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -26,8 +26,5 @@ The following query parameters are optional:
2626
The ``raw`` document contains additional meta information about
2727
the event.
2828

29-
.. important::
30-
31-
The values in the ``raw`` document are subject to change. Do
32-
not rely on ``raw`` values for formal monitoring.
29+
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
3330
- ``false``

source/includes/api/list-tables/events/responses/orgs-cloud.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -140,10 +140,7 @@
140140
- Additional meta information about the event. This field only
141141
appears when the ``includeRaw`` query parameter is ``true``.
142142

143-
.. important::
144-
145-
The values in the ``raw`` document are subject to change. Do
146-
not rely on ``raw`` values for formal monitoring.
143+
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
147144

148145
* - remoteAddress
149146
- string

source/includes/api/list-tables/events/responses/orgs-onprem.rst

Lines changed: 2 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -56,9 +56,7 @@
5656
- string
5757
- Relevant units for the value.
5858

59-
.. example::
60-
61-
A metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.
59+
For example, a metric that measures memory consumption would have a byte measurement, while a metric that measures time would have a time unit.
6260

6361
Accepted values are:
6462

@@ -131,10 +129,7 @@
131129
- Additional meta information about the event. This field only
132130
appears when the ``includeRaw`` query parameter is ``true``.
133131

134-
.. important::
135-
136-
The values in the ``raw`` document are subject to change. Do
137-
not rely on ``raw`` values for formal monitoring.
132+
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
138133

139134
* - remoteAddress
140135
- string

source/includes/api/list-tables/events/responses/projects-cloud.rst

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -138,10 +138,7 @@
138138
- Additional meta information about the event. This field only
139139
appears when the ``includeRaw`` query parameter is ``true``.
140140

141-
.. important::
142-
143-
The values in the ``raw`` document are subject to change. Do
144-
not rely on ``raw`` values for formal monitoring.
141+
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
145142

146143
* - remoteAddress
147144
- string

source/includes/api/list-tables/events/responses/projects-onprem.rst

Lines changed: 7 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -56,11 +56,8 @@
5656
- string
5757
- Relevant units for the value.
5858

59-
.. example::
60-
61-
A metric that measures memory consumption would have a byte
62-
measurement, while a metric that measures time would have a
63-
time unit.
59+
For example, a metric that measures memory consumption would
60+
have a byte measurement, while a metric that measures time would have a time unit.
6461

6562
Accepted values are:
6663

@@ -76,12 +73,10 @@
7673
- array of objects
7774
- Changes made to the deployment during this event.
7875

79-
.. note::
80-
81-
|mms| returns different elements depending upon what was
82-
changed: user privileges or roles, restore jobs, automation
83-
modules, and so on. The list of this array and its objects is
84-
not exhaustive.
76+
|mms| returns different elements depending upon what was
77+
changed: user privileges or roles, restore jobs, automation
78+
modules, and so on. The list of this array and its objects is
79+
not exhaustive.
8580

8681
* - | diffs
8782
| .id
@@ -205,10 +200,7 @@
205200
- Additional meta information about the event. This field only
206201
appears when the ``includeRaw`` query parameter is ``true``.
207202

208-
.. important::
209-
210-
The values in the ``raw`` document are subject to change. Do
211-
not rely on ``raw`` values for formal monitoring.
203+
:gold:`IMPORTANT:` The values in the ``raw`` document are subject to change. Do not rely on ``raw`` values for formal monitoring.
212204

213205
* - remoteAddress
214206
- string

source/includes/api/list-tables/restore-job-request-documents.rst

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,11 +15,11 @@
1515
that represents the point in time to which your data will be
1616
restored.
1717

18-
.. note:: Conditions
18+
Conditions include:
1919

20-
- Set ``"delivery.methodName" : "AUTOMATED_RESTORE"``.
21-
- Can't set ``oplogInc``, ``oplogTs``, or
22-
``pointInTimeUTCMillis``.
20+
- Set ``"delivery.methodName" : "AUTOMATED_RESTORE"``.
21+
- Can't set ``oplogInc``, ``oplogTs``, or
22+
``pointInTimeUTCMillis``.
2323

2424
If you provide this setting, this endpoint restores all data up
2525
to this :opsmgr:`checkpoint </reference/glossary/#std-term-checkpoint>` to the database you

source/includes/api/list-tables/restore-jobs/response-elements/onprem/http.rst

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -100,13 +100,13 @@
100100
101101
"<authHeader>:<authBearer> <authValue>" <urlV2>
102102
103-
.. example::
103+
For example:
104104

105-
.. code-block:: sh
106-
:copyable: false
105+
.. code-block:: sh
106+
:copyable: false
107107
108-
curl -H "Authorization: Bearer {AUTH-TOKEN}" \
109-
https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}"
108+
curl -H "Authorization: Bearer {AUTH-TOKEN}" \
109+
https://{OPSMANAGER-HOST}:{PORT}/backup/restore/v3/pull/{restoreJobId}/{filename}"
110110
111111
* - ``groupId``
112112
- string

source/includes/api/list-tables/snapshot-schedule/requests-opsmgr.rst

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -28,10 +28,8 @@
2828
- Number of days to retain daily snapshots. You can set a value
2929
between ``1`` and ``365``, inclusive.
3030

31-
.. note::
32-
33-
Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
34-
rule.
31+
Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
32+
rule.
3533

3634
* - ``fullIncrementalDayOfWeek``
3735
- string
@@ -57,9 +55,7 @@
5755
- Number of months to retain monthly snapshots. You can set a
5856
value between ``1`` and ``36``, inclusive.
5957

60-
.. note::
61-
62-
Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this rule.
58+
Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this rule.
6359

6460
* - ``pointInTimeWindowHours``
6561
- number
@@ -91,12 +87,10 @@
9187
``+0000`` before storing it, and adjusts the
9288
``referenceHourOfDay`` value accordingly.
9389

94-
.. example::
95-
96-
You pass in a request with a ``referenceHourOfDay`` of ``5``
97-
and a ``referenceTimeZoneOffset`` of ``"+0200". |onprem|
98-
stores a ``referenceHourOfDay`` of ``3`` and a
99-
``referenceTimeZoneOffset`` of ``"+0000"``.
90+
For example, you pass in a request with a ``referenceHourOfDay``
91+
of ``5`` and a ``referenceTimeZoneOffset`` of ``"+0200". |onprem|
92+
stores a ``referenceHourOfDay`` of ``3`` and a
93+
``referenceTimeZoneOffset`` of ``"+0000"``.
10094

10195
* - ``snapshotIntervalHours``
10296
- number

source/includes/api/list-tables/snapshot-schedule/responses-opsmgr.rst

Lines changed: 7 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -24,10 +24,8 @@
2424
- Number of days to retain daily snapshots. |mms| may return
2525
values between ``1`` and ``365``, inclusive.
2626

27-
.. note::
28-
29-
Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
30-
rule.
27+
Setting ``dailySnapshotRetentionDays`` to ``0`` disables this
28+
rule.
3129

3230
* - ``fullIncrementalDayOfWeek``
3331
- string
@@ -49,9 +47,7 @@
4947
- Number of months to retain monthly snapshots. |mms| may return
5048
values between ``1`` and ``36``, inclusive.
5149

52-
.. note::
53-
54-
Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this rule.
50+
Setting ``monthlySnapshotRetentionMonths`` to ``0`` disables this rule.
5551

5652
* - ``pointInTimeWindowHours``
5753
- number
@@ -79,12 +75,10 @@
7975
``+0000`` before storing it, and adjusts the
8076
``referenceHourOfDay`` value accordingly.
8177

82-
.. example::
83-
84-
You pass in a request with a ``referenceHourOfDay`` of ``5``
85-
and a ``referenceTimeZoneOffset`` of ``"+0200". |onprem|
86-
stores a ``referenceHourOfDay`` of ``3`` and a
87-
``referenceTimeZoneOffset`` of ``"+0000"``.
78+
For example, you pass in a request with a ``referenceHourOfDay``
79+
of ``5`` and a ``referenceTimeZoneOffset`` of ``"+0200". |onprem|
80+
stores a ``referenceHourOfDay`` of ``3`` and a
81+
``referenceTimeZoneOffset`` of ``"+0000"``.
8882

8983
* - ``snapshotIntervalHours``
9084
- number

source/includes/extracts-alerts.yaml

Lines changed: 23 additions & 23 deletions
Original file line numberDiff line numberDiff line change
@@ -17,16 +17,17 @@ content: |
1717
:stub-columns: 1
1818
1919
* - {+bagent+} has too many conf call failures
20-
- The cluster topology known to monitoring does not match the backup
21-
configuration from :term:`conf calls <conf call>` the {+bagent+}
22-
makes.
20+
21+
- The cluster topology known to monitoring does not match the
22+
backup configuration from :term:`conf calls <conf call>` the {+bagent+} makes.
2323
2424
The number of attempts meets the threshold you specified in
2525
:setting:`maximumFailedConfCalls
2626
<mms.alerts.BackupAgentConfCallFailure.maximumFailedConfCalls>`
2727
setting.
2828
29-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
29+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
30+
3031
3132
---
3233
ref: alert-global-alerts
@@ -40,25 +41,23 @@ content: |
4041
4142
- A backup job fails to bind to a Backup Daemon.
4243
43-
.. example::
44+
For example, reasons that a job might fail to bind include, but are not limited to:
4445
45-
Reasons that a job might fail to bind include, but are not
46-
limited to:
47-
48-
- No :manual:`primary </reference/glossary/#std-term-primary>` is found for the backed-up replica
49-
set. At the time the binding occurred, the {+magent+} did not detect a primary. Ensure that the replica
50-
set is healthy.
46+
- No :manual:`primary </reference/glossary/#std-term-primary>`
47+
is found for the backed-up replica
48+
set. At the time the binding occurred, the {+magent+} did not detect a primary. Ensure that the replica
49+
set is healthy.
5150
52-
- Not enough space is available on any Backup Daemon.
51+
- Not enough space is available on any Backup Daemon.
5352
54-
In both cases, resolve the issue and then :doc:`restart the
55-
initial sync of the backup </tutorial/enable-backup>`.
53+
In both cases, resolve the issue and then :doc:`restart the
54+
initial sync of the backup </tutorial/enable-backup>`.
5655
57-
As an alternative, you can manually bind jobs to daemons
58-
through the :guilabel:`Admin` interface. See
59-
:ref:`jobs-page` for more information.
56+
As an alternative, you can manually bind jobs to daemons
57+
through the :guilabel:`Admin` interface. See
58+
:ref:`jobs-page` for more information.
6059
61-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
60+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
6261
6362
* - Backup has reached a high number of retries
6463
@@ -70,7 +69,7 @@ content: |
7069
Contact MongoDB Support if you need help interpreting the
7170
error message.
7271
73-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
72+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
7473
7574
* - Backup is in an unexpected state
7675
@@ -84,15 +83,15 @@ content: |
8483
error message explaining the problem. Contact MongoDB Support
8584
if you need help interpreting the error message.
8685
87-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
86+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
8887
8988
* - Replica set has a late snapshot
9089
9190
- A snapshot has failed to complete before the next snapshot is
9291
scheduled to begin. :ref:`Check the job log <jobs-page>` in
9392
the |mms| Admin interface for any errors.
9493
95-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
94+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
9695
9796
* - Sync slice transfer has not progressed in...
9897
@@ -104,7 +103,7 @@ content: |
104103
- network issues
105104
- incorrect authentication credentials
106105
107-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
106+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
108107
109108
* - Backup job is busy for...
110109
@@ -122,7 +121,7 @@ content: |
122121
for error messages. Contact MongoDB Support if you need help
123122
interpreting the error message.
124123
125-
.. note:: :doc:`Global alert </tutorial/manage-global-alerts>` only
124+
You can use this alert as a :ref:`global alert <mms-manage-global-alerts>` only.
126125
127126
---
128127

@@ -134,6 +133,7 @@ content: |
134133
:stub-columns: 1
135134
136135
* - Host is down
136+
137137
- |mms| does not receive a ping from a host for more than 4
138138
minutes. Under normal operation, the {+magent+} connects
139139
to each monitored host about once per minute. |mms| waits 4

0 commit comments

Comments
 (0)