Skip to content

Commit ab70fbb

Browse files
elyse-mdbElyse Foreman
andauthored
(DOCSP-44419) [OM] Backport DOCSP-43740 to v6.0 (#470) (#477)
Standardizing FCV: - Replacing all instances of fCV or FCV with substitution |fcv| - Replacing all instances of "|fcv| of \<ver-num\>" with "|fcv| \<ver-num\>" ------------------------------------------------------ - [DOCSP-43740](https://jira.mongodb.org/browse/DOCSP-43740) - [STAGING](https://deploy-preview-470--10gen-docs-ops-manager.netlify.app/) - [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/67095bb9c4044c000895880c) - [ ] [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). - [x] 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. --------- Backport DOCSP-43740 to v6.0. - [DOCSP-44419](https://jira.mongodb.org/browse/DOCSP-44419) ### Self-Review Checklist - [ ] [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. - [ ] Proofread for spelling and grammatical errors. - [ ] Check staging for rendering issues. - [ ] Confirm links are working. Co-authored-by: Elyse Foreman <[email protected]>
1 parent 5ff36af commit ab70fbb

File tree

8 files changed

+60
-75
lines changed

8 files changed

+60
-75
lines changed

source/application.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -81,20 +81,20 @@ Backups rely upon the
8181
:manual:`MongoDB version compatibility</reference/command/setFeatureCompatibilityVersion>`
8282
of your database.
8383
This Feature Compatibility Version ranges from the current version to
84-
one version earlier. For MongoDB 4.2, the FCV can be ``4.0`` or
84+
one version earlier. For MongoDB 4.2, the |fcv| can be ``4.0`` or
8585
``4.2``.
8686

8787
.. tabs::
8888

89-
.. tab:: FCV 4.2 or later
89+
.. tab:: |fcv| 4.2 or later
9090
:tabid: fcv42
9191

9292
.. include:: /includes/backup/wtchk-process-overview-main-om.rst
9393

9494
The {+mdbagent+} uses WiredTiger's incremental backup cursor to
9595
capture the incremental changes.
9696

97-
.. tab:: FCV 4.0 or earlier
97+
.. tab:: |fcv| 4.0 or earlier
9898
:tabid: fcv40
9999

100100
Once backup has started, |mms| backs up the data as an ongoing
@@ -127,7 +127,7 @@ appear in the snapshot data.
127127
.. tabs::
128128
:hidden:
129129

130-
.. tab:: FCV 4.2 or later
130+
.. tab:: |fcv| 4.2 or later
131131
:tabid: fcv42
132132

133133
|mms| can back up data as a full or incremental backup. |mms|
@@ -139,7 +139,7 @@ appear in the snapshot data.
139139

140140
Incremental backups reduce network transfer and storage costs.
141141

142-
.. tab:: FCV 4.0 or earlier
142+
.. tab:: |fcv| 4.0 or earlier
143143
:tabid: fcv40
144144

145145
How much storage capacity you need depends on both the number
@@ -185,13 +185,13 @@ a selected point between snapshots.
185185
.. tabs::
186186
:hidden:
187187

188-
.. tab:: FCV 4.2 or later
188+
.. tab:: |fcv| 4.2 or later
189189
:tabid: fcv42
190190

191191
You can restore :manual:`sharded clusters </reference/glossary/#std-term-sharded-cluster>` and
192192
:manual:`replica sets </reference/glossary/#std-term-replica-set>` from selected points in time.
193193

194-
.. tab:: FCV 4.0 or earlier
194+
.. tab:: |fcv| 4.0 or earlier
195195
:tabid: fcv40
196196

197197
- For :manual:`sharded clusters </reference/glossary/#std-term-sharded-cluster>`, you can restore
@@ -209,7 +209,7 @@ the snapshot storage. You can restore the snapshot:
209209
.. tabs::
210210
:hidden:
211211

212-
.. tab:: FCV 4.2 or later
212+
.. tab:: |fcv| 4.2 or later
213213
:tabid: fcv42
214214

215215
When you restore from a point in time, |mms| does the following:
@@ -224,7 +224,7 @@ the snapshot storage. You can restore the snapshot:
224224
backup. This affects the amount of time a point-in-time restore
225225
can cover.
226226

227-
.. tab:: FCV 4.0 or earlier
227+
.. tab:: |fcv| 4.0 or earlier
228228
:tabid: fcv40
229229

230230
When you restore from a checkpoint or point in time, |mms| does the following:

source/core/requirements.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -54,7 +54,7 @@ for all |onprem| components that it serves:
5454
You want to serve both the |onprem| application and a
5555
:opsmgr:`Backup Daemon </reference/glossary/#std-term-backup-daemon>` on one host.
5656
This |onprem| configuration will manage and monitor 300 MongoDB hosts,
57-
back up 200 hosts, and run FCV 4.2 or later. The
57+
back up 200 hosts, and run |fcv| 4.2 or later. The
5858
total disk capacity of all databases being backed up is 4 TB.
5959
The total requirements would be:
6060

source/includes/fact-index-rolling-build.rst

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,10 @@ runs with an
3535
less than ``4.2``,
3636
:doc:`resync the head database </tutorial/resync-backup>` to ensure that
3737
the head database takes the new index into account.
38+
runs with an |fcv-link|
39+
less than ``4.2``, :doc:`resync the head database
40+
</tutorial/resync-backup>` to ensure that the head database takes the
41+
new index into account.
3842

3943
|mms| automatically cancels rolling index builds
4044
that do not succeed on all nodes. When a rolling index build completes

source/includes/setting-fileConf-mms.backup.journal.heads.rst

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
enable or disable journaling for the :opsmgr:`head database </reference/glossary/#std-term-head-database>` of a
1111
single backup job.
1212

13-
FCV |fcv-link| ``4.2`` and later use :term:`backup cursors
13+
|fcv-link| ``4.2`` and later use :term:`backup cursors
1414
<backup cursor>` instead of :opsmgr:`head databases </reference/glossary/#std-term-head-database>`
1515
for backups.
1616

source/index.txt

Lines changed: 9 additions & 9 deletions
Original file line numberDiff line numberDiff line change
@@ -73,20 +73,20 @@ Backups rely upon the
7373
:manual:`MongoDB version compatibility</reference/command/setFeatureCompatibilityVersion>`
7474
of your database.
7575
This Feature Compatibility Version ranges from the current version to
76-
one version earlier. For MongoDB 4.2, the FCV can be ``4.0`` or
76+
one version earlier. For MongoDB 4.2, the |fcv| can be ``4.0`` or
7777
``4.2``.
7878

7979
.. tabs::
8080

81-
.. tab:: FCV 4.2 or later
81+
.. tab:: |fcv| 4.2 or later
8282
:tabid: fcv42
8383

8484
.. include:: /includes/backup/wtchk-process-overview-main-om.rst
8585

8686
The {+mdbagent+} uses WiredTiger's incremental backup cursor to
8787
capture the incremental changes.
8888

89-
.. tab:: FCV 4.0 or earlier
89+
.. tab:: |fcv| 4.0 or earlier
9090
:tabid: fcv40
9191

9292
Once backup has started, |mms| backs up the data as an ongoing
@@ -119,7 +119,7 @@ appear in the snapshot data.
119119
.. tabs::
120120
:hidden:
121121

122-
.. tab:: FCV 4.2 or later
122+
.. tab:: |fcv| 4.2 or later
123123
:tabid: fcv42
124124

125125
|mms| can back up data as a full or incremental backup. |mms|
@@ -131,7 +131,7 @@ appear in the snapshot data.
131131

132132
Incremental backups reduce network transfer and storage costs.
133133

134-
.. tab:: FCV 4.0 or earlier
134+
.. tab:: |fcv| 4.0 or earlier
135135
:tabid: fcv40
136136

137137
How much storage capacity you need depends on both the number
@@ -175,13 +175,13 @@ a selected point between snapshots.
175175
.. tabs::
176176
:hidden:
177177

178-
.. tab:: FCV 4.2 or later
178+
.. tab:: |fcv| 4.2 or later
179179
:tabid: fcv42
180180

181181
You can restore :manual:`sharded clusters </reference/glossary/#std-term-sharded-cluster>` and
182182
:manual:`replica sets </reference/glossary/#std-term-replica-set>` from selected points in time.
183183

184-
.. tab:: FCV 4.0 or earlier
184+
.. tab:: |fcv| 4.0 or earlier
185185
:tabid: fcv40
186186

187187
- For :manual:`sharded clusters </reference/glossary/#std-term-sharded-cluster>`, you can restore
@@ -199,7 +199,7 @@ the snapshot storage. You can restore the snapshot:
199199
.. tabs::
200200
:hidden:
201201

202-
.. tab:: FCV 4.2 or later
202+
.. tab:: |fcv| 4.2 or later
203203
:tabid: fcv42
204204

205205
When you restore from a point in time, |mms| does the following:
@@ -214,7 +214,7 @@ the snapshot storage. You can restore the snapshot:
214214
backup. This affects the amount of time a point-in-time restore
215215
can cover.
216216

217-
.. tab:: FCV 4.0 or earlier
217+
.. tab:: |fcv| 4.0 or earlier
218218
:tabid: fcv40
219219

220220
When you restore from a checkpoint or point in time, |mms| does the following:

source/reference/faq/faq-backup.txt

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -56,7 +56,7 @@ Does Backup Work with All Types of Deployments?
5656

5757
- For MongoDB 4.2 and later, see
5858
:ref:`Backup Considerations for Databases <4.2-backup-considerations>`.
59-
- For any MongoDB with |fcv| of ``4.0`` and earlier databases, Backup
59+
- For any MongoDB with |fcv| ``4.0`` and earlier databases, Backup
6060
doesn't support standalone deployments. Backup has full
6161
support for replica sets and sharded clusters.
6262

@@ -87,7 +87,7 @@ Will Backup Impact My Production Databases?
8787
.. note::
8888

8989
This answer applies only to databases running MongoDB with |fcv|
90-
of ``4.0`` and earlier
90+
``4.0`` and earlier
9191

9292
The Backup feature typically has minimal impact on production MongoDB
9393
deployments. This impact performs similar to that of adding a new
@@ -152,7 +152,7 @@ Legacy Backup Agent
152152
Backup capability has been moved to the {+mdbagent+} with Backup
153153
activated. This replaces the individual Backup Agent. This information
154154
covers issues unique to the legacy Backup Agent. All of this
155-
information applies to MongoDB databases running |fcv| of ``4.0`` or
155+
information applies to MongoDB databases running |fcv| ``4.0`` or
156156
earlier.
157157

158158
Where Should I Run The Backup Agent?
@@ -263,8 +263,7 @@ How Does |mms| Provide Point-in-Time Restores?
263263

264264
.. important::
265265

266-
|onprem| 4.2.13 and later supports this feature with |fcv| of
267-
``4.2`` or later.
266+
|onprem| 4.2.13 and later supports this feature with |fcv| ``4.2`` or later.
268267

269268
When you trigger the restore, |mms| creates a link to this snapshot.
270269
Once clicked, |mms| retrieves chunks from the Snapshot Store and
@@ -377,7 +376,7 @@ What Conditions Require a Resync?
377376

378377
.. important::
379378

380-
This feature is incompatible with MongoDB 4.2 with |fcv| of ``4.2``.
379+
This feature is incompatible with MongoDB 4.2 with |fcv| ``4.2``.
381380

382381
If the Backup Agent's :term:`tailing cursor <tailable cursor>` cannot
383382
keep up with your deployment's :manual:`oplog </reference/glossary/#std-term-oplog>`, then you must

source/tutorial/enable-backup.txt

Lines changed: 30 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -19,10 +19,10 @@ a cloud-hosted MongoDB database.
1919

2020
.. tabs::
2121

22-
.. tab:: FCV 4.2 or later
22+
.. tab:: |fcv| 4.2 or later
2323
:tabid: fcv42
2424

25-
.. tab:: FCV 4.0 or earlier
25+
.. tab:: |fcv| 4.0 or earlier
2626
:tabid: fcv40
2727

2828
Prerequisites
@@ -43,26 +43,20 @@ A Replica Set must:
4343
.. tabs::
4444
:hidden:
4545

46-
.. tab:: FCV 4.2 or later
46+
.. tab:: |fcv| 4.2 or later
4747
:tabid: fcv42
4848

49-
- Be monitored by |mms|.
50-
51-
- Run MongoDB Enterprise with an |fcv| of 4.2 or later.
52-
53-
- Have an active :manual:`primary </reference/glossary/#std-term-primary>` node.
54-
55-
- Have one node with :manual:`WiredTiger </core/wiredtiger>` set
56-
as its :ref:`storage engine <considerations-backup-storage-engine>`.
57-
58-
.. tab:: FCV 4.0 or earlier
59-
:tabid: fcv40
60-
61-
- Be monitored by |mms|.
49+
.. tabs::
50+
:hidden:
6251

63-
- Run MongoDB version 2.6 to 4.0.
52+
.. tab:: |fcv| 4.2 or later
53+
:tabid: fcv42
6454

65-
- Have an active :manual:`primary </reference/glossary/#std-term-primary>` node.
55+
- Be monitored by |mms|.
56+
- Run MongoDB Enterprise with an |fcv| of 4.2 or later.
57+
- Have an active :manual:`primary </reference/glossary/#std-term-primary>` node.
58+
- Have one node with :manual:`WiredTiger </core/wiredtiger>` set as its
59+
:ref:`storage engine <considerations-backup-storage-engine>`.
6660

6761
Sharded Cluster Requirements
6862
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
@@ -72,39 +66,27 @@ A Sharded Cluster must:
7266
.. tabs::
7367
:hidden:
7468

75-
.. tab:: FCV 4.2 or later
69+
.. tab:: |fcv| 4.2 or later
7670
:tabid: fcv42
7771

78-
- Be monitored by |mms|.
79-
80-
- Run MongoDB Enterprise with an |fcv| of 4.2 or later on all
81-
nodes including the config server.
82-
83-
- Have an active :manual:`primary </reference/glossary/#std-term-primary>` node of each shard and the
84-
config server.
85-
86-
- Have one node per shard or config server with
87-
:manual:`WiredTiger </core/wiredtiger>` set as its
88-
:ref:`storage engine <considerations-backup-storage-engine>`.
89-
90-
.. tab:: FCV 4.0 or earlier
91-
:tabid: fcv40
92-
93-
- Be monitored by |mms| including at least one |mongos| in the
94-
cluster.
95-
96-
- Run MongoDB version 2.6 to 4.0.
72+
.. tabs::
73+
:hidden:
9774

98-
- Have all :manual:`config servers </reference/glossary/#std-term-config-server>` running. The
99-
config server |mongod| processes must be started with either
100-
the ``--configsvr`` command line option or the
101-
``{ "clusterRole": "configsvr" }`` setting in the ``mongod``
102-
configuration file.
75+
.. tab:: |fcv| 4.2 or later
76+
:tabid: fcv42
10377

104-
- Complete the balancing round in less than one hour.
78+
- Be monitored by |mms|.
79+
- Run MongoDB Enterprise with an |fcv| of 4.2 or later on all nodes
80+
including the config server.
81+
- Have an active :manual:`primary
82+
</reference/glossary/#std-term-primary>` node of each shard and the
83+
config server.
84+
- Have one node per shard or config server with :manual:`WiredTiger
85+
</core/wiredtiger>` set as its :ref:`storage engine
86+
<considerations-backup-storage-engine>`.
10587

106-
MongoDB FCV 4.2 Compatibility
107-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
88+
MongoDB Compatibility
89+
~~~~~~~~~~~~~~~~~~~~~
10890

10991
All |fcv| 4.2 and later databases must fulfill the appropriate
11092
:ref:`backup considerations <4.2-backup-considerations>`.
@@ -125,14 +107,14 @@ Procedure
125107
.. tabs::
126108
:hidden:
127109

128-
.. tab:: FCV 4.2 or later
110+
.. tab:: |fcv| 4.2 or later
129111
:tabid: fcv42
130112

131113
You can back up your entire MongoDB deployment.
132114

133115
.. include:: /includes/steps/create-backup-wt.rst
134116

135-
.. tab:: FCV 4.0 or earlier
117+
.. tab:: |fcv| 4.0 or earlier
136118
:tabid: fcv40
137119

138120
You can choose to back up all databases and collections in your

source/tutorial/nav/restore-overview.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -97,7 +97,7 @@ To perform automated restores:
9797
:manual:`setFeatureCompatibilityVersion </reference/command/setFeatureCompatibilityVersion>`.
9898

9999
- Review the following compatibility matrix for the supported source cluster
100-
|fcv| of each MongoDB version. The MongoDB version of each host in
100+
each MongoDB version. The MongoDB version of each host in
101101
the target cluster *must* support the |fcv| of the snapshot of the
102102
source cluster.
103103

0 commit comments

Comments
 (0)