- Reference >
- MongoDB Database Resource Specification
MongoDB Database Resource Specification¶
On this page
Note
At any place on this page that says Ops Manager, you can substitute Cloud Manager.
The MongoDB Enterprise Kubernetes Operator creates Kubernetes StatefulSets from specification files that you wrote.
MongoDB resources are created in Kubernetes as custom resources. After you create or update a MongoDB Kubernetes resource specification, you direct MongoDB Enterprise Kubernetes Operator to apply this specification to your Kubernetes environment. Kubernetes Operator creates the defined StatefulSets, services and other Kubernetes resources. After the Operator finishes creating those objects, it updates the Ops Manager deployment configuration to reflect changes.
Deployment Type | StatefulSets | Size of StatefulSet |
---|---|---|
Standalone | 1 | 1 pod |
Replica Set | 1 | 1 pod per member |
Sharded Cluster | <numberOfShards> + 2 | 1 pod per mongos , shard, or config server member |
Each MongoDB Kubernetes resource uses an object specification in YAML to define the characteristics and settings of the MongoDB object: standalone, replica set, and sharded cluster.
Common Resource Settings¶
Every resource type must use the following settings:
Required¶
-
apiVersion
¶ Type: string
Version of the MongoDB Kubernetes resource schema.
-
kind
¶ Type: string
Kind of MongoDB Kubernetes resource to create. Set this to
MongoDB
-
metadata.
name
¶ Type: string
Name of the MongoDB Kubernetes resource you are creating.
Resource names must be 44 characters or less.
-
spec.
credentials
¶ Type: string
Required. Name of the Kubernetes secret you created as Ops Manager API authentication credentials for the Kubernetes Operator to communicate with Cloud Manager or Ops Manager.
Value must use namespace and name of Secret
This value must match the namespace in which you created the secret and the
name
value you provided for your Ops Manager Kubernetes Secret.Operator manages changes to the Secret
The Kubernetes Operator tracks any changes to the Secret and reconciles the state of the MongoDB Kubernetes resource.
-
spec.
persistent
¶ Type: boolean
Default: True
Warning
Your containers must have permissions to write to your Persistent Volume. The Kubernetes Operator sets
fsGroup = 2000
in securityContext This makes Kubernetes try to fix write permissions for the Persistent Volume. If redeploying the deployment item does not fix issues with your Persistent Volumes, contact MongoDB Support.Note
If you do not use Persistent Volumes, the Disk Usage and Disk IOPS charts cannot be displayed in either the Processes tab on the Deployment page or in the Metrics page when reviewing the data for this deployment.
-
spec.
type
¶ Type: string
Type of MongoDB Kubernetes resource to create. Accepted values are:
Standalone
ReplicaSet
ShardedCluster
-
spec.
version
¶ Type: number
Version of MongoDB that is installed on this MongoDB Kubernetes resource.
Note
If you update this value to a later version, consider setting
spec.featureCompatibilityVersion
to give yourself the option to downgrade if necessary.
Conditional¶
Every resource must use one of the following settings:
-
spec.opsManager.configMapRef.
name
¶ Type: string
Name of the ConfigMap with the Cloud Manager or Ops Manager connection configuration. The
spec.cloudManager.configMapRef.name
setting is an alias for this setting and can be used in its place.Value must match namespace and name of ConfigMap
This value must match the namespace in which you created the Ops Manager project ConfigMap.
Operator manages changes to the ConfigMap
The Kubernetes Operator tracks any changes to the ConfigMap and reconciles the state of the MongoDB Kubernetes resource.
(Changed in version 1.3):
In prior versions of the MongoDB Enterprise Kubernetes Operator, this setting was
spec.project
. See the v1.2 documentation for information on the previous setting name.
-
spec.cloudManager.configMapRef.
name
¶ Type: string
Alias for
spec.opsManager.configMapRef.name
.
Optional¶
Every resource type may use the following settings:
-
metadata.
namespace
¶ Type: string
Kubernetes namespace where this MongoDB Kubernetes resource and other objects are created.
-
spec.
featureCompatibilityVersion
¶ Type: number
Limits changes to data that occur with an upgrade to a new major version. This allows you to downgrade to the previous major version. To learn more about feature compatibility, see
setFeatureCompatibilityVersion
in the MongoDB Manual.
-
spec.
clusterDomain
¶ Type: string
Default: cluster.local
Domain name of the Kubernetes cluster where you deploy the Operator. When Kubernetes creates a StatefulSet, the Kubernetes assigns each pod a FQDN. To update Cloud Manager or Ops Manager, the Kubernetes Operator calculates the FQDN for each pod using a provided cluster name. Kubernetes doesn’t provide an API to query these hostnames.
Warning
You must set
spec.clusterDomain
if your Kubernetes cluster has a default domain other than the defaultcluster.local
. If you neither use the default nor set thespec.clusterDomain
option, the Kubernetes Operator might not function as expected.
-
spec.
clusterName
¶ Type: string
Default: cluster.local
spec.clusterName
is DeprecatedUse
spec.clusterDomain
instead.Domain name of the Kubernetes cluster where you deploy the Operator. When Kubernetes creates a StatefulSet, the Kubernetes assigns each pod a FQDN. To update Cloud Manager or Ops Manager, the Kubernetes Operator calculates the FQDN for each pod using a provided cluster name. Kubernetes doesn’t provide an API to query these hostnames.
Warning
You must set
spec.clusterDomain
if your Kubernetes cluster has a default domain other than the defaultcluster.local
. If you neither use the default nor set thespec.clusterDomain
option, the Kubernetes Operator might not function as expected.
-
spec.
service
¶ Type: string
Default: <resource_name>+”-svc” and <resource_name>+”-svc-external”
Name of Kubernetes service to be created or used for a StatefulSet. If the service with this name already exists, the MongoDB Enterprise Kubernetes Operator does not delete or recreate it. This setting lets users to create their custom services and lets the Operator reuse them.
-
spec.
logLevel
¶ Type: string
Default: INFO
Configures the level of Automation Agent logging inside the pod. Accepted values include:
DEBUG
INFO
WARN
ERROR
FATAL
-
spec.security.authentication.
ignoreUnknownUsers
¶ Type: boolean
Default:
false
Determines whether you can modify database users that were not configured through the Kubernetes Operator or the Cloud Manager or Ops Manager UI.
To manage database users directly through the
mongod
ormongos
, set totrue
.
Deployment-Specific Resource Settings¶
Other settings you can and must use in a MongoDB Kubernetes resource specification depend upon which MongoDB deployment item you want to create:
Standalone Settings¶
Note
All of the Standalone Settings also apply to replica set resources.
-
spec.
additionalMongodConfig
¶ Type: collection
Additional configuration options with which you want to start MongoDB processes.
The Kubernetes Operator supports all configuration options that the MongoDB version you deploy supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:
net.port
net.tls.certificateKeyFile
net.tls.clusterFile
net.tls.PEMKeyFile
replication.replSetName
security.clusterAuthMode
sharding.clusterRole
storage.dbPath
systemLog.destination
systemLog.path
To learn more about the configuration options that the Kubernetes Operator owns, see MongoDB Kubernetes Operator Exclusive Settings.
To see which configuration options you can use, see Configuration File Options in the MongoDB Manual for the MongoDB versions you deploy with the Kubernetes Operator.
-
spec.
exposedExternally
¶ Type: boolean
Default: false
Determines whether the MongoDB deployment is exposed outside of the Kubernetes cluster. This results in Kubernetes creating a NodePort service.
-
spec.podSpec.
cpu
¶ Type: string
Maximum CPU capacity that must be available on a Kubernetes node to host this standalone database MongoDB Kubernetes resource.
This value maps to the limits field for CPU for the created pod.
-
spec.podSpec.
cpuRequests
¶ Type: string
Minimum CPU capacity for the node being created to host this standalone database MongoDB Kubernetes resource. If omitted, this value is set to
spec.podSpec.cpu
.This value maps to the requests field for CPU for the created pod.
The requested value must be less than or equal to
spec.podSpec.cpu
.Note
For production deployments, MongoDB recommends setting this value to
2
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.podSpec.
memory
¶ Type: string
Maximum memory capacity that must be available on a Kubernetes node to host this MongoDB Kubernetes resource on Kubernetes. This value is expressed as an integer followed by a unit of memory in JEDEC notation.
Example
If this MongoDB Kubernetes resource requires 4 gigabytes of memory, set this value to
4Gi
.This value maps to the limits field for memory for the created pod.
Important
If you have not set
spec.podSpec.memory
orspec.podSpec.memoryRequests
:- Monitoring tools report incorrect available memory capacity.
- The WiredTiger cache cannot be calculated correctly. This impacts cluster performance.
-
spec.podSpec.
memoryRequests
¶ Type: string
Minimum memory capacity for the node being created to host this standalone database MongoDB Kubernetes resource. If omitted, this value is set to
spec.podSpec.memory
.This value maps to the requests field for memory for the created pod.
The requested value must be less than or equal to
spec.podSpec.memory
.Note
For production deployments, MongoDB recommends setting this value to
16Gi
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.podSpec.
nodeAffinity
¶ Type: Struct
Kubernetes rule to place standalone database pods on a specific range of nodes.
-
spec.podSpec.persistence.
single
¶ Type: collection
Has Kubernetes Operator create one Persistent Volume Claim and mount all three directories for data, journal, and logs to the same Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.multiple
collections but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum size of Persistent Volume that should be mounted. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 16Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage specified in a Persistent Volume Claim. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.podSpec.persistence.multiple.
data
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for data to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this standalone deployment on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 16Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this standalone deployment. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.podSpec.persistence.multiple.
journal
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for journal to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this standalone deployment on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 1Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this standalone deployment. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.podSpec.persistence.multiple.
logs
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for logs to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this standalone deployment on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 3Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this standalone deployment. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.podSpec.
podAffinity
¶ Type: Struct
Kubernetes rule to determine if multiple MongoDB Kubernetes resource pods must be co-located with other pods.
See also
The Kubernetes documentation for use cases on affinity and anti-affinity
-
spec.podSpec.
podTemplate
¶ Type: collection
Template for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the MongoDB database resources.
Template values take precedence over values specified in
spec.podSpec
.Note
The Kubernetes Operator doesn’t validate the fields you provide in
spec.podSpec.podTemplate
.
-
spec.podSpec.podTemplate.
metadata
¶ Type: collection
Metadata for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the MongoDB database resources.
To review which fields you can add to
spec.podSpec.podTemplate.metadata
, see the Kubernetes documentation.
-
spec.podSpec.podTemplate.
spec
¶ Type: collection
Specifications of the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the MongoDB database resources.
To review which fields you can add to
spec.podSpec.podTemplate.spec
, see the Kubernetes documentation.Note
When you add containers to
spec.podSpec.podTemplate.spec.containers
, the Kubernetes Operator adds them to the Kubernetes pod. These containers are appended to the MongoDB database resources containers in the pod.
Replica Set Settings¶
Note
All of the Standalone Settings also apply to replica set resources.
The following settings only apply to replica set resource types:
-
spec.
members
¶ Type: integer
Required. Number of Members of the Replica Set.
-
spec.podSpec.
podAntiAffinityTopologyKey
¶ Type: string
Default: kubernetes.io/hostname
Sets a rule to spread MongoDB Kubernetes resource pods to different locations. A location can be a single node, rack, or region. This key defines which node label is used to determine equal location for nodes. By default, Kubernetes Operator tries to spread pods across different hosts.
-
spec.connectivity.
replicaSetHorizons
¶ Type: collection
Allows you to provide different DNS settings for client applications and the MongoDB Agents. The Kubernetes Operator uses split horizon DNS for replica set members. This feature allows communication both within the Kubernetes cluster and from outside Kubernetes.
You may add multiple external mappings per host.
Split Horizon Requirements
- Make sure that each value in this array is unique.
- Make sure that the number of entries in this array matches the
value given in
spec.members
. - Set the
spec.security.tls.enabled
totrue
to enable TLS. This method to use split horizons requires the Server Name Indication extension of the TLS protocol. - Configure the routing for external hostnames.
Example
In this example, the replica set members communicate amongst themselves on the
example-localhost
horizon. Clients communicate with the replica set using theexample-website
horizon.
Sharded Cluster Settings¶
The following settings only apply to sharded cluster resource types:
-
spec.
exposedExternally
¶ Type: boolean
Default: false
Determines whether the MongoDB deployment is exposed outside of the Kubernetes cluster. This results in Kubernetes creating a NodePort service.
-
spec.
configServerCount
¶ Type: integer
Required. Number of Members in the Config Server.
-
spec.configSrv.
additionalMongodConfig
¶ Type: collection
Additional configuration options with which you want to start config servers.
The Kubernetes Operator supports all configuration options that the MongoDB version you deploy supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:
net.port
net.tls.certificateKeyFile
net.tls.clusterFile
net.tls.PEMKeyFile
replication.replSetName
security.clusterAuthMode
sharding.clusterRole
storage.dbPath
systemLog.destination
systemLog.path
To learn more about the configuration options that the Kubernetes Operator owns, see MongoDB Kubernetes Operator Exclusive Settings.
To see which configuration options you can use, see Configuration File Options in the MongoDB Manual for the MongoDB versions you deploy with the Kubernetes Operator.
-
spec.configSrvPodSpec.
cpu
¶ Type: number
Maximum CPU capacity that must be available on a Kubernetes node to host this sharded cluster config server member MongoDB Kubernetes resource.
This value maps to the limits field for CPU for the created pod.
-
spec.configSrvPodSpec.
cpuRequests
¶ Type: string
Minimum CPU capacity for the node being created to host this sharded cluster config server member MongoDB Kubernetes resource. If omitted, this value is set to
spec.configSrvPodSpec.cpu
.This value maps to the requests field for CPU for the created pod.
The requested value must be less than or equal to
spec.configSrvPodSpec.cpu
.Note
For production deployments, MongoDB recommends setting this value to
2
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.configSrvPodSpec.
memory
¶ Type: string
Maximum memory capacity that must be available on a Kubernetes node to host this MongoDB Kubernetes resource on Kubernetes. This value is expressed as an integer followed by a unit of memory in JEDEC notation.
Example
If this MongoDB Kubernetes resource requires 4 gigabytes of memory, set this value to
4Gi
.This value maps to the limits field for memory for the created pod.
Important
If you have not set
spec.configSrvPodSpec.memory
orspec.configSrvPodSpec.memoryRequests
:- Monitoring tools report incorrect available memory capacity.
- The WiredTiger cache cannot be calculated correctly. This impacts cluster performance.
-
spec.configSrvPodSpec.
memoryRequests
¶ Type: string
Minimum memory capacity for the node being created to host this standalone database MongoDB Kubernetes resource. If omitted, this value is set to
spec.podSpec.memory
.This value maps to the requests field for memory for the created pod.
The requested value must be less than or equal to
spec.podSpec.memory
.Note
For production deployments, MongoDB recommends setting this value to
16Gi
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.configSrvPodSpec.persistence.
single
¶ Type: collection
Has Kubernetes Operator create one Persistent Volume Claim and mount all three directories for data, journal, and logs to the same Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.multiple
collections but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum size of Persistent Volume that should be mounted. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 5Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage specified in a Persistent Volume Claim. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.configSrvPodSpec.persistence.multiple.
data
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for data to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this sharded cluster config server member on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 16Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this sharded cluster config server member. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.configSrvPodSpec.persistence.multiple.
journal
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for journal to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this sharded cluster config server member on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 1Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this sharded cluster config server member. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.configSrvPodSpec.persistence.multiple.
logs
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for logs to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this sharded cluster config server member on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 3Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this sharded cluster config server member. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.configSrvPodSpec.
nodeAffinity
¶ Type: collection
Kubernetes rule to place sharded cluster config server member pods on a specific range of nodes.
-
spec.configSrvPodSpec.
podAffinity
¶ Type: collection
Kubernetes rule to determine if multiple MongoDB Kubernetes resource pods must be co-located with other pods.
See also
The Kubernetes documentation for use cases on affinity and anti-affinity
-
spec.configSrvPodSpec.
podAntiAffinityTopologyKey
¶ Type: string
Default: kubernetes.io/hostname
Sets a rule to spread MongoDB Kubernetes resource pods to different locations. A location can be a single node, rack, or region. This key defines which node label is used to determine equal location for nodes. By default, Kubernetes Operator tries to spread pods across different hosts.
-
spec.configSrvPodSpec.
podTemplate
¶ Type: collection
Template for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the config servers.
Template values take precedence over values specified in
spec.configSrvPodSpec
.Note
The Kubernetes Operator doesn’t validate the fields you provide in
spec.configSrvPodSpec.podTemplate
.
-
spec.configSrvPodSpec.podTemplate.
metadata
¶ Type: collection
Metadata for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the config servers.
To review which fields you can add to
spec.configSrvPodSpec.podTemplate.metadata
, see the Kubernetes documentation.
-
spec.configSrvPodSpec.podTemplate.
spec
¶ Type: collection
Specifications of the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the config servers.
To review which fields you can add to
spec.configSrvPodSpec.podTemplate.spec
, see the Kubernetes documentation.Note
When you add containers to
spec.configSrvPodSpec.podTemplate.spec.containers
, the Kubernetes Operator adds them to the Kubernetes pod. These containers are appended to the config servers containers in the pod.
-
spec.
mongosCount
¶ Type: integer
Required. Number of Shard Routers.
-
spec.mongos.
additionalMongodConfig
¶ Type: collection
Additional configuration options with which you want to start
mongos
instances.The Kubernetes Operator supports all configuration options that the MongoDB version you deploy supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:
net.port
net.tls.certificateKeyFile
net.tls.clusterFile
net.tls.PEMKeyFile
replication.replSetName
security.clusterAuthMode
sharding.clusterRole
storage.dbPath
systemLog.destination
systemLog.path
To learn more about the configuration options that the Kubernetes Operator owns, see MongoDB Kubernetes Operator Exclusive Settings.
To see which configuration options you can use, see Configuration File Options in the MongoDB Manual for the MongoDB versions you deploy with the Kubernetes Operator.
-
spec.mongosPodSpec.
cpu
¶ Type: number
Maximum CPU capacity that must be available on a Kubernetes node to host this sharded cluster shard member MongoDB Kubernetes resource.
This value maps to the limits field for CPU for the created pod.
-
spec.mongosPodSpec.
cpuRequests
¶ Type: string
Minimum CPU capacity for the node being created to host this standalone database MongoDB Kubernetes resource. If omitted, this value is set to
spec.mongosPodSpec.cpu
.This value maps to the requests field for CPU for the created pod.
The requested value must be less than or equal to
spec.mongosPodSpec.cpu
.Note
For production deployments, MongoDB recommends setting this value to
2
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.mongosPodSpec.
memory
¶ Type: string
Maximum memory capacity that must be available on a Kubernetes node to host this MongoDB Kubernetes resource on Kubernetes. This value is expressed as an integer followed by a unit of memory in JEDEC notation.
Example
If this MongoDB Kubernetes resource requires 4 gigabytes of memory, set this value to
4Gi
.This value maps to the limits field for memory for the created pod.
Important
If you have not set
spec.mongosPodSpec.memory
orspec.mongosPodSpec.memoryRequests
:- Monitoring tools report incorrect available memory capacity.
- The WiredTiger cache cannot be calculated correctly. This impacts cluster performance.
-
spec.mongosPodSpec.
memoryRequests
¶ Type: string
Minimum memory capacity for the node being created to host this sharded cluster shard member MongoDB Kubernetes resource. If omitted, this value is set to
spec.podSpec.memory
.This value maps to the requests field for memory for the created pod.
The requested value must be less than or equal to
spec.podSpec.memory
.Note
For production deployments, MongoDB recommends setting this value to
16Gi
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.mongosPodSpec.
nodeAffinity
¶ Type: collection
Optional. Kubernetes rule to determine if multiple MongoDB Kubernetes resource nodes must be co-located with other nodes.
-
spec.mongosPodSpec.
podAffinity
¶ Type: collection
Optional. Kubernetes rule to determine if multiple MongoDB Kubernetes resource pods must be co-located with other pods.
-
spec.mongosPodSpec.
podAntiAffinityTopologyKey
¶ Type: string
Default: kubernetes.io/hostname
Sets a rule to spread MongoDB Kubernetes resource pods to different locations. A location can be a single node, rack, or region. This key defines which node label is used to determine equal location for nodes. By default, Kubernetes Operator tries to spread pods across different hosts.
-
spec.mongosPodSpec.
podTemplate
¶ Type: collection
Template for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the
mongos
instances.Template values take precedence over values specified in
spec.mongosPodSpec
.Note
The Kubernetes Operator doesn’t validate the fields you provide in
spec.mongosPodSpec.podTemplate
.
-
spec.mongosPodSpec.podTemplate.
metadata
¶ Type: collection
Metadata for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the
mongos
instances.To review which fields you can add to
spec.mongosPodSpec.podTemplate.metadata
, see the Kubernetes documentation.
-
spec.mongosPodSpec.podTemplate.
spec
¶ Type: collection
Specifications of the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the
mongos
instances.To review which fields you can add to
spec.mongosPodSpec.podTemplate.spec
, see the Kubernetes documentation.Note
When you add containers to
spec.mongosPodSpec.podTemplate.spec.containers
, the Kubernetes Operator adds them to the Kubernetes pod. These containers are appended to themongos
instances containers in the pod.
-
spec.
shardCount
¶ Type: integer
Required. Number of Shards in the sharded cluster.
-
spec.shard.
additionalMongodConfig
¶ Type: collection
Additional configuration options with which you want to start MongoDB processes.
The Kubernetes Operator supports all configuration options that the MongoDB version you deploy supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:
net.port
net.tls.certificateKeyFile
net.tls.clusterFile
net.tls.PEMKeyFile
replication.replSetName
security.clusterAuthMode
sharding.clusterRole
storage.dbPath
systemLog.destination
systemLog.path
To learn more about the configuration options that the Kubernetes Operator owns, see MongoDB Kubernetes Operator Exclusive Settings.
To see which configuration options you can use, see Configuration File Options in the MongoDB Manual for the MongoDB versions you deploy with the Kubernetes Operator.
-
spec.shardPodSpec.
cpu
¶ Type: number
Maximum CPU capacity that must be available on a Kubernetes node to host this sharded cluster shard member MongoDB Kubernetes resource.
This value maps to the limits field for CPU for the created pod.
-
spec.shardPodSpec.
cpuRequests
¶ Type: string
Minimum CPU capacity for the node being created to host this sharded cluster shard member MongoDB Kubernetes resource. If omitted, this value is set to
spec.shardPodSpec.cpu
.This value maps to the requests field for CPU for the created pod.
The requested value must be less than or equal to
spec.shardPodSpec.cpu
.Note
For production deployments, MongoDB recommends setting this value to
2
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.shardPodSpec.
memory
¶ Type: string
Maximum memory capacity that must be available on a Kubernetes node to host this MongoDB Kubernetes resource on Kubernetes. This value is expressed as an integer followed by a unit of memory in JEDEC notation.
Example
If this MongoDB Kubernetes resource requires 4 gigabytes of memory, set this value to
4Gi
.This value maps to the limits field for memory for the created pod.
Important
If you have not set
spec.shardPodSpec.memory
orspec.shardPodSpec.memoryRequests
:- Monitoring tools report incorrect available memory capacity.
- The WiredTiger cache cannot be calculated correctly. This impacts cluster performance.
-
spec.shardPodSpec.
memoryRequests
¶ Type: string
Minimum memory capacity for the node being created to host this sharded cluster shard member MongoDB Kubernetes resource. If omitted, this value is set to
spec.podSpec.memory
.This value maps to the requests field for memory for the created pod.
The requested value must be less than or equal to
spec.podSpec.memory
.Note
For production deployments, MongoDB recommends setting this value to
16Gi
. This value is consistent with considerations stated for MongoDB hosts.
-
spec.shardPodSpec.
nodeAffinity
¶ Type: string
Kubernetes rule to place shard pods on a specific range of nodes.
-
spec.shardPodSpec.persistence.
single
¶ Type: collection
Has Kubernetes Operator create one Persistent Volume Claim and mount all three directories for data, journal, and logs to the same Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.multiple
collections but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum size of Persistent Volume that should be mounted. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 16Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage specified in a Persistent Volume Claim. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.shardPodSpec.persistence.multiple.
data
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for data to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this sharded cluster shard member on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 16Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this sharded cluster shard member. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.shardPodSpec.persistence.multiple.
journal
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for journal to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this sharded cluster shard member on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 1Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this sharded cluster shard member. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.shardPodSpec.persistence.multiple.
logs
¶ Type: collection
Has Kubernetes Operator create a Persistent Volume Claim and mount a directory for logs to its own Persistent Volume.
Note
- You must set the values in this collection if
spec.persistent
: true
. - You may set this collection or the
persistence.single
collection but not both.
Scalar Data Type Description labelSelector
string Tag used to bind mounted volumes to directories. storage
string Minimum storage capacity that must be available on a Kubernetes node to host this sharded cluster shard member on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation.
Default value is 3Gi.
Example
If this MongoDB Kubernetes resource requires 60 gigabytes of storage space, set this value to
60Gi
.storageClass
string Type of storage needed for this sharded cluster shard member. You may create this storage type as a StorageClass object before using it in this object specification.
Note
Make sure to set the StorageClass
reclaimPolicy
to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.- You must set the values in this collection if
-
spec.shardPodSpec.
podAffinity
¶ Type: string
Kubernetes rule to determine if multiple MongoDB Kubernetes resource pods must be co-located with other pods.
See also
The Kubernetes documentation for use cases on affinity and anti-affinity
-
spec.shardPodSpec.
podAntiAffinityTopologyKey
¶ Type: string
Default: kubernetes.io/hostname
Sets a rule to spread MongoDB Kubernetes resource pods to different locations. A location can be a single node, rack, or region. This key defines which node label is used to determine equal location for nodes. By default, Kubernetes Operator tries to spread pods across different hosts.
-
spec.shardPodSpec.
podTemplate
¶ Type: collection
Template for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the MongoDB database resources.
Template values take precedence over values specified in
spec.shardPodSpec
.Note
The Kubernetes Operator doesn’t validate the fields you provide in
spec.shardPodSpec.podTemplate
.
-
spec.shardPodSpec.podTemplate.
metadata
¶ Type: collection
Metadata for the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the MongoDB database resources.
To review which fields you can add to
spec.shardPodSpec.podTemplate.metadata
, see the Kubernetes documentation.
-
spec.shardPodSpec.podTemplate.
spec
¶ Type: collection
Specifications of the Kubernetes pods that the MongoDB Enterprise Kubernetes Operator creates for the MongoDB database resources.
To review which fields you can add to
spec.shardPodSpec.podTemplate.spec
, see the Kubernetes documentation.Note
When you add containers to
spec.shardPodSpec.podTemplate.spec.containers
, the Kubernetes Operator adds them to the Kubernetes pod. These containers are appended to the MongoDB database resources containers in the pod.
Security Settings¶
The following security settings only apply to replica set and sharded cluster resource types:
-
spec.security.tls.
enabled
¶ Type: boolean
Default:
false
Encrypts communications using TLS certificates between:
- MongoDB hosts in a replica set or sharded cluster configuration
- Clients (
mongo
shell, drivers, MongoDB Compass, and others) and the MongoDB deployment
By default,
net.ssl.mode
is set torequireSSL
. To change the TLS mode used for client and database connections, seespec.additionalMongodConfig.net.ssl.mode
.
-
spec.security.tls.
additionalCertificateDomains
¶ Type: boolean
List of every domain that should be added to TLS certificates to each pod in this deployment. When you set this parameter, every CSR that the Kubernetes Operator transforms into a TLS certificate includes a SAN in the form
<pod name>.<additional cert domain>
.Replica set resources don’t need this parameter. Use
spec.connectivity.replicaSetHorizons
instead.Note
If you add this parameter to a TLS-enabled resource, Kubernetes displays an error when the resource reaches the
Pending
state. This error displays:Please manually remove the |csr| in order to proceed.
To remedy this issue:- Remove any existing CSRs so that Kubernetes can generate new CSRs. To learn how to delete a resource, see the deleting resources in the Kubernetes documentation.
- Approve the CSRs after Kubernetes generates them.
-
spec.additionalMongodConfig.net.ssl.
mode
¶ Type: string
Default:
requireSSL
Specifies which
sslMode
is used for network connections. The following are valid options:Value Description allowSSL
Connections between servers do not use TLS. For incoming connections, the server accepts both TLS and non-TLS. preferSSL
Connections between servers use TLS. For incoming connections, the server accepts both TLS and non-TLS. requireSSL
The server uses and accepts only TLS encrypted connections.
-
spec.security.
authentication
¶ Type: collection
Authentication specifications for your MongoDB deployment.
-
spec.security.authentication.
enabled
¶ Type: boolean
Default:
false
Specifies whether authentication is enabled on the Cloud Manager or Ops Manager project. Requires that you set an authentication mechanism in
spec.security.authentication.modes
.To disable authentication in Cloud Manager or Ops Manager, explicitly set to
false
.
-
spec.security.authentication.
modes
¶ Type: array
Specifies the authentication mechanism that your MongoDB deployment uses. Valid values are
SCRAM
,X509
, andLDAP
.X.509 Internal Cluster Authentication
To enable X.509 internal cluster authentication for the Cloud Manager or Ops Manager project, set this value to
["X509"]
and specify the following settings:
-
spec.security.authentication.
internalCluster
¶ Type: string
Specifies whether X.509 internal cluster authentication is enabled.
To enable X.509 internal cluster authentication, set to
"X509"
. Requires that the following settings be specified:spec.security.authentication.modes
: ["X509"]
spec.security.tls.enabled
: true
Important
Once internal cluster authentication is enabled, it can not be disabled.
(Changed in version 1.3):
In prior versions of the MongoDB Enterprise Kubernetes Operator, this setting was
spec.security.clusterAuthenticationMode
. See the v1.2 documentation for information on the previous setting name.
-
spec.security.authentication.
ldap
¶ Type: collection
Required for LDAP authentication.
Configures LDAP authentication for the Cloud Manager or Ops Manager project. To enable LDAP authentication, set
spec.security.authentication.modes
to["LDAP"]
.
-
spec.security.authentication.ldap.
servers
¶ Type: string
Required for LDAP authentication.
Hostname and port of an LDAP server in the format
<hostname>:<port>
.To specify multiple LDAP servers, use a comma-separated list. For example, specify
"<hostname1>:<port1>,<hostname2>:<port2>"
.
-
spec.security.authentication.ldap.
transportSecurity
¶ Type: string
Required for LDAP authentication.
Specifies whether the LDAP server accepts TLS.
If the LDAP server accepts TLS, set to
tls
. If the LDAP server doesn’t accept TLS, leave this value blank.
-
spec.security.authentication.ldap.
caConfigMapRef
¶ Type: collection
Required for LDAP authentication with TLS.
ConfigMap that contains a CA which validates the LDAP server’s TLS certificate.
-
spec.security.authentication.ldap.caConfigMapRef.
name
¶ Type: string
Required for LDAP authentication with TLS.
Name of the ConfigMap that contains a CA which validates the LDAP server’s TLS certificate.
-
spec.security.authentication.ldap.caConfigMapRef.
key
¶ Type: string
Required for LDAP authentication with TLS.
Field name that stores the CA which validates the LDAP server’s TLS certificate.
-
spec.security.authentication.ldap.
bindQueryUser
¶ Type: string
Required for LDAP authentication.
LDAP Distinguished Name to which MongoDB binds when connecting to the LDAP server.
Examples¶
- Standalone Pod
- Replica Set Pod
- Sharded Cluster Pod
The following example shows a resource specification for a standlone deployment with every setting provided:
The following example shows a resource specification for a replica set with every setting provided:
The following example shows a resource specification for a sharded cluster with every setting provided: