Skip to content

Commit a150825

Browse files
jeff-allen-mongojwilliams-mongo
authored andcommitted
(DOCSP-7027): Clarifying behavior for unsupported mongod cmd line opt… (#94)
* (DOCSP-7027): Clarifying behavior for unsupported mongod cmd line options * Updates per Chris' feedback * Updates per Cian's feedback
1 parent 0f00f23 commit a150825

7 files changed

+27
-34
lines changed
Lines changed: 6 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,6 @@
1+
MongoDB custom resources do not support all
2+
:binary:`~bin.mongod` command line options. If you use an
3+
unsupported option in your object specification file, the backing
4+
:opsmgr:`MongoDB Agent </tutorial/nav/mongodb-agent/>`
5+
overrides the unsupported options. For a complete list of options
6+
supported by MongoDB custom resources, see :ref:`k8s-specification`.

source/includes/steps-deploy-k8s-replica-set-tls.yaml

Lines changed: 4 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -82,6 +82,10 @@ content: |
8282
8383
.. include:: /includes/list-table-requiressl-modes.rst
8484
85+
.. note::
86+
87+
.. include:: /includes/fact-unsupported-mongod-options.rst
88+
8589
---
8690
stepnum: 5
8791
level: 4

source/includes/steps-deploy-k8s-sharded-cluster.yaml

Lines changed: 4 additions & 20 deletions
Original file line numberDiff line numberDiff line change
@@ -186,24 +186,8 @@ content: |
186186
- ``true``
187187
188188
---
189-
title: "If you wish to enable TLS on your sharded cluster, add the TLS settings to the ConfigMap."
190-
stepnum: 4
191-
level: 4
192-
ref: add-tls-settings-sc
193-
source:
194-
file: steps-deploy-k8s-replica-set-tls.yaml
195-
ref: add-tls-settings
196-
replacement:
197-
example: |
198-
The following example |k8s-configmap| configures a replica set to use
199-
|tls|:
200-
201-
.. literalinclude:: /reference/k8s/example-sharded-cluster-tls.yaml
202-
:language: yaml
203-
:emphasize-lines: 19-25
204-
---
205189
title: "Add any additional accepted settings for a :term:`sharded cluster` deployment."
206-
stepnum: 5
190+
stepnum: 4
207191
level: 4
208192
ref: add-k8s-values
209193
content: |
@@ -256,13 +240,13 @@ content: |
256240
257241
---
258242
title: "Save this file with a ``.yaml`` file extension."
259-
stepnum: 6
243+
stepnum: 5
260244
level: 4
261245
ref: save-object-spec
262246

263247
---
264248
title: "Start your :term:`sharded cluster` deployment."
265-
stepnum: 7
249+
stepnum: 6
266250
level: 4
267251
ref: start-k8s-sharded-cluster
268252
content: |
@@ -284,7 +268,7 @@ content: |
284268
285269
---
286270
title: "Track the status of your :term:`sharded cluster` deployment."
287-
stepnum: 8
271+
stepnum: 7
288272
level: 4
289273
ref: track-k8s-deployment
290274
content: |

source/tutorial/deploy-replica-set.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ Prerequisites
3636
Considerations
3737
--------------
3838

39-
Unique Names for Replica Set
40-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41-
4239
Use a unique name for the replica set.
4340

4441
.. include:: /includes/important-unique-names-deployment-items.rst

source/tutorial/deploy-sharded-cluster.txt

Lines changed: 0 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -36,9 +36,6 @@ Prerequisites
3636
Considerations
3737
--------------
3838

39-
Unique Names for Sharded Clusters
40-
~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
41-
4239
Use unique names for the new cluster and its shards.
4340

4441
.. include:: /includes/important-unique-names-deployment-items.rst

source/tutorial/edit-deployment.txt

Lines changed: 12 additions & 7 deletions
Original file line numberDiff line numberDiff line change
@@ -43,16 +43,21 @@ Procedure
4343

4444
kubectl apply -f <standalone-conf>.yaml
4545

46-
.. note::
46+
Considerations
47+
--------------
4748

48-
- Changes cannot be made to individual members of a replica set or
49-
sharded cluster, only to the whole set or cluster.
49+
- Changes cannot be made to individual members of a replica set or
50+
sharded cluster, only to the whole set or cluster.
5051

51-
- If a setting is not available for a MongoDB Kubernetes resource,
52-
then the change must be made in the |application|.
52+
- If a setting is not available for a MongoDB Kubernetes resource,
53+
then the change must be made in the |mms| or
54+
`Cloud Manager <docs.cloudmanager.com/current/>`__ application.
55+
56+
- .. include:: /includes/fact-unsupported-mongod-options.rst
5357

54-
- You can set some settings using |k8s-op-short| only. To review the
55-
list of settings, see :doc:`/reference/k8s-op-exclusive-settings`.
58+
- Certain settings can only be configured using |k8s-op-short|. To
59+
review the list of settings,
60+
see :doc:`/reference/k8s-op-exclusive-settings`.
5661

5762
.. toctree::
5863
:titlesonly:

source/tutorial/upgrade-mdb-version.txt

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -91,5 +91,5 @@ upgrade the deployment's MongoDB version to ``4.0.6``:
9191
|k8s| automatically reconfigures your deployment with the new
9292
specifications. You can see these changes reflected in the
9393
|mms| or `Cloud Manager <docs.cloudmanager.com/current/>`__
94-
:abbr:`UI (User Interface)`.
94+
application.
9595

0 commit comments

Comments
 (0)