Skip to content

Commit 7392d92

Browse files
committed
(DOCSP-36854): Backport DOCSP-36633 to v7.0. (#95)
@TomerYakir, I tried to clarify the wording around the MDB Settings. The ticket suggests removing the list of unsupported settings. Should we really do that? [STAGE](https://preview-mongodbcorryroot.gatsbyjs.io/ops-manager/DOCSP-36633/reference/cluster-configuration-process-options/) [JIRA](https://jira.mongodb.org/browse/DOCSP-36633) [BUILD](https://workerpool-boxgs.mongodbstitch.com/pages/job.html?collName=queue&jobId=65ce2e717111165982e64f8d)
1 parent 6491aee commit 7392d92

10 files changed

+38
-37
lines changed

source/includes/api/automation-configuration/processes.rst

Lines changed: 4 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -67,9 +67,11 @@ instances. Using this array, you can:
6767
- Required
6868
- MongoDB configuration object for MongoDB versions 2.6 and later.
6969

70-
.. seealso::
70+
.. note::
7171

72-
:doc:`Supported configuration options </reference/cluster-configuration-process-options>`.
72+
The ``processes.args2_6`` object accepts most MongoDB
73+
settings and parameters for MongoDB versions 2.6 and later.
74+
To learn more, see :ref:`om-unsupported-mdb-settings`.
7375

7476
* - processes[n].alias
7577
- string

source/includes/api/list-tables/controlled-features-request.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -88,6 +88,6 @@
8888
| ``.disabledParams``
8989
- array
9090
- List of |mongod| settings to disable when you apply the
91-
``DISABLE_SET_MONGOD_CONFIG`` policy. For information about
92-
accepted values, see :doc:`Supported MongoDB Options for
93-
Automation </reference/cluster-configuration-process-options>`.
91+
``DISABLE_SET_MONGOD_CONFIG`` policy. Automation doesn't support
92+
all MongoDB options, which can result in failed import attempts.
93+
To learn more, see :ref:`om-unsupported-mdb-settings`.

source/includes/api/list-tables/controlled-features-response.rst

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -101,6 +101,6 @@
101101
| ``.disabledParams``
102102
- array
103103
- List of |mongod| settings to disable if you apply the
104-
``DISABLE_SET_MONGOD_CONFIG`` policy. For information about
105-
possible values, see :doc:`Supported MongoDB Options for
106-
Automation </reference/cluster-configuration-process-options>`.
104+
``DISABLE_SET_MONGOD_CONFIG`` policy. Automation doesn't support
105+
all MongoDB options, which can result in failed import attempts.
106+
To learn more, see :ref:`om-unsupported-mdb-settings`.

source/includes/steps-create-cluster-through-api.yaml

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -82,8 +82,9 @@ content: |
8282
cluster.
8383
8484
Specify the ``args2_6`` syntax for the ``processes.<args>`` field.
85-
See :doc:`/reference/cluster-configuration-process-options` for more
86-
information.
85+
The ``processes.args2_6`` object accepts most MongoDB settings and
86+
parameters for MongoDB versions 2.6 and later. To learn more, see
87+
:ref:`om-unsupported-mdb-settings`.
8788
8889
.. code-block:: javascript
8990
:linenos:

source/includes/toc-reference.yaml

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -44,8 +44,8 @@ edition:
4444
---
4545
file: /reference/cluster-configuration-process-options
4646
description: |
47-
Supported options for a MongoDB process as specified in the automation
48-
configuration file.
47+
Supported and unsupported options for a MongoDB process as specified
48+
in the automation configuration file.
4949
---
5050
file: /reference/required-permissions-aws-user
5151
description: |

source/reference.txt

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -31,8 +31,8 @@ Reference
3131
determine the desired state of the MongoDB deployment.
3232

3333
:doc:`/reference/cluster-configuration-process-options`
34-
Supported options for a MongoDB process as specified in the automation
35-
configuration file.
34+
Supported and unsupported options for a MongoDB process as specified
35+
in the automation configuration file.
3636

3737
:doc:`/reference/monitoring`
3838
A reference sheet for the monitoring service.
Lines changed: 12 additions & 16 deletions
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,8 @@
1-
=========================================
2-
MongoDB Settings that Automation Supports
3-
=========================================
1+
.. _om-unsupported-mdb-settings:
2+
3+
=======================================
4+
MongoDB Settings and Automation Support
5+
=======================================
46

57
.. default-domain:: mongodb
68

@@ -22,18 +24,12 @@ Unsupported Settings
2224

2325
This object doesn't support the following settings:
2426

25-
- :setting:`net.tls.allowInvalidCertificates`
26-
- :setting:`net.tls.allowInvalidHostnames`
27+
.. important::
28+
29+
Specific security-related settings, such as LDAP settings, TLS
30+
settings related to the Certificate Authority, and Authentication
31+
settings, are managed at the project level and may be overridden
32+
upon import into Automation.
33+
2734
- :configexpansion:`__exec`
2835
- :configexpansion:`__rest`
29-
- :setting:`security.ldap.servers`
30-
- :setting:`security.ldap.bind.queryUser`
31-
- :setting:`security.ldap.bind.queryPassword`
32-
- :setting:`security.ldap.bind.useOSDefaults`
33-
- :setting:`security.ldap.bind.method`
34-
- :setting:`security.ldap.bind.saslMechanisms`
35-
- :setting:`security.ldap.transportSecurity`
36-
- :setting:`security.ldap.timeoutMS`
37-
- :setting:`security.ldap.userToDNMapping`
38-
- :setting:`security.ldap.authz.queryTemplate`
39-
- :setting:`security.ldap.validateLDAPServerConfig`

source/tutorial/add-existing-mongodb-processes.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -37,8 +37,9 @@ Deployments must have unique names within the projects.
3737
MongoDB Configuration Options
3838
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
3939

40-
Automation doesn't support all MongoDB options. To review which options
41-
are supported, see :doc:`/reference/cluster-configuration-process-options`.
40+
Automation doesn't support all MongoDB options, which can result in
41+
failed import attempts. To learn more, see
42+
:ref:`om-unsupported-mdb-settings`.
4243

4344
|tls|
4445
~~~~~

source/tutorial/add-monitored-deployment-to-automation.txt

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -27,9 +27,9 @@ and deploy changes as needed.
2727
Considerations
2828
--------------
2929

30-
Automation supports most but not all available MongoDB options. See
31-
:doc:`/reference/cluster-configuration-process-options` for unsupported
32-
MongoDB deployment options.
30+
Automation doesn't support all MongoDB options, which can result in
31+
failed import attempts. To learn more, see
32+
:ref:`om-unsupported-mdb-settings`.
3333

3434
When adding a MongoDB deployment requiring authentication, you have the
3535
option of importing that process's users and roles. During import,

source/tutorial/update-mongodb-version-of-deployment-via-api.txt

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -21,8 +21,9 @@ as would be the case if you used the tutorial to
2121
Consideration
2222
-------------
2323

24-
The |api| supports the MongoDB options listed on the
25-
:doc:`/reference/cluster-configuration-process-options` page.
24+
The |api| supports most MongoDB settings and parameters for MongoDB
25+
versions 2.6 and later. To learn more, see
26+
:ref:`om-unsupported-mdb-settings`.
2627

2728
.. _api-tutorial-update-mongodb-version-variables:
2829

0 commit comments

Comments
 (0)