(DOCSP-11014): MongoDB resource: support for 'additionalMongodConfig' (#324)

jwilliams-mongo · jwilliams-mongo · commit 79e7e22bd094 · 2025-04-14T17:11:16.000-05:00
* (DOCSP-11014): MongoDB resource: support for 'additionalMongodConfig' * (DOCSP-11014): fix build warnings * (DOCSP-11014): addressing follow-up questions to engineering * (DOCSP-11014): update link formatting * (DOCSP-11014): tech review feedback * (DOCSP-11014): tech review feedback pt 2
diff --git a/source/includes/options-k8s-shared.yaml b/source/includes/options-k8s-shared.yaml
@@ -812,4 +812,40 @@ description: |
 
      2. Approve the |csr|\s after |k8s| generates them.
 
+---
+
+program: _shared
+name: spec.additionalMongodConfig
+type: collection
+directive: setting
+optional: true
+description: |
+  Additional :manual:`configuration options
+  </reference/configuration-options/#configuration-file-options>` with
+  which you want to start {{component}}.
+
+  The |k8s-op-short| supports all configuration options that the MongoDB
+  version you deploy supports, except that the |k8s-op-short| overrides
+  values that you provide for any of the following options:
+
+  - :setting:`net.port`
+  - :setting:`net.tls.certificateKeyFile`
+  - :setting:`net.tls.clusterFile`
+  - :setting:`net.tls.PEMKeyFile`
+  - :setting:`replication.replSetName`
+  - :setting:`security.clusterAuthMode`
+  - :setting:`sharding.clusterRole`
+  - :setting:`storage.dbPath`
+  - :setting:`systemLog.destination`
+  - :setting:`systemLog.path`
+
+  To learn more about the configuration options that the |k8s-op-short|
+  owns, see :ref:`k8s-exclusive-settings`.
+
+  To see which configuration options you can use, see
+  :manual:`Configuration File Options
+  </reference/configuration-options/#configuration-file-options>` in the
+  MongoDB Manual for the MongoDB versions you deploy with the
+  |k8s-op-short|.
+
 ...
diff --git a/source/includes/options-k8s-shared_cluster.yaml b/source/includes/options-k8s-shared_cluster.yaml
@@ -385,6 +385,18 @@ replacement:
   podTemplate_spec_containers: '``spec.configSrvPodSpec.podTemplate.spec.containers``'
 ---
 program: k8sScConf
+name: spec.configSrv.additionalMongodConfig
+type: collection
+directive: setting
+optional: true
+inherit:
+  name: spec.additionalMongodConfig
+  program: _shared
+  file: options-k8s-shared.yaml
+replacement:
+  component: config servers
+---
+program: k8sScConf
 name: spec.mongosPodSpec.cpu
 type: number
 directive: setting
@@ -523,6 +535,18 @@ replacement:
   component: '``mongos`` instances'
   podTemplate_spec: '``spec.mongosPodSpec.podTemplate.spec``'
   podTemplate_spec_containers: '``spec.mongosPodSpec.podTemplate.spec.containers``'
+---
+program: k8sScConf
+name: spec.mongos.additionalMongodConfig
+type: collection
+directive: setting
+optional: true
+inherit:
+  name: spec.additionalMongodConfig
+  program: _shared
+  file: options-k8s-shared.yaml
+replacement:
+  component: '``mongos`` instances'
 
 ---
 program: k8sScConf
@@ -763,4 +787,16 @@ replacement:
   component: MongoDB database resources
   podTemplate_spec: '``spec.shardPodSpec.podTemplate.spec``'
   podTemplate_spec_containers: '``spec.shardPodSpec.podTemplate.spec.containers``'
+---
+program: k8sScConf
+name: spec.shard.additionalMongodConfig
+type: collection
+directive: setting
+optional: true
+inherit:
+  name: spec.additionalMongodConfig
+  program: _shared
+  file: options-k8s-shared.yaml
+replacement:
+  component: MongoDB processes
 ...
diff --git a/source/includes/options-k8s-standalone.yaml b/source/includes/options-k8s-standalone.yaml
@@ -406,5 +406,17 @@ replacement:
   component: MongoDB database resources
   podTemplate_spec: '``spec.podSpec.podTemplate.spec``'
   podTemplate_spec_containers: '``spec.podSpec.podTemplate.spec.containers``'
+---
+program: k8sSaConf
+name: spec.additionalMongodConfig
+type: collection
+directive: setting
+optional: true
+inherit:
+  name: spec.additionalMongodConfig
+  program: _shared
+  file: options-k8s-shared.yaml
+replacement:
+  component: MongoDB processes
 
 ...
diff --git a/source/includes/steps-deploy-k8s-standalone.yaml b/source/includes/steps-deploy-k8s-standalone.yaml
@@ -139,6 +139,7 @@ content: |
   You can also add any of the following optional settings to the
   |k8s-obj| specification file for a Standalone deployment:
 
+  - :setting:`spec.additionalMongodConfig`
   - :setting:`spec.exposedExternally`
   - :setting:`spec.logLevel`
   - :setting:`spec.featureCompatibilityVersion`
diff --git a/source/includes/steps-source-deploy-k8s-resource.yaml b/source/includes/steps-source-deploy-k8s-resource.yaml
@@ -150,6 +150,7 @@ content: |
   You can also add any of the following optional settings to the
   |k8s-obj| specification file for a {{k8sResource}} deployment:
 
+  - :setting:`spec.additionalMongodConfig`
   - :setting:`spec.clusterDomain`
   - :setting:`spec.featureCompatibilityVersion`
   - :setting:`spec.logLevel`
@@ -190,6 +191,7 @@ content: |
 
   **For config server**
 
+  - :setting:`spec.configSrv.additionalMongodConfig`
   - :setting:`spec.configSrvPodSpec.cpu`
   - :setting:`spec.configSrvPodSpec.cpuRequests`
   - :setting:`spec.configSrvPodSpec.memory`
@@ -206,6 +208,7 @@ content: |
 
   **For shard routers**
 
+  - :setting:`spec.mongos.additionalMongodConfig`
   - :setting:`spec.mongosPodSpec.cpu`
   - :setting:`spec.mongosPodSpec.cpuRequests`
   - :setting:`spec.mongosPodSpec.memory`
@@ -218,6 +221,7 @@ content: |
 
   **For shard members**
 
+  - :setting:`spec.shard.additionalMongodConfig`
   - :setting:`spec.shardPodSpec.cpu`
   - :setting:`spec.shardPodSpec.cpuRequests`
   - :setting:`spec.shardPodSpec.memory`
diff --git a/source/reference/k8s-op-exclusive-settings.txt b/source/reference/k8s-op-exclusive-settings.txt
@@ -45,10 +45,14 @@ page:
 - ``auth.usersWanted[n].user``
 - ``auth.usersWanted[n].authenticationRestrictions``
 - :setting:`processes.args2_6.net.port <net.port>`
-- ``processes.args2_6.net.ssl.clusterAuthFile``
+- :setting:`processes.args2_6.net.tls.certificateKeyFile <net.tls.certificateKeyFile>`
+- :setting:`processes.args2_6.net.tls.clusterFile <net.tls.clusterFile>`
+- :setting:`processes.args2_6.net.tls.PEMKeyFile <net.tls.PEMKeyFile>`
 - :setting:`processes.args2_6.replication.replSetName <replication.replSetName>`
+- :setting:`processes.args2_6.sharding.clusterRole <sharding.clusterRole>`
 - :setting:`processes.args2_6.security.clusterAuthMode <security.clusterAuthMode>`
 - :setting:`processes.args2_6.storage.dbPath <storage.dbPath>`
+- :setting:`processes.args2_6.systemLog.destination <systemLog.destination>`
 - :setting:`processes.args2_6.systemLog.path <systemLog.path>`
 - ``processes.authSchemaVersion``
 - ``processes.cluster`` (mongos processes)
diff --git a/source/reference/k8s-operator-om-specification.txt b/source/reference/k8s-operator-om-specification.txt
@@ -139,9 +139,10 @@ Optional |onprem| Resource Settings
    :ref:`replica set <replica-set-settings>` resource specification are
    optional:
 
-   - ``spec.applicationDatabase.``:setting:`~spec.persistent`
-   - ``spec.applicationDatabase.``:setting:`~spec.logLevel`
+   - ``spec.applicationDatabase.``:setting:`~spec.additionalMongodConfig`
    - ``spec.applicationDatabase.``:setting:`~spec.featureCompatibilityVersion`
+   - ``spec.applicationDatabase.``:setting:`~spec.logLevel`
+   - ``spec.applicationDatabase.``:setting:`~spec.persistent`
    - ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.cpu`
    - ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.cpuRequests`
    - ``spec.applicationDatabase.podSpec.``:setting:`~spec.podSpec.memory`
diff --git a/source/reference/k8s-operator-specification.txt b/source/reference/k8s-operator-specification.txt
@@ -108,6 +108,12 @@ depend upon which MongoDB deployment item you want to create:
 Standalone Settings
 ~~~~~~~~~~~~~~~~~~~
 
+.. note::
+
+   All of the :ref:`standalone-settings` also apply to replica set
+   resources.
+
+.. include:: /includes/option/setting-k8sSaConf-spec.additionalMongodConfig.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.exposedExternally.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.podSpec.cpu.rst
 .. include:: /includes/option/setting-k8sSaConf-spec.podSpec.cpuRequests.rst
@@ -148,6 +154,7 @@ The following settings only apply to sharded cluster resource types:
 
 .. include:: /includes/option/setting-k8sSaConf-spec.exposedExternally.rst
 .. include:: /includes/option/setting-k8sScConf-spec.configServerCount.rst
+.. include:: /includes/option/setting-k8sScConf-spec.configSrv.additionalMongodConfig.rst
 .. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.cpu.rst
 .. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.cpuRequests.rst
 .. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.memory.rst
@@ -164,6 +171,7 @@ The following settings only apply to sharded cluster resource types:
 .. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.podTemplate.spec.rst
 .. include:: /includes/option/setting-k8sScConf-spec.mongodsPerShardCount.rst
 .. include:: /includes/option/setting-k8sScConf-spec.mongosCount.rst
+.. include:: /includes/option/setting-k8sScConf-spec.mongos.additionalMongodConfig.rst
 .. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.cpu.rst
 .. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.cpuRequests.rst
 .. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.memory.rst
@@ -175,6 +183,7 @@ The following settings only apply to sharded cluster resource types:
 .. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.podTemplate.metadata.rst
 .. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.podTemplate.spec.rst
 .. include:: /includes/option/setting-k8sScConf-spec.shardCount.rst
+.. include:: /includes/option/setting-k8sScConf-spec.shard.additionalMongodConfig.rst
 .. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.cpu.rst
 .. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.cpuRequests.rst
 .. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.memory.rst
diff --git a/source/reference/k8s/replicasetpodspec.yaml b/source/reference/k8s/replicasetpodspec.yaml
@@ -68,5 +68,5 @@ spec:
   additionalMongodConfig:
     net:
       ssl:
-        mode: requireSSL
+        mode: preferSSL
 ...
diff --git a/source/reference/k8s/shardedclusterpodspec.yaml b/source/reference/k8s/shardedclusterpodspec.yaml
@@ -88,15 +88,25 @@ spec:
           storage: 4Gi
           storageClass: standard
     podAntiAffinityTopologyKey: kubernetes.io/hostname
+  mongos:
+    additionalMongodConfig:
+      systemLog:
+        logAppend: true
+        verbosity: 4
+  configSrv:
+    additionalMongodConfig:
+      operationProfiling:
+        mode: slowOp
+  shard:
+    additionalMongodConfig:
+      storage:
+        journal:
+          commitIntervalMs: 50
   security:
     tls:
       enabled: true
     authentication:
       enabled: true
       modes: ["X509"]
       internalCluster: "X509"
-  additionalMongodConfig:
-    net:
-      ssl:
-        mode: requireSSL
 ...
diff --git a/source/reference/k8s/standalonepodspec.yaml b/source/reference/k8s/standalonepodspec.yaml
@@ -11,6 +11,12 @@ spec:
   credentials: my-credentials
   persistent: true
   type: Standalone
+  additionalMongodConfig:
+    systemLog:
+      logAppend: true
+      verbosity: 4
+    operationProfiling:
+      mode: slowOp
   podSpec:
     cpu: '0.25'
     memory: 512M
