Skip to content

Commit 3127495

Browse files
authored
(DOCSP-44021) [OM] Backport DOCSP-43096 to v7.0 (#419)
## Unnesting components in 19 OM pages. [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-43096](https://jira.mongodb.org/browse/DOCSP-43096) ## STAGING 1. [ops-manager/current/tutorial/edit-replica-set](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/edit-replica-set/) — No changes, all nested admonitions in tables already fixed. 2. [ops-manager/current/tutorial/configure-application-high-availability](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/configure-application-high-availability/) — Unnested 1 tip in table. 3. [ops-manager/current/tutorial/configure-for-ldap-authentication](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/configure-for-ldap-authentication/) — Unnested 1 example in admonition and 1 ``important`` admonition in table. 4. [ops-manager/current/tutorial/configure-local-mode](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/configure-local-mode/) — Unnested 2 notes in tables under different tabs. 5. [ops-manager/current/tutorial/configure-ssl-connection-to-web-interface](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/configure-ssl-connection-to-web-interface/) — Unnested 1 example in table, 1 example in admonition, and 3 admonitions in tables. 6. [ops-manager/current/tutorial/deploy-standalone](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/deploy-standalone/) — No changes, admonition in table fixed by past PR. 7. [ops-manager/current/tutorial/install-on-prem-from-archive](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/install-on-prem-from-archive/) — Unnested 1 ``warning`` admonition from table. 8. [ops-manager/current/tutorial/install-on-prem-with-deb-packages](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/install-on-prem-with-deb-packages/) — Unnested 1 ``warning`` admonition in table (same commit as 7) 9. [ops-manager/current/tutorial/install-on-prem-with-rpm-packages](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/install-on-prem-with-rpm-packages/) — Unnested 1``warning`` admonition in table (same commit as 7 and 8) 10. [ops-manager/current/tutorial/manage-blockstore-storage](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/manage-blockstore-storage/) — Unnested admonitions and refactored **Load Factor** 11. [ops-manager/current/tutorial/manage-filestore-storage](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/manage-filestore-storage/) — Unnested 2 notes in table. 12. [ops-manager/current/tutorial/manage-global-alerts](https://mongodb.com/docs/ops-manager/current/tutorial/manage-global-alerts/) — No change, did not see the 1 admonition in table listed in spreadsheet. 13. [ops-manager/current/tutorial/manage-oplog-storage](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/manage-oplog-storage/) — Unnested examples and admonitions in tables. 14. [ops-manager/current/tutorial/manage-organizations/](https://deploy-preview-406--10gen-docs-ops-manager.netlify.app/tutorial/manage-organizations/) — Unnested 1 note. ## [LATEST BUILD LOG](https://app.netlify.com/sites/10gen-docs-ops-manager/deploys/66fb24efa41118000813750c) - 21 errors, seem to be unrelated to any page I edited. ### 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). - [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-43096](https://jira.mongodb.org/browse/DOCSP-43096) to v7.0 - [DOCSP-44021](https://jira.mongodb.org/browse/DOCSP-44021) - [STAGING](paste the link to staging here) - [LATEST BUILD LOG](paste the build here) ### 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). - [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.
1 parent 0c34534 commit 3127495

18 files changed

+147
-181
lines changed
Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,4 @@
1-
.. note::
2-
3-
If your :ref:`Ops Manager Application Database
4-
<deploy-om-appdb>` uses authentication or |tls|, you must have
5-
connections configured to the application database. To learn
6-
more, see :ref:`configure-connections-to-app-db`.
1+
If your :ref:`Ops Manager Application Database
2+
<deploy-om-appdb>` uses authentication or |tls|, you must have
3+
connections configured to the application database. To learn
4+
more, see :ref:`configure-connections-to-app-db`.

source/includes/steps-admin-add-blockstore.yaml

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -40,9 +40,11 @@ content: |
4040
Sharded Cluster) in the ``<hostname:port>`` format that
4141
comprise the blockstore database.
4242
43-
.. example::
43+
For example:
4444
45-
``h1.ex.com:27017,h2.ex.com:27017,h2.ex.com:27018``
45+
.. code-block:: ini
46+
47+
h1.ex.com:27017,h2.ex.com:27017,h2.ex.com:27018
4648
4749
This field displays only if you set
4850
:guilabel:`Datastore Type` to :guilabel:`Replica Set` or
@@ -72,10 +74,10 @@ content: |
7274
- Optional
7375
- If you set this value:
7476
75-
.. include:: /includes/warning-plaintext-password.rst
76-
7777
.. include:: /includes/tabsets/storage-settings-password.rst
7878
79+
.. include:: /includes/warning-plaintext-password.rst
80+
7981
* - Connection Options
8082
- Optional
8183
- Add additional :ref:`connection string options

source/includes/steps-admin-add-filestore.yaml

Lines changed: 6 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -36,23 +36,19 @@ content: |
3636
compressed. Any backup job using MMapV1 snapshots inherits
3737
this setting. The default value is ``on``.
3838
39-
.. note::
40-
41-
If you plan on using queryable backups, set this value to
42-
``off``. Queryable backup cannot query compressed
43-
snapshots.
39+
If you plan on using queryable backups, set this value to
40+
``off``. Queryable backup cannot query compressed
41+
snapshots.
4442
4543
* - :guilabel:`WiredTiger Compression Setting`
4644
4745
- Select whether or not WiredTiger storage engine snapshots are
4846
compressed. Any backup job using WiredTiger snapshots
4947
inherits this setting. The default value is ``off``.
5048
51-
.. note::
52-
53-
If you plan on using queryable backups, set this value to
54-
``off``. Queryable backup cannot query compressed
55-
snapshots.
49+
If you plan on using queryable backups, set this value to
50+
``off``. Queryable backup cannot query compressed
51+
snapshots.
5652
5753
* - :guilabel:`New Assignment Enabled` checkbox
5854

source/includes/steps-admin-add-oplogstore.yaml

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,9 @@ content: |
4040
the ``<hostname:port>`` format that comprise the Oplog Store
4141
database.
4242
43-
.. example::
43+
For example:
44+
45+
.. code-block:: ini
4446
4547
host1.example.com:27017, host2.example.com:27017, host2.example.com:27018
4648

source/includes/steps-admin-edit-blockstore.yaml

Lines changed: 55 additions & 65 deletions
Original file line numberDiff line numberDiff line change
@@ -32,24 +32,23 @@ content: |
3232
- Type in one or more hosts that comprise the blockstore
3333
database in the ``<hostname:port>`` format.
3434
35-
.. important::
35+
:gold:`IMPORTANT:` If these hosts are changed, the blockstore database they
36+
host must have the same data as the original blockstore database.
37+
Changing the host to a new blockstore databases results in data loss.
3638
37-
If these hosts are changed, the blockstore database they
38-
host must have the same data as the original blockstore
39-
database. Changing the host to a new blockstore
40-
databases results in data loss.
39+
If the blockstore database is a Replica Set or Sharded Cluster,
40+
type a comma-separated list of :manual:`mongod </reference/program/mongod/#mongodb-binary-bin.mongod>`
41+
instances (for a Replica Set) or :manual:`mongos </reference/program/mongos/#mongodb-binary-bin.mongos>`
42+
instances (for a Sharded Cluster).
4143
42-
- If the blockstore database is a Replica Set or Sharded
43-
Cluster, type a comma-separated list of :manual:`mongod </reference/program/mongod/#mongodb-binary-bin.mongod>`
44-
instances (for a Replica Set) or :manual:`mongos </reference/program/mongos/#mongodb-binary-bin.mongos>`
45-
instances (for a Sharded Cluster).
44+
For example:
4645
47-
.. example::
46+
.. code-block:: ini
4847
49-
``host1.example.com:27017,host2.example.com:27017,host2.example.com:27018``
48+
host1.example.com:27017,host2.example.com:27017,host2.example.com:27018
5049
51-
- If the blockstore database is a standalone MongoDB
52-
instance, type the ``hostname:port`` of the instance.
50+
If the blockstore database is a standalone MongoDB
51+
instance, type the ``hostname:port`` of the instance.
5352
5453
* - MongoDB Auth Username
5554
@@ -63,13 +62,11 @@ content: |
6362
6463
.. include:: /includes/tabsets/storage-settings-password.rst
6564
65+
|onprem| doesn't display the existing
66+
:guilabel:`MongoDB Auth Password`.
67+
6668
.. include:: /includes/warning-plaintext-password.rst
6769
68-
.. note::
69-
70-
|onprem| doesn't display the existing
71-
:guilabel:`MongoDB Auth Password`.
72-
7370
* - Encrypted Credentials
7471
7572
- Select if the Username and Password for the database were
@@ -105,54 +102,57 @@ content: |
105102
snapshot store.
106103
107104
Backup work includes running backups, restoring snapshots or
108-
:term:`grooming <groom>` blockstores. The backup work
109-
ratio assigned to a single snapshot store is called its *Load
110-
Factor*.
111-
112-
.. important::
105+
:term:`grooming <groom>` blockstores. The ratio of backup work
106+
assigned to a single snapshot store is called its *Load
107+
Factor*.
108+
109+
:gold:`IMPORTANT:` If you have only one snapshot store,
110+
:guilabel:`Load Factor` represents the number of concurrent
111+
backup work processes the snapshot store performs at a time.
112+
To avoid performance costs associated with running multiple
113+
concurrent processes when you have one snapshot store,
114+
omit this setting to assign your snapshot store the
115+
default :guilabel:`Load Factor` of ``1``.
116+
117+
When you have multiple snapshot stores, the default :guilabel:`Load Factor`
118+
of ``1`` assigns each snapshot store the same amount of work. If a snapshot
119+
store's :guilabel:`Load Factor` is set to ``0``,
120+
it performs no backup work at all.
113121
114-
If you have only one snapshot store, the :guilabel:`Load Factor`
115-
setting represents the number of concurrent backup work processes the
116-
snapshot store performs at a time.
117-
118-
To avoid performance costs associated with running multiple
119-
concurrent processes when you have one snapshot store, omit this
120-
setting to assign your snapshot store the default :guilabel:`Load Factor` of ``1``.
121-
122-
By default, |mms| assigns each snapshot store a
123-
:guilabel:`Load Factor` of ``1``. This means each snapshot
124-
store performs the same amount of backup work.
122+
If a snapshot store's :guilabel:`Load Factor` is changed while
123+
backup work is in progress, all jobs or tasks running on that snapshot store
124+
are allowed to finish. All future backup work is then re-
125+
distributed among the remaining snapshot stores that have a
126+
:guilabel:`Load Factor` of ``1`` or greater and
127+
:guilabel:`Assignment Enabled` selected.
125128
126129
As a snapshot store's :guilabel:`Load Factor` increases, it
127130
performs more backup work compared to another snapshot store.
128-
If the :guilabel:`Load Factor` of snapshot store ``A`` is set
131+
For example, if the :guilabel:`Load Factor` of snapshot store ``A`` is set
129132
to ``2`` and the :guilabel:`Load Factor` of snapshot store
130-
``B`` is set to ``1``, ``A`` performs two times the backup
133+
``B`` is set to ``1``, then ``A`` performs two times the backup
131134
work of ``B``.
132135
133-
.. example:: **How to estimate Load Factor**
136+
Snapshot stores with greater computer or storage performance
137+
should be given a greater :guilabel:`Load Factor`.
138+
For example, consider a five-shard sharded cluster with the
139+
following backup storage configuration:
134140
135-
Consider a five-shard sharded cluster with the
136-
following backup storage configuration:
141+
- File system store (``F``) manages the backup work for
142+
one shard in the cluster. ``F`` is running on a single
143+
two-core physical server.
137144
138-
- File system store (``F``) manages the backup work for
139-
one shard in the cluster. ``F`` is running on a single
140-
two-core physical server.
145+
- Blockstore (``B``) manages the backup work for four
146+
shards in the cluster. ``B`` is running as a four-node
147+
sharded cluster on four physical servers with two cores
148+
on each server.
141149
142-
- Blockstore (``B``) manages the backup work for four
143-
shards in the cluster. ``B`` is running as a four-node
144-
sharded cluster on four physical servers with two cores
145-
on each server.
150+
In this example, ``B`` has four times the capability of
151+
``F``. You should set the :guilabel:`Load Factor`\s of ``B`` to ``4`` and ``F`` to ``1``.
152+
For every ``1`` backup task ``F`` performs, ``B`` performs ``4``.
146153
147-
In this example, ``B`` has four times the capability of
148-
``F``. ``B`` should receive the greater part of the ratio
149-
of backup work: ``4:1``. For every one backup task ``F``
150-
performs, ``B`` performs ``4``.
151-
152-
Set the Load Factors of ``B`` to ``4`` and ``F`` to ``1``.
153-
154-
Snapshot stores with greater compute or storage performance
155-
should be given a greater :guilabel:`Load Factor`:
154+
For more examples comparing the storage capabilities of
155+
different backup configurations, see:
156156
157157
- A file system store with 16-cores and 128 GB of RAM can
158158
back up more databases in less time than a file system
@@ -162,16 +162,6 @@ content: |
162162
up more databases and groom more databases than a
163163
blockstore backed by a single replica set.
164164
165-
:guilabel:`Load Factor` can be set to ``0``. When one
166-
snapshot store's :guilabel:`Load Factor` is set to ``0``, it
167-
performs no backup work at all. If a snapshot store's
168-
:guilabel:`Load Factor` is changed while backup work is in
169-
progress, all jobs or tasks running on that snapshot store
170-
are allowed to finish. All future backup work then is re-
171-
distributed among the remaining snapshot stores with a
172-
:guilabel:`Load Factor` of ``1`` or greater and have
173-
:guilabel:`Assignment Enabled` selected.
174-
175165
* - Write Concern
176166
177167
- Select your preferred

source/includes/steps-admin-edit-oplogstore.yaml

Lines changed: 18 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -31,24 +31,24 @@ content: |
3131
- Type in one or more hosts that comprise the Oplog Store
3232
database in the ``<hostname:port>`` format.
3333
34-
.. important::
34+
:gold:`IMPORTANT:` If these hosts are changed, the Oplog Store database they
35+
host must have the same data as the original Oplog Store
36+
database. Changing the host to a new Oplog Store database
37+
results in data loss.
3538
36-
If these hosts are changed, the Oplog Store database they
37-
host must have the same data as the original Oplog Store
38-
database. Changing the host to a new Oplog Store database
39-
results in data loss.
39+
If the Oplog Store database is a Replica Set or Sharded
40+
Cluster, type a comma-separated list of |mongod| instances
41+
(for a Replica Set) or |mongos| instances (for a Sharded
42+
Cluster).
4043
41-
- If the Oplog Store database is a Replica Set or Sharded
42-
Cluster, type a comma-separated list of |mongod| instances
43-
(for a Replica Set) or |mongos| instances (for a Sharded
44-
Cluster).
44+
For example:
45+
46+
.. code-block:: ini
47+
48+
host1.example.com:27017,host2.example.com:27017,host2.example.com:27018
4549
46-
.. example::
47-
48-
host1.example.com:27017, host2.example.com:27017, host2.example.com:27018
49-
50-
- If the Oplog Store database is a standalone MongoDB
51-
instance, type the ``hostname:port`` of the instance.
50+
If the Oplog Store database is a standalone MongoDB
51+
instance, type the ``hostname:port`` of the instance.
5252
5353
* - MongoDB Auth Username
5454
@@ -62,12 +62,10 @@ content: |
6262
6363
.. include:: /includes/tabsets/storage-settings-password.rst
6464
65-
.. include:: /includes/warning-plaintext-password.rst
65+
|onprem| doesn't display the existing
66+
:guilabel:`MongoDB Auth Password`.
6667
67-
.. note::
68-
69-
|onprem| doesn't display the existing
70-
:guilabel:`MongoDB Auth Password`.
68+
.. include:: /includes/warning-plaintext-password.rst
7169
7270
* - Encrypted Credentials
7371

source/includes/steps-configure-agent-ssl-to-web-interface.yaml

Lines changed: 22 additions & 28 deletions
Original file line numberDiff line numberDiff line change
@@ -32,16 +32,14 @@ content: |
3232
- Set this value to match the |url| you entered in the
3333
:guilabel:`URL to Access Ops Manager` box.
3434
35-
.. important::
36-
37-
Ensure that you update both this property and the
38-
:guilabel:`URL to Access Ops Manager` box. Both values must
39-
match. If {+magent+} and {+bagent+} are enabled for the
40-
{+mdbagent+}, they use the :guilabel:`URL to Access Ops
41-
Manager` configured on the |onprem| server, unless the
42-
``mmsBaseURL`` custom monitoring setting is set for the
43-
{+mdbagent+}. For more information, see the
44-
:ref:`MongoDB Agent Monitoring Settings <mongodb-agent-settings>`.
35+
:gold:`IMPORTANT:` Ensure that you update both this property and the
36+
:guilabel:`URL to Access Ops Manager` box. Both values must
37+
match. If {+magent+} and {+bagent+} are enabled for the
38+
{+mdbagent+}, they use the :guilabel:`URL to Access Ops
39+
Manager` configured on the |onprem| server, unless the
40+
``mmsBaseURL`` custom monitoring setting is set for the
41+
{+mdbagent+}. For more information, see the
42+
:ref:`MongoDB Agent Monitoring Settings <mongodb-agent-settings>`.
4543
4644
* - :setting:`tlsRequireValidMMSServerCertificates`
4745
- Conditional
@@ -53,37 +51,33 @@ content: |
5351
hosts with a known external |certauth| or self-signed
5452
|certauth|.
5553
56-
.. note::
57-
58-
If you set this value to ``true``, you must set
59-
:msetting:`httpsCAFile`.
54+
If you set this value to ``true``, you must set
55+
:msetting:`httpsCAFile`.
6056
6157
* - :msetting:`httpsCAFile`
6258
- Conditional
6359
- If you are using your own self-signed |certauth| ``.pem``
6460
files, add this property and set it to the absolute path to
6561
your |certauth| file on the MongoDB host.
6662
67-
.. important::
68-
69-
This |certauth| file must be in the same location on each
70-
MongoDB host in the same sharded cluster or replica set.
71-
Any MongoDB host that does not have the file in the same
72-
file location as the others may become unaccessible.
63+
:gold:`IMPORTANT:` This |certauth| file must be in the same
64+
location on each MongoDB host in the same sharded cluster
65+
or replica set. Any MongoDB host that does not have the file
66+
in the same file location as the others may become unaccessible.
7367
74-
Add the |certauth| for the ``downloads.mongodb.com``
75-
certificate to this ``.pem`` file if you:
68+
Add the |certauth| for the ``downloads.mongodb.com``
69+
certificate to this ``.pem`` file if you:
7670
77-
1. Need your {+mdbagent+}s to download their MongoDB
71+
1. Need your {+mdbagent+}s to download their MongoDB
7872
installers from the Internet,
7973
80-
#. Use TLS to encrypt connections, and
74+
#. Use TLS to encrypt connections, and
8175
82-
#. Signed your certificates with a private CA. (You set the
83-
``httpsCAFile`` option.)
76+
#. Signed your certificates with a private CA. (You set the
77+
``httpsCAFile`` option.)
8478
85-
To learn how to download TLS certificates from another web
86-
site, see the `OpenSSL Cookbook entry <https://www.feistyduck.com/library/openssl-cookbook/online/ch-testing-with-openssl.html#extracting-remote-certificates>`__.
79+
To learn how to download TLS certificates from another web
80+
site, see the `OpenSSL Cookbook entry <https://www.feistyduck.com/library/openssl-cookbook/online/ch-testing-with-openssl.html#extracting-remote-certificates>`__.
8781
8882
* - :setting:`tlsMMSServerClientCertificate`
8983
- Conditional

source/includes/steps-configure-application-high-availability.yaml

Lines changed: 3 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -26,11 +26,9 @@ pre: |
2626
* - 500
2727
- |onprem| host or :term:`application database` appear
2828
unhealthy.
29-
30-
.. seealso::
31-
32-
If this endpoint returns ``HTTP 500`` often, review the
33-
:doc:`/troubleshooting` section.
29+
30+
If this endpoint returns ``HTTP 500`` often, review the
31+
:doc:`/troubleshooting` section.
3432
3533
The load balancer must not return cached content.
3634
---

0 commit comments

Comments
 (0)