Skip to content

Commit 2218114

Browse files
jwilliams-mongojwilliams-mongo
authored
(DOCSP-12020): agent.startupOptions (#365)
* (DOCSP-12020): agent.startupOptions * (DOCSP-12020): option -> setting * (DOCSP-12020): option -> setting pt 2 * (DOCSP-12020): language tweaks * (DOCSP-12020): fix highlights * (DOCSP-12020): setting fix * (DOCSP-12020): adding components to spec.agent * (DOCSP-12020): fix copy/paste error * (DOCSP-12020): remove comments from samples
1 parent dfff813 commit 2218114

7 files changed

+215
-2
lines changed

‎source/includes/code-examples/yaml-files/example-sharded-agent-settings.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,32 @@
1+
---
2+
apiVersion: mongodb.com/v1
3+
kind: MongoDB
4+
metadata:
5+
name: my-sharded-cluster-options
6+
spec:
7+
version: 4.4.0-ent
8+
type: ShardedCluster
9+
opsManager:
10+
configMapRef:
11+
name: my-project
12+
credentials: my-credentials
13+
persistent: true
14+
shardCount: 2
15+
mongodsPerShardCount: 3
16+
mongosCount: 2
17+
configServerCount: 1
18+
19+
mongos:
20+
agent:
21+
startupOptions:
22+
maxLogFiles: "30"
23+
24+
configSrv:
25+
agent:
26+
startupOptions:
27+
dialTimeoutSeconds: "40"
28+
shard:
29+
agent:
30+
startupOptions:
31+
serverSelectionTimeoutSeconds: "20"
32+
...

‎source/includes/code-examples/yaml-files/example-standalone-agent-settings.yaml

Lines changed: 21 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,21 @@
1+
---
2+
apiVersion: mongodb.com/v1
3+
kind: MongoDB
4+
metadata:
5+
name: my-standalone
6+
spec:
7+
version: 4.4.0-ent
8+
service: my-service
9+
10+
opsManager:
11+
configMapRef:
12+
name: my-project
13+
credentials: my-credentials
14+
type: Standalone
15+
16+
persistent: true
17+
agent:
18+
startupOptions:
19+
maxLogFiles: "30"
20+
dialTimeoutSeconds: "40"
21+
...

‎source/includes/options-k8s-shared.yaml

Lines changed: 32 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1203,4 +1203,36 @@ description: |
12031203
MongoDB Manual for the MongoDB versions you deploy with the
12041204
|k8s-op-short|.
12051205
1206+
---
1207+
program: _shared
1208+
name: spec.agent
1209+
type: collection
1210+
directive: setting
1211+
optional: true
1212+
description: |
1213+
1214+
{+mdbagent+} configuration settings for the {{component}}.
1215+
1216+
---
1217+
program: _shared
1218+
name: spec.agent.startupOptions
1219+
type: collection
1220+
directive: setting
1221+
optional: true
1222+
description: |
1223+
1224+
{+mdbagent+} settings with which you want to start the {{component}}.
1225+
1226+
You must provide MongoDB Agent settings as key-value pairs. The values
1227+
must be strings.
1228+
1229+
For a list of supported {+mdbagent+} settings, see:
1230+
1231+
- :cloudmgr:`MongoDB Agent Settings </reference/mongodb-agent-settings/>`
1232+
for |cloud-short| projects.
1233+
- :opsmgr:`MongoDB Agent Settings
1234+
</reference/mongodb-agent-settings/>` for the |onprem| version you
1235+
deployed with the |k8s-op-short|.
1236+
1237+
{{example}}
12061238
...

‎source/includes/options-k8s-shared_cluster.yaml

Lines changed: 90 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -397,6 +397,36 @@ replacement:
397397
component: config servers
398398
---
399399
program: k8sScConf
400+
name: spec.configSrv.agent
401+
type: collection
402+
directive: setting
403+
optional: true
404+
inherit:
405+
name: spec.agent
406+
program: _shared
407+
file: options-k8s-shared.yaml
408+
replacement:
409+
component: config servers
410+
---
411+
program: k8sScConf
412+
name: spec.configSrv.agent.startupOptions
413+
type: collection
414+
directive: setting
415+
optional: true
416+
inherit:
417+
name: spec.agent.startupOptions
418+
program: _shared
419+
file: options-k8s-shared.yaml
420+
replacement:
421+
component: config servers
422+
example: |
423+
424+
.. literalinclude:: /includes/code-examples/yaml-files/example-sharded-agent-settings.yaml
425+
:language: yaml
426+
:linenos:
427+
:emphasize-lines: 24-27
428+
---
429+
program: k8sScConf
400430
name: spec.mongosPodSpec.cpu
401431
type: number
402432
directive: setting
@@ -547,7 +577,36 @@ inherit:
547577
file: options-k8s-shared.yaml
548578
replacement:
549579
component: '``mongos`` instances'
550-
580+
---
581+
program: k8sScConf
582+
name: spec.mongos.agent
583+
type: collection
584+
directive: setting
585+
optional: true
586+
inherit:
587+
name: spec.agent
588+
program: _shared
589+
file: options-k8s-shared.yaml
590+
replacement:
591+
component: "``mongos``"
592+
---
593+
program: k8sScConf
594+
name: spec.mongos.agent.startupOptions
595+
type: collection
596+
directive: setting
597+
optional: true
598+
inherit:
599+
name: spec.agent.startupOptions
600+
program: _shared
601+
file: options-k8s-shared.yaml
602+
replacement:
603+
component: "``mongos``"
604+
example: |
605+
606+
.. literalinclude:: /includes/code-examples/yaml-files/example-sharded-agent-settings.yaml
607+
:language: yaml
608+
:linenos:
609+
:emphasize-lines: 19-22
551610
---
552611
program: k8sScConf
553612
name: spec.shardPodSpec.cpu
@@ -799,4 +858,34 @@ inherit:
799858
file: options-k8s-shared.yaml
800859
replacement:
801860
component: MongoDB processes
861+
---
862+
program: k8sScConf
863+
name: spec.shard.agent
864+
type: collection
865+
directive: setting
866+
optional: true
867+
inherit:
868+
name: spec.agent
869+
program: _shared
870+
file: options-k8s-shared.yaml
871+
replacement:
872+
component: shards
873+
---
874+
program: k8sScConf
875+
name: spec.shard.agent.startupOptions
876+
type: collection
877+
directive: setting
878+
optional: true
879+
inherit:
880+
name: spec.agent.startupOptions
881+
program: _shared
882+
file: options-k8s-shared.yaml
883+
replacement:
884+
component: shards
885+
example: |
886+
887+
.. literalinclude:: /includes/code-examples/yaml-files/example-sharded-agent-settings.yaml
888+
:language: yaml
889+
:linenos:
890+
:emphasize-lines: 28-31
802891
...

‎source/includes/options-k8s-standalone.yaml

Lines changed: 30 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -418,5 +418,34 @@ inherit:
418418
file: options-k8s-shared.yaml
419419
replacement:
420420
component: MongoDB processes
421-
421+
---
422+
program: k8sSaConf
423+
name: spec.agent
424+
type: collection
425+
directive: setting
426+
optional: true
427+
inherit:
428+
name: spec.agent
429+
program: _shared
430+
file: options-k8s-shared.yaml
431+
replacement:
432+
component: MongoDB database resource
433+
---
434+
program: k8sSaConf
435+
name: spec.agent.startupOptions
436+
type: collection
437+
directive: setting
438+
optional: true
439+
inherit:
440+
name: spec.agent.startupOptions
441+
program: _shared
442+
file: options-k8s-shared.yaml
443+
replacement:
444+
component: MongoDB database resource
445+
example: |
446+
447+
.. literalinclude:: /includes/code-examples/yaml-files/example-standalone-agent-settings.yaml
448+
:language: yaml
449+
:linenos:
450+
:emphasize-lines: 17-20
422451
...

‎source/reference/k8s-operator-om-specification.txt

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -142,6 +142,8 @@ Optional |onprem| Resource Settings
142142
optional:
143143

144144
- ``spec.applicationDatabase.``:setting:`~spec.additionalMongodConfig`
145+
- ``spec.applicationDatabase.``:setting:`~spec.agent`
146+
- ``spec.applicationDatabase.agent.``:setting:`~spec.agent.startupOptions`
145147
- ``spec.applicationDatabase.``:setting:`~spec.featureCompatibilityVersion`
146148
- ``spec.applicationDatabase.``:setting:`~spec.logLevel`
147149
- ``spec.applicationDatabase.``:setting:`~spec.persistent`

‎source/reference/k8s-operator-specification.txt

Lines changed: 8 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -114,6 +114,8 @@ Standalone Settings
114114
resources.
115115

116116
.. include:: /includes/option/setting-k8sSaConf-spec.additionalMongodConfig.rst
117+
.. include:: /includes/option/setting-k8sSaConf-spec.agent.rst
118+
.. include:: /includes/option/setting-k8sSaConf-spec.agent.startupOptions.rst
117119
.. include:: /includes/option/setting-k8sSaConf-spec.exposedExternally.rst
118120
.. include:: /includes/option/setting-k8sSaConf-spec.podSpec.cpu.rst
119121
.. include:: /includes/option/setting-k8sSaConf-spec.podSpec.cpuRequests.rst
@@ -155,6 +157,8 @@ The following settings only apply to sharded cluster resource types:
155157
.. include:: /includes/option/setting-k8sSaConf-spec.exposedExternally.rst
156158
.. include:: /includes/option/setting-k8sScConf-spec.configServerCount.rst
157159
.. include:: /includes/option/setting-k8sScConf-spec.configSrv.additionalMongodConfig.rst
160+
.. include:: /includes/option/setting-k8sScConf-spec.configSrv.agent.rst
161+
.. include:: /includes/option/setting-k8sScConf-spec.configSrv.agent.startupOptions.rst
158162
.. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.cpu.rst
159163
.. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.cpuRequests.rst
160164
.. include:: /includes/option/setting-k8sScConf-spec.configSrvPodSpec.memory.rst
@@ -172,6 +176,8 @@ The following settings only apply to sharded cluster resource types:
172176
.. include:: /includes/option/setting-k8sScConf-spec.mongodsPerShardCount.rst
173177
.. include:: /includes/option/setting-k8sScConf-spec.mongosCount.rst
174178
.. include:: /includes/option/setting-k8sScConf-spec.mongos.additionalMongodConfig.rst
179+
.. include:: /includes/option/setting-k8sScConf-spec.mongos.agent.rst
180+
.. include:: /includes/option/setting-k8sScConf-spec.mongos.agent.startupOptions.rst
175181
.. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.cpu.rst
176182
.. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.cpuRequests.rst
177183
.. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.memory.rst
@@ -184,6 +190,8 @@ The following settings only apply to sharded cluster resource types:
184190
.. include:: /includes/option/setting-k8sScConf-spec.mongosPodSpec.podTemplate.spec.rst
185191
.. include:: /includes/option/setting-k8sScConf-spec.shardCount.rst
186192
.. include:: /includes/option/setting-k8sScConf-spec.shard.additionalMongodConfig.rst
193+
.. include:: /includes/option/setting-k8sScConf-spec.shard.agent.rst
194+
.. include:: /includes/option/setting-k8sScConf-spec.shard.agent.startupOptions.rst
187195
.. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.cpu.rst
188196
.. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.cpuRequests.rst
189197
.. include:: /includes/option/setting-k8sScConf-spec.shardPodSpec.memory.rst

0 commit comments

Comments
 (0)