Skip to content

Commit 57be180

Browse files
authored
(DOCSP-43830) [OM] Backport DOCSP-43010 to v7.0 (#384)
## Backport [DOCSP-43010](https://jira.mongodb.org/browse/DOCSP-43010) to v7.0 [This spreadsheet](https://docs.google.com/spreadsheets/d/1M2IlsyV0-6mY-AvBBrX-4uSDtQrbt9zuoXsqIJaVqlk/edit?gid=0#gid=0) tracks the number of nested components on each page, and [this doc](https://docs.google.com/document/d/1yMbng-EPOQ82bAzBTC2VJwIvsUBOSCJh21cGbDoe1a8/edit#heading=h.7hxlffls9cx6) provides guidelines for fixing nested components. ## [DOCSP-43830](https://jira.mongodb.org/browse/DOCSP-43830) ## STAGING 1. [docs/ops-manager/current/admin/backup/daemons-page/ ](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/admin/backup/daemons-page/)— Unnested 2 notes and 1 example in table. Note: another nested note was in the document under delete-daemon but was not present in the active page. Unnested this, too. 2. [docs/ops-manager/current/admin/backup/groom-priority-page/](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/admin/backup/groom-priority-page/) — Unnested 1 tip in table 3. [docs/ops-manager/current/admin/backup/jobs-page/](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/admin/backup/jobs-page/) — Unnested 3 notes and 1 warning in tables. Converted part of 1 note into a bulleted list. 4. [docs/ops-manager/current/admin/backup/restores-page/ ](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/admin/backup/restores-page/)— No changes, left 1 ``important`` admonition in table. 5. 5. [docs/ops-manager/current/admin/general/global-access-list-page/](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/admin/general/global-access-list-page/) — Unnested 2 notes in table 6. [docs/ops-manager/current/core/backup-overview/](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/core/backup-overview/) — Unnested 2 ``warning`` admonitions in tables. 7. [docs/ops-manager/current/core/requirements/](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/core/requirements/) — No changes, left 1 ``important`` admonition 8. [docs/ops-manager/current/core/system-alerts/](https://deploy-preview-374--10gen-docs-ops-manager.netlify.app/core/system-alerts/) — Couldn't find the reported 1 nested admonition in table. But did notice incorrect include in table, where the correct include contains a note. Will address in [DOCSP-43763](https://jira.mongodb.org/browse/DOCSP-43763). - [ ] [Define](https://wiki.corp.mongodb.com/display/DE/Taxonomy+tagging+instructions) taxonomy [values](https://wiki.corp.mongodb.com/display/DE/Docs+Taxonomy) at top of page. - [ ] Add genre facets (tutorial or reference), as in this [example PR](10gen/cloud-docs#5042). - [ ] Add programmingLanguage (if necessary). - [ ] Add meta keywords (if necessary). - [ ] Resolve any new warnings or errors in the build. - [x] Proofread for spelling and grammatical errors. - [x] Check staging for rendering issues. - [x] Confirm links are working.
1 parent 3f59b40 commit 57be180

9 files changed

+49
-66
lines changed

source/admin/backup/daemons-page.txt

Lines changed: 6 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -60,6 +60,9 @@ configure daemons:
6060
* - Delete Daemon
6161
- Click this link to delete the Backup Daemon.
6262

63+
You must restart the daemon to reconfigure the daemon after
64+
deletion.
65+
6366
* - Assignment
6467
- Select this to allow the daemon to process more jobs. If the
6568
daemon's disk fills, clear this so the host is not overloaded.
@@ -71,11 +74,9 @@ configure daemons:
7174
* - Queryable Restore Jobs
7275
- Select this to allow the daemon to process :opsmgr:`queryable backups </reference/glossary/#std-term-queryable-backup>`.
7376

74-
.. note::
75-
76-
For the fastest possible restore time, configure a dedicated queryable restore
77-
daemon by selecting :guilabel:`Queryable Restore Jobs` and clearing the checkboxes
78-
for the other daemon roles, for example, :guilabel:`Garbage Collection` and :guilabel:`Resource Usage`.
77+
For the fastest possible restore time, configure a dedicated queryable restore
78+
daemon by selecting :guilabel:`Queryable Restore Jobs` and clearing the checkboxes
79+
for the other daemon roles, for example, :guilabel:`Garbage Collection` and :guilabel:`Resource Usage`.
7980

8081
* - Resource Usage
8182
- Select this to collect data for this daemon. This includes the

source/admin/backup/groom-priority-page.txt

Lines changed: 1 addition & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -38,10 +38,7 @@ their blockstores. |onprem| maintains a blockstore using three jobs:
3838
- Runs when the percentage of living block bytes drops
3939
to drops below a given threshold.
4040

41-
.. seealso::
42-
43-
To learn more about grooming, see
44-
:ref:`Groom page <grooms-page>`
41+
To learn more, see :ref:`Grooms <grooms-page>`.
4542

4643
* - Integrity Check
4744
- Verify that the blockstore has no data integrity issues.

source/admin/backup/job-timeline-page.txt

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,9 @@ page. The :guilabel:`Job Timeline` page displays critical timestamps
1818
(:opsmgr:`head </reference/glossary/#std-term-head-database>`, last snapshot, next snapshot) and
1919
offers a way to assign a :opsmgr:`daemon </reference/glossary/#std-term-Backup-Daemon>` to a given job.
2020

21-
.. include:: /includes/head-database-backup-deprecated.rst
21+
.. note::
22+
23+
.. include:: /includes/head-database-backup-deprecated.rst
2224

2325
Click the :guilabel:`Auto refresh` checkbox to update the list
2426
automatically every 10 seconds. Click the :guilabel:`Refresh` button

source/admin/backup/jobs-page.txt

Lines changed: 19 additions & 24 deletions
Original file line numberDiff line numberDiff line change
@@ -83,10 +83,8 @@ From the :guilabel:`Jobs` page, you can do the following:
8383
- Select or clear :guilabel:`Journal Head` to turn on or off
8484
journaling for your head database.
8585

86-
.. note::
87-
88-
Changing this setting at the job level overrides the
89-
deployment-wide setting.
86+
Changing this setting at the job level overrides the
87+
deployment-wide setting.
9088

9189
See :setting:`mms.backup.journal.heads` for how to enable or
9290
disable journaling for all head databases in your project.
@@ -145,27 +143,24 @@ procedural information, see
145143
field.
146144

147145
4. Click :guilabel:`Save Changes`.
148-
149-
.. warning::
150-
151-
After you change the labels applied to this backup job,
152-
:ref:`stop and then restart backups <restart-backup>` for this
153-
deployment. Once Backup restarts, |onprem| changes the
154-
:opsmgr:`oplog store </reference/glossary/#std-term-Oplog-Store-Database>` assigned to this
155-
Backup job. The oplog store matches the job's assigned
156-
labels to an oplog store with the same
157-
:ref:`assigned labels <edit-oplogstore>`. This change halts
158-
new and removes existing
159-
:opsmgr:`point-in-time restores </reference/glossary/#std-term-point-in-time-restore>` until
160-
|onprem| takes the next snapshot after reassigning the oplog
161-
store.
162-
163-
.. note::
164146

165-
Some label changes do not require stopping and restarting backups.
166-
Changes that only affect Oplogs only require stoping and restarting running jobs.
167-
Changes that only affect Daemons only need a :doc:`move head </tutorial/move-jobs-to-new-backup-daemon>` to move the existing data.
168-
Changes that only affect blockstores only need an :ref:`inter groom job <inter-blockstore-groom-job>`.
147+
Some label changes do not require stopping and restarting backups:
148+
149+
- Changes that only affect Oplogs only require stopping and restarting running jobs.
150+
- Changes that only affect Daemons only need a :doc:`move head </tutorial/move-jobs-to-new-backup-daemon>` to move the existing data.
151+
- Changes that only affect blockstores only need an :ref:`inter groom job <inter-blockstore-groom-job>`.
152+
153+
:red:`WARNING:` After you change the labels applied to this backup job,
154+
:ref:`stop and then restart backups <restart-backup>` for this
155+
deployment. Once Backup restarts, |onprem| changes the
156+
:opsmgr:`oplog store </reference/glossary/#std-term-Oplog-Store-Database>` assigned to this
157+
Backup job. The oplog store matches the job's assigned
158+
labels to an oplog store with the same
159+
:ref:`assigned labels <edit-oplogstore>`. This change halts
160+
new and removes existing
161+
:opsmgr:`point-in-time restores </reference/glossary/#std-term-point-in-time-restore>` until
162+
|onprem| takes the next snapshot after reassigning the oplog
163+
store.
169164

170165
* - :ref:`Configure a project to use KMIP <configure-group-kmip>`.
171166
- Specify the |kmip| fields and click :guilabel:`Save Changes`.

source/admin/general/global-access-list-page.txt

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -42,11 +42,9 @@ Add an Access List Entry
4242
- Type the |ipv4| address, |ipv6| address, or |cidr| block that
4343
you want to allow to use the |onprem| |api|.
4444

45-
.. note::
46-
47-
You can click :guilabel:`Use Current IP Address` to add
48-
the public IP address of the host you are using to access
49-
|onprem|.
45+
You can click :guilabel:`Use Current IP Address` to add
46+
the public IP address of the host you are using to access
47+
|onprem|.
5048

5149
* - Description
5250
- Type the purpose this IP address serves.
@@ -80,12 +78,10 @@ Edit an Access List Entry
8078
* - Access List Entry
8179
- Type the |ipv4| address, |ipv6| address, or |cidr| block
8280
that you want to allow to use the |onprem| |api|.
83-
84-
.. note::
8581

86-
You can click :guilabel:`Use Current IP Address` to add
87-
the public IP address of the host you are using to access
88-
|onprem|.
82+
You can click :guilabel:`Use Current IP Address` to add
83+
the public IP address of the host you are using to access
84+
|onprem|.
8985

9086
* - Description
9187
- Type the purpose this IP address serves.

source/includes/backup/legacy-process-change-op-state.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,9 +32,7 @@
3232

3333
- Click :guilabel:`Terminate`.
3434

35-
.. warning::
36-
37-
:guilabel:`Terminate` deletes all retained backups.
35+
:red:`WARNING:` :guilabel:`Terminate` deletes all retained backups.
3836

3937
.. important::
4038

source/includes/backup/wtchk-process-change-op-state.rst

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,5 @@
3232

3333
- Click :guilabel:`Terminate`.
3434

35-
.. warning::
36-
37-
:guilabel:`Terminate` deletes all retained backups.
35+
:red:`WARNING:` :guilabel:`Terminate` deletes all retained backups.
3836

source/includes/extracts-queryable-backups.yaml

Lines changed: 8 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,16 @@ content: |
2626
To query a snapshot of a :manual:`replica set </reference/glossary/#std-term-replica-set>`, the Backup Daemon
2727
requires at least one worker for the replica set.
2828
29-
.. example::
29+
For example, if you restore a queryable backup from a 3-shard cluster with 1 shard router
30+
(:manual:`mongos </reference/program/mongos/#mongodb-binary-bin.mongos>`), you need
31+
this value to be at least ``5``:
3032
31-
If you restore a queryable backup from a 3-shard cluster with
32-
1 shard router (:manual:`mongos </reference/program/mongos/#mongodb-binary-bin.mongos>`), you would need this value to
33-
be at least ``5``:
33+
- 1 per shard (``3``) +
34+
- 1 for the config server (``1``) +
35+
- 1 for the :binary:`~bin.mongos`
3436
35-
- 1 per shard (``3``) +
36-
- 1 for the config server (``1``) +
37-
- 1 for the :binary:`~bin.mongos`
38-
39-
When the queryable backup begins, the Backup Daemon spins
40-
up 5 or more workers to manage these components.
37+
When the queryable backup begins, the Backup Daemon spins
38+
up 5 or more workers to manage these components.
4139
4240
---
4341
ref: queryable-backup-pem-restriction
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
.. note::
2-
3-
FCV |fcv-link| ``4.2`` and later use
4-
:manual:`backup cursors </reference/glossary/#std-term-backup-cursor>` instead of
5-
:opsmgr:`head databases </reference/glossary/#std-term-head-database>`. For
6-
more information, see :ref:`backup-daemon`.
1+
|fcv-link| ``4.2`` and later use
2+
:manual:`backup cursors </reference/glossary/#std-term-backup-cursor>` instead of
3+
:opsmgr:`head databases </reference/glossary/#std-term-head-database>`. For
4+
more information, see :ref:`backup-daemon`.

0 commit comments

Comments
 (0)