Skip to content

Commit 09934ef

Browse files
authored
(DOCSP-34605) v7.0 branch migration prep: removes options, editions, only, cond; adjusts admonition, see also (cherry-pick) (#3)
See notes and review/approval on original PR in mms-docs: https://github.com/10gen/mms-docs/pull/5280 This PR cherry-picks those changes and applies them against the master branch for 7.0. Errors will be resolved once we can build this repo with Snooty.
1 parent 8ce1ddd commit 09934ef

File tree

827 files changed

+12189
-26832
lines changed

Some content is hidden

Large Commits have some content hidden by default. Use the searchbox below for content that may be hidden.

827 files changed

+12189
-26832
lines changed

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

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -136,4 +136,6 @@ To initiate an integrity check:
136136
|onprem| displays the :guilabel:`Integrity Schedule Result` modal
137137
with the status of the blockstore.
138138

139-
.. seealso:: :doc:`/tutorial/configure-block-size`.
139+
.. seealso::
140+
141+
:doc:`/tutorial/configure-block-size`.

source/admin/backup/grooms-page.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -43,8 +43,7 @@ How Groom Jobs Work
4343

4444
Groom job differ based on the snapshot store.
4545

46-
.. admonition:: File Size Changes during Grooming
47-
:class: note
46+
.. note:: File Size Changes during Grooming
4847

4948
During grooming operations, you may notice that the file sizes of
5049
blockstores and |s3| snapshot stores fluctuate, sometimes

source/admin/general/mongodb-usage-page.txt

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -13,8 +13,7 @@ MongoDB Usage
1313
:depth: 2
1414
:class: singlecol
1515

16-
.. admonition:: Enable MongoDB Usage UI and MongoDB Usage Data Collection
17-
:class: important
16+
.. important:: Enable MongoDB Usage UI and MongoDB Usage Data Collection
1817

1918
If :setting:`MongoDB Usage UI` is set to ``true``, this page
2019
displays information about the MongoDB Usage collected via daily

source/administration.txt

Lines changed: 11 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -33,15 +33,14 @@ Administer |onprem|
3333
:doc:`/tutorial/update-version-manifest`
3434
Set which versions of |onprem| can install.
3535

36-
.. class:: hidden
37-
38-
.. toctree::
39-
:titlesonly:
40-
41-
/admin-console
42-
/tutorial/add-message-to-interface
43-
/tutorial/start-and-stop-application
44-
/tutorial/start-and-stop-backup-daemon
45-
/tutorial/nav/backup-storage
46-
/tutorial/manage-ops-manager-logs
47-
/tutorial/update-version-manifest
36+
.. toctree::
37+
:titlesonly:
38+
:hidden:
39+
40+
/admin-console
41+
/tutorial/add-message-to-interface
42+
/tutorial/start-and-stop-application
43+
/tutorial/start-and-stop-backup-daemon
44+
/tutorial/nav/backup-storage
45+
/tutorial/manage-ops-manager-logs
46+
/tutorial/update-version-manifest

source/analyze-slow-queries.txt

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -73,8 +73,8 @@ To optimize query performance, review the following best practices:
7373
- :ref:`Drop unused, redundant, and hidden indexes <pa-drop-index>` to
7474
improve write performance and free storage space.
7575

76-
.. class:: hidden
76+
.. toctree::
77+
:hidden:
7778

78-
.. toctree::
79-
/tutorial/performance-advisor
80-
/tutorial/profile-database
79+
/tutorial/performance-advisor
80+
/tutorial/profile-database

source/application.txt

Lines changed: 52 additions & 80 deletions
Original file line numberDiff line numberDiff line change
@@ -21,19 +21,10 @@ Automation
2121
|mms| Automation enables you to configure and maintain MongoDB nodes
2222
and clusters.
2323

24-
.. cond:: onprem
25-
26-
.. image:: /figures/how-it-works-ops.png
27-
:alt: "Automation coordinates MongoDB instances running in a public cloud, in your private data center, or on your local system."
28-
:width: 700px
29-
:align: center
30-
31-
.. cond:: cloud
32-
33-
.. image:: /figures/how-it-works.png
34-
:alt: "Automation coordinates MongoDB instances running in a public cloud, in your private data center, or on your local system."
35-
:width: 700px
36-
:align: center
24+
.. image:: /figures/how-it-works-ops.png
25+
:alt: "Automation coordinates MongoDB instances running in a public cloud, in your private data center, or on your local system."
26+
:width: 700px
27+
:align: center
3728

3829
MongoDB Agents using Automation on each MongoDB host can maintain your
3930
MongoDB deployments. You can
@@ -113,21 +104,12 @@ one version earlier. For MongoDB 4.2, the FCV can be ``4.0`` or
113104

114105
.. include:: /includes/backup/legacy-process-overview-main-om.rst
115106

116-
.. cond:: onprem
117-
118-
The {+mdbagent+} then tails each replica set's :term:`oplog`
119-
to maintain on disk a standalone database, called a
120-
:term:`head database <head database>`. |mms| maintains one
121-
head database for each backed-up replica set. The head
122-
database stays consistent with the original :term:`primary` up
123-
to the last oplog that the {+mdbagent+} supplies.
124-
125-
.. cond:: cloud
126-
127-
The {+mdbagent+} then tails each replica set's :term:`oplog`
128-
to update the backup when performing a point-in-time restore.
129-
The backup is consistent with the original primary up to the
130-
last oplog that the {+mdbagent+} supplies.
107+
The {+mdbagent+} then tails each replica set's :term:`oplog`
108+
to maintain on disk a standalone database, called a
109+
:term:`head database <head database>`. |mms| maintains one
110+
head database for each backed-up replica set. The head
111+
database stays consistent with the original :term:`primary` up
112+
to the last oplog that the {+mdbagent+} supplies.
131113

132114
The backup process works in this manner regardless of how snapshots are
133115
stored.
@@ -142,64 +124,58 @@ then can insert a marker token into all shards and config servers in
142124
the cluster. |mms| takes a :term:`snapshot` when the marker tokens
143125
appear in the snapshot data.
144126

145-
.. cond:: onprem
146-
147-
.. tabs::
148-
:hidden:
127+
.. tabs::
128+
:hidden:
149129

150-
.. tab:: FCV 4.2 or later
151-
:tabid: fcv42
130+
.. tab:: FCV 4.2 or later
131+
:tabid: fcv42
152132

153-
|mms| can back up data as a full or incremental backup. |mms|
154-
requires a full backup:
133+
|mms| can back up data as a full or incremental backup. |mms|
134+
requires a full backup:
155135

156-
- For your first backup.
157-
- After a snapshot has been deleted.
158-
- If the blockstore block size has been changed.
136+
- For your first backup.
137+
- After a snapshot has been deleted.
138+
- If the blockstore block size has been changed.
159139

160-
Incremental backups reduce network transfer and storage costs.
140+
Incremental backups reduce network transfer and storage costs.
161141

162-
.. tab:: FCV 4.0 or earlier
163-
:tabid: fcv40
142+
.. tab:: FCV 4.0 or earlier
143+
:tabid: fcv40
164144

165-
How much storage capacity you need depends on both the number
166-
of snapshots and the type of snapshot storage you choose. The
167-
following table outlines the differences in snapshot stores:
145+
How much storage capacity you need depends on both the number
146+
of snapshots and the type of snapshot storage you choose. The
147+
following table outlines the differences in snapshot stores:
168148

169-
.. list-table::
170-
:header-rows: 1
171-
:widths: 25 75
149+
.. list-table::
150+
:header-rows: 1
151+
:widths: 25 75
172152

173-
* - Snapshot Store
174-
- Description
153+
* - Snapshot Store
154+
- Description
175155

176-
* - MongoDB blockstore
177-
- Only the differences between each successive
178-
:term:`snapshot` are stored. Compression and
179-
block-level :term:`deduplication` reduce the size of
180-
snapshot data.
156+
* - MongoDB blockstore
157+
- Only the differences between each successive
158+
:term:`snapshot` are stored. Compression and
159+
block-level :term:`deduplication` reduce the size of
160+
snapshot data.
181161

182-
* - |s3| bucket
183-
- Only the differences between each successive
184-
:term:`snapshot` are stored. Compression and
185-
block-level :term:`deduplication` reduce the size of
186-
snapshot data.
162+
* - |aws| |s3| bucket
163+
- Only the differences between each successive
164+
:term:`snapshot` are stored. Compression and
165+
block-level :term:`deduplication` reduce the size of
166+
snapshot data.
187167

188-
* - File system store
189-
- Depending on the configuration, compression reduces the
190-
size of the :term:`snapshot` data.
168+
* - |s3| bucket
169+
- Only the differences between each successive
170+
:term:`snapshot` are stored. Compression and
171+
block-level :term:`deduplication` reduce the size of
172+
snapshot data.
191173

192-
All snapshots represent a full backup.
174+
All snapshots represent a full backup.
193175

194176
To learn more about how to configure backups, see
195177
:doc:`Backup Configuration Options </core/backup-preparations>`.
196178

197-
.. cond:: cloud
198-
199-
Monthly backup costs for |mms| are based on the size per-gigabyte
200-
of your most recent snapshot. To learn about |mms| backup pricing,
201-
see :ref:`Backup Costs <backup-pricing>`.
202-
203179
.. _restores:
204180

205181
Restore Data
@@ -246,11 +222,9 @@ the snapshot storage. You can restore the snapshot:
246222
#. Delivers the snapshot and oplog updates using the same
247223
|https| mechanisms.
248224

249-
.. cond:: onprem
250-
251-
You can configure how much of the oplog you want to keep per
252-
backup. This affects the amount of time a point-in-time restore can
253-
cover.
225+
You can configure how much of the oplog you want to keep per
226+
backup. This affects the amount of time a point-in-time restore
227+
can cover.
254228

255229
.. tab:: FCV 4.0 or earlier
256230
:tabid: fcv40
@@ -263,10 +237,8 @@ the snapshot storage. You can restore the snapshot:
263237
#. Delivers the snapshot and oplog updates using the same |https| mechanisms.
264238
To enable checkpoints, see :ref:`enable-cluster-checkpoints`.
265239

266-
.. cond:: onprem
267-
268-
You can configure how much of the oplog you want to keep per
269-
backup. This affects how much time a checkpoint and
270-
point-in-time restore can cover.
240+
You can configure how much of the oplog you want to keep per
241+
backup. This affects how much time a checkpoint and
242+
point-in-time restore can cover.
271243

272244
.. include:: /includes/extracts/toc-application-introduction.rst

0 commit comments

Comments
 (0)