MongoDB Database Resource Specification

Required

apiVersion

Type: string

Version of the MongoDB resource schema.

kind

Type: string

Kind of MongoDB resource to create. Set this to MongoDB

metadata.name

Type: string

Name of the MongoDB resource that you create.

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.

The Ops Manager Kubernetes Secret object holding the Credentials must exist on the same Namespace as the resource you want to create.

Important

Operator manages changes to the Secret

The Kubernetes Operator tracks any changes to the Secret and reconciles the state of the MongoDB resource.

spec.persistent

Type: boolean

Default: True

WARNING: Grant your containers permission to write to your Persistent Volume. The Kubernetes Operator sets fsGroup = 2000, runAsUser = 2000, and runAsNonRoot = true in securityContext. Kubernetes Operator sets fsgroup equal to runAsUser to make the volume writable for a user that runs the main process in the container. To learn more, see Configure a Security Context for a Pod or Container and the related discussion in the Kubernetes documentation. If redeploying the resource doesn't fix issues with your Persistent Volume, contact MongoDB Support.

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 resource to create. Accepted values are:

• Standalone

• ReplicaSet

• ShardedCluster

spec.version

Type: string

Version of MongoDB that you installed on this MongoDB resource.

Important

Ensure that you choose a compatible MongoDB Server version.

Compatible versions differ depending on the base image that the MongoDB database resource uses.

Note

If you update this value to a later version of MongoDB for your database resources, the feature compatibility version remains at the MongoDB version you're upgrading from to give you the option to downgrade if necessary. If you want the feature compatibility version to match the new MongoDB version, you must manually set spec.featureCompatibilityVersion to the new version or to AlwaysMatchVersion. To learn more, see spec.featureCompatibilityVersion.

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.

This value must exist on the same namespace as the resource you want to create.

Important

Operator manages changes to the ConfigMap

The Kubernetes Operator tracks any changes to the ConfigMap and reconciles the state of the MongoDB resource.

spec.cloudManager.configMapRef.name

Type: string

Alias for spec.opsManager.configMapRef.name.

Optional

Every resource type may use the following settings:

metadata.annotations.mongodb.com/v1.architecture

Type: string

Determines the container architecture used by a specific deployment:

• The default non-static containers that download the MongoDB binary at runtime, or

• Static Containers that are immutable at runtime.

Accepted values are:

• static

• non-static

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-project
  annotations:
    mongodb.com/v1.architecture: "static"

spec.agent.backupAgent.logRotate

Type: object

Thresholds after which the MongoDB Agent rotates the backup log.

spec.agent.backupAgent.logRotate.sizeThresholdMB

Type: integer

Maximum size, in MB, of a backup log file before the MongoDB Agent rotates the logs.

spec.agent.backupAgent.logRotate.timeThresholdHrs

Type: integer

Number of hours after which the MongoDB Agent rotates the backup log file.

spec.agent.mongod.auditlogRotate

Type: object

Object that contains the audit log rotation configuration for the MongoDB processes.

spec.agent.mongod.auditlogRotate.sizeThresholdMB

Type: number

Maximum size, in MB, of an audit log file before the MongoDB Agent rotates the logs.

spec.agent.mongod.auditlogRotate.timeThresholdHrs

Type: integer

Number of hours after which the MongoDB Agent rotates the audit log file.

spec.agent.mongod.auditlogRotate.numUncompressed

Type: integer

Maximum number of total audit log files to leave uncompressed, including the current log file.

spec.agent.mongod.auditlogRotate.numTotal

Type: integer

Total number of audit log files that Ops Manager retains. If you don't set this value, the total number of audit log files defaults to 0.

spec.agent.mongod.auditlogRotate.percentOfDiskspace

Type: number

Maximum percentage of total disk space that Ops Manager can use to store the log files expressed as decimal. If this limit is exceeded, Ops Manager deletes compressed log files until it meets this limit. Ops Manager deletes the oldest log files first.

The default is 0.02.

spec.agent.mongod.logRotate

Type: object

Thresholds after which Ops Manager rotates the MongoDB logs of a process.

spec.agent.mongod.logRotate.sizeThresholdMB

Type: integer

Maximum size in MB for an individual log file before Ops Manager rotates it. Ops Manager rotates the log file immediately if it meets the value given in either this sizeThresholdMB or the spec.agent.mongod.logRotate.timeThresholdHrs.

spec.agent.mongod.logRotate.timeThresholdHrs

Type: integer

Maximum duration in hours for an individual log file before the next rotation. The time is since the last rotation.

Ops Manager rotates the log file once the file meets either this timeThresholdHrs or the spec.agent.mongod.logRotate.sizeThresholdMB.

spec.agent.monitoringAgent.logRotate

Type: object

Thresholds after which the MongoDB Agent rotates the monitoring log.

spec.agent.monitoringAgent.logRotate.sizeThresholdMB

Type: integer

Maximum size in MB for an individual log file before the MongoDB Agent rotates the monitoring log.

spec.agent.monitoringAgent.logRotate.timeThresholdHrs

Type: integer

Number of hours after which the MongoDB Agent rotates the monitoring log.

spec.agent.readinessProbe.environmentVariables

Type: object

Configures the following environment variables used to control the log files for the Readiness Probe:

• READINESS_PROBE_LOGGER_BACKUPS

• READINESS_PROBE_LOGGER_COMPRESS

• READINESS_PROBE_LOGGER_MAX_SIZE

• READINESS_PROBE_LOGGER_MAX_AGE

• MDB_WITH_AGENT_FILE_LOGGING

• LOG_FILE_PATH

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: my-project
spec:
  agent:
    readinessProbe:
      environmentVariables:
        READINESS_PROBE_LOGGER_BACKUPS: 1
        READINESS_PROBE_LOGGER_MAX_SIZE: 10
        READINESS_PROBE_LOGGER_MAX_AGE: 3
        READINESS_PROBE_LOGGER_COMPRESS: true
        MDB_WITH_AGENT_FILE_LOGGING: false
        LOG_FILE_PATH: /var/log/mongodb-mms-automation/readiness.log

spec.featureCompatibilityVersion

Type: string

Defaults to the prior major MongoDB version after MongoDB upgrade.

Limits changes to data that occur with an upgrade to a new major version. For example, if you upgrade from MongoDB 5.0 to MongoDB 6.0, the feature compatibility version remains at 5.0 to give you the option to downgrade if necessary.

If you want the feature compatibility version to match the new MongoDB version, you must manually set featureCompatibilityVersion to the new version. For example, featureCompatibilityVersion: 6.0.

Alternatively, you can enable the AlwaysMatchVersion option to automatically update the feature compatibility version to match the MongoDB version during upgrades. For example, featureCompatibilityVersion: AlwaysMatchVersion.

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 Kubernetes 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 default cluster.local. If you neither use the default nor set the spec.clusterDomain option, the Kubernetes Operator might not function as expected.

spec.clusterName

Type: string

Default: cluster.local

Important

spec.clusterName is Deprecated

Use spec.clusterDomain instead.

Domain name of the Kubernetes cluster where you deploy the Kubernetes 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 default cluster.local. If you neither use the default nor set the spec.clusterDomain option, the Kubernetes Operator might not function as expected.

metadata.namespace

Type: string

Kubernetes namespace where you create this MongoDB resource and other objects.

spec.service

Type: string

Default: <resource_name>+"-svc" and <resource_name>+"-svc-external"

Important

spec.service is Deprecated

Use spec.statefulSet.spec.serviceName instead.

Name of the 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 you create your own custom services and lets the Kubernetes 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 user interface.

To manage database users directly through the mongod or mongos, set this setting to true.

Standalone Settings

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 through the MongoDB Agent 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

• 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 learn which configuration options you can use, see Advanced Options for MongoDB Deployments in the Ops Manager documentation.

spec.agent

Type: collection

MongoDB Agent configuration settings for MongoDB database resource.

spec.agent.startupOptions

Type: collection

MongoDB Agent settings with which you want to start MongoDB database resource.

You must provide MongoDB Agent settings as key-value pairs. The values must be strings.

For a list of supported MongoDB Agent settings, see:

• MongoDB Agent Settings for Cloud Manager projects.

• MongoDB Agent Settings for the Ops Manager version you deployed with the Kubernetes Operator.

1
---
2
apiVersion: mongodb.com/v1
3
kind: MongoDB
4
metadata:
5
  name: my-standalone
6
spec:
7
  version: "8.0.0"
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
...

spec.podSpec

Type: object

Object that contains the specifications for the MongoDB CustomResourceDefinition Pods.

spec.externalAccess

Type: collection

Specification to expose your cluster for external connections. To learn how to connect to your MongoDB resource from outside of the Kubernetes cluster, see Connect to a MongoDB Database Resource from Outside Kubernetes.

If you add spec.externalAccess, the Kubernetes Operator creates an external service for each Pod in a replica set. External services provide an external entry point for each MongoDB database Pod in a cluster. Each external service has selectors that match the external service to a specific Pod.

If you add this setting without any values, the Kubernetes Operator creates an external service with the following default values:

Field	Value	Description
Name	<pod-name>-svc-external	Name of the external service. You can't change this value.
Type	LoadBalancer	Creates an external LoadBalancer service.
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

Note

If you set spec.externalAccess.externalDomain, the external service adds another port (Port Number + 1) for backups.

spec.externalAccess.externalService

Type: collection

Specification for overriding the default values in spec.externalAccess.

When you set the spec.externalAccess setting, the Kubernetes Operator automatically creates an external load balancer service with default values. You can override certain values or add new values depending on your needs. For example, if you intend to create NodePort services and don't need a load balancer, you must configure overrides in your Kubernetes specification:

externalAccess:
  externalService:
    annotations:
      # cloud-specific annotations for the service
    spec:
      type: NodePort # default is LoadBalancer
      # you can specify other spec overrides if necessary

For more information about the Kubernetes specification, see ServiceSpec in the Kubernetes documentation.

spec.externalAccess.externalService.annotations

Type: collection

Key-value pairs that let you add cloud provider-specific configuration settings to all clusters in your deployment. To learn more, see annotations and the documentation for your Kubernetes cloud provider.

You can use annotations to specify placeholder values for external services used by Kubernetes Operator deployments. The Kubernetes Operator automatically replaces these values with the correct values as described in the following table. Using placeholders allows you to provide specific annotations in each service for a specific Pod.

Value	Description
{resourceName}	Equal to metadata.name.
{namespace}	Equal to metadata.namespace.
{podIndex}	Index of the Pod assigned by the StatefulSet and targeted by the current external service.
{podName}	Equal to {resourceName}-{podIndex}.
{statefulSetName}	The StatefulSet. Equal to {resourceName}.
{externalServiceName}	Generated name of the external service, based on the placeholder values that you specified. Equal to {resourceName}-{podIndex}-svc-external.
{mongodProcessDomain}	The domain name of the server that is hosting the mongod process. Equal to spec.externalAccess.externalDomain if specified. Otherwise, equal to the domain used for the mongod process FQDN. For example, for the process hostname mdb-rs-1.example.com, example.com is the domain name.
{mongodProcessFQDN}	The mongod process hostname set in the automation configuration. The process hostname depends on your deployment configuration. If you've configured your deployment to use external domains, the process hostname uses the following format: {resourceName}-{podIndex}.{mongodProcessDomain} For example: mdb-rs-1.example.com If your deployment doesn't use external domains, the process hostname uses the following format: {resourceName}-{podIndex}.{resourceName}-{podIndex}-svc.{namespace}.svc.cluster.local For example: mdb-rs-1.mdb-rs-1-svc.ns.svc.cluster.local

Note

You must use only known placeholder values as specified in the table and ensure that your placeholders don't use empty or null values. You also can't use a placeholder specific to multi-Kubernetes-cluster deployments for a single MongoDB resource deployment.

Otherwise, Kubernetes Operator returns an error. For example, you might encounter the following error message:

error replacing placeholders in map with key=external-dns.alpha.kubernetes.io/hostname, value={resourceName}-{podIndex}-{unknownPlaceholder}.{clusterName}-{clusterIndex}.example.com: missing values for the following placeholders: {clusterName}, {clusterIndex}, {unknownPlaceholder}``

Example

The following example specifies the {resourceName}, {podIndex}, and {namespace} placeholders:

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: mdb-rs
  namespace: ns
spec:
  replicas: 3
  externalAccess:
    externalService:
      annotations:
        external-dns.alpha.kubernetes.io/hostname: {resourceName}-{podIndex}-{namespace}.example.com

The Kubernetes Operator automatically populates the annotations for the external services based on the proper value for each placeholder. For example:

mdb-rs-0-svc-external:
  annotations:
    external-dns.alpha.kubernetes.io/hostname: mdb-rs-0-ns.example.com
mdb-rs-1-svc-external:
  annotations:
    external-dns.alpha.kubernetes.io/hostname: mdb-rs-1-ns.example.com
mdb-rs-2-svc-external:
  annotations:
    external-dns.alpha.kubernetes.io/hostname: mdb-rs-2-ns.example.com

spec.externalAccess.externalService.spec

Type: collection

Configuration for the ServiceSpec. To learn more, see spec.externalAccess.externalService.

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. For example, if standalone deployment in 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. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 standalone deployment on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation. Default value is 16Gi. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for standalone deployment. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 standalone deployment on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation. Default value is 1Gi. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for standalone deployment. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 standalone deployment on Kubernetes. This value is expressed as an integer followed by a unit of storage in JEDEC notation. Default value is 3Gi. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for standalone deployment. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.podSpec.podTemplate.affinity.nodeAffinity

Type: Struct

Kubernetes rule to place Pods for replica set on a specific range of nodes.

For optimized read-write performance, use node affinity rules that restrict Pods to run on particular nodes, or to prefer to run on particular nodes.

spec.podSpec.podTemplate.affinity.podAffinity

Type: Struct

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.podSpec.podTemplate.affinity.podAntiAffinity

Type: Struct

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

spec.podSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

Type: Struct

Default: kubernetes.io/hostname

This key defines which label is used to determine which topology domain a node belongs to.

spec.podSpec.podTemplate

Type: collection

Template for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for 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 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 MongoDB database resources.

To review which fields you can add to spec.podSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

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 MongoDB database resources containers in the pod.

Use this setting to specify the CPU and RAM allocations for each pod. For examples, see the samples on GitHub.

Replica Set Settings

The following settings apply to replica set resource types:

spec.backup

Type: collection

The collection container for spec.backup.mode, which enables continuous backups for MongoDB resources in Kubernetes Operator.

spec.backup.assignmentLabels

Type: array

A comma-separated list of labels to assign backup daemons, oplog stores, blockstores, S3 snapshot stores, and file system stores to specific projects or groups. Use assignment labels to identify that specific backup stores are associated with particular projects.

If you set assignment labels using the Kubernetes Operator, the values that you set in the Kubernetes configuration file for assignment labels override the values defined in the Ops Manager UI. Assignment labels that you don't set using the Kubernetes Operator continue to use the values set in the Ops Manager UI.

Note

If you set this parameter, the API key linked with the value of spec.credentials must have a Global Owner role.

spec.backup.mode

Type: string

Enables continuous backups for a MongoDB resource. Possible values are enabled, disabled, and terminated.

Note

The spec.backup.mode setting relies on Backup that is enabled in the Ops Manager and requires that spec.backup.enabled value in the Ops Manager resource specification is set to true.

After you enable continuous backups for your MongoDB resource with spec.backup.mode, you can check the backup status.

spec.backup.encryption

Type: object

Object that contains the backup encryption configuration settings.

spec.backup.encryption.kmip

Type: object

Object that contains the KMIP backup encryption configuration settings. To learn more, see Configure KMIP Backup Encryption for Ops Manager.

spec.backup.encryption.kmip.client

Type: object

Object that contains the KMIP backup encryption client configuration settings.

spec.backup.encryption.kmip.client.clientCertificatePrefix

Type: string

spec.backup.snapshotSchedule

Type: collection

Collection container for snapshot schedule settings for continuous backups for MongoDB resources in Kubernetes Operator.

spec.backup.snapshotSchedule.snapshotIntervalHours

Type: number

Number of hours between snapshots. You can set a value of 6, 8, 12, or 24.

spec.backup.snapshotSchedule.snapshotRetentionDays

Type: number

Number of days to keep recent snapshots. You can set a value between 2 and 5, inclusive.

spec.backup.snapshotSchedule.dailySnapshotRetentionDays

Type: number

Number of days to keep daily snapshots. You can set a value between 1 and 365, inclusive. Setting the value to 0 disables this rule.

spec.backup.snapshotSchedule.weeklySnapshotRetentionWeeks

Type: number

Number of weeks to keep weekly snapshots. You can set a value between 1 and 52, inclusive. Setting the value to 0 disables this rule.

spec.backup.snapshotSchedule.monthlySnapshotRetentionMonths

Type: number

Number of months to keep monthly snapshots. You can set a value between 1 and 36, inclusive. Setting the value to 0 disables this rule.

spec.backup.snapshotSchedule.pointInTimeWindowHours

Type: number

Number of hours in the past for which you can create a point-in-time snapshot.

spec.backup.snapshotSchedule.referenceHourOfDay

Type: number

UTC hour of the day to schedule snapshots using a 24 hour clock. You can set a value between 0 and 23, inclusive.

spec.backup.snapshotSchedule.referenceMinuteOfHour

Type: number

UTC minute of the hour to schedule snapshots. You can set a value between 0 and 59, inclusive.

spec.backup.snapshotSchedule.fullIncrementalDayOfWeek

Type: string

Day of the week when Ops Manager takes a full snapshot. This setting ensures a recent complete backup. Ops Manager sets the default value to SUNDAY.

spec.clusterName

Type: string

Default: cluster.local

Important

spec.clusterName is Deprecated

Use spec.clusterDomain instead.

Domain name of the Kubernetes cluster where you deploy the Kubernetes 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 default cluster.local. If you neither use the default nor set the spec.clusterDomain option, the Kubernetes Operator might not function as expected.

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.

• Provide a value for the spec.security.certsSecretPrefix setting 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 the example-website horizon.

The names of the stated horizons are arbitrary for the purposes of this example. You can name your horizon anything, but make sure the horizon name is the same for all hostnames that are a part of that horizon.

1
---
2
apiVersion: mongodb.com/v1
3
kind: MongoDB
4
metadata:
5
  name: <my-replica-set>
6
spec:
7
  members: 3
8
  version: "8.0.0"
9
  type: ReplicaSet
10
  opsManager:
11
    configMapRef:
12
      name: <configMap.metadata.name>
13
  credentials: <mycredentials>
14
  persistent: true

15
  security:
16
    tls:
17
      enabled: true
18
  connectivity:
19
    replicaSetHorizons:
20
      - "example-website": "web1.example.com:30907"
21
      - "example-website": "web2.example.com:32350"
22
      - "example-website": "web3.example.com:31185"
23
...

spec.externalAccess.externalDomain

Type: string

An external domain used to externally expose your replica set deployment.

By default, each replica set member uses the Kubernetes Pod's FQDN (*.svc.cluster.local) as the default hostname. However, if you add an external domain to this setting, the replica set uses a hostname that is a subdomain of the specified domain instead. This hostname uses the following format:

<replica-set-name>-<pod-idx>.<externalDomain>

For example:

replica-set-1.example.com

After you deploy the replica set with this setting, the Kubernetes Operator uses the hostname with the external domain to override the processes[n].hostname field in the Ops Manager automation configuration. Then, the MongoDB Agent uses this hostname to connect to mongod.

To specify other hostnames for connecting to the replica set, you can use the spec.connectivity.replicaSetHorizons setting. However, the following connections still use the hostname with the external domain:

• The MongoDB Agent to connect to mongod.

• mongod to connect to other mongod instances.

WARNING: Specifying this field changes how Ops Manager registers mongod processes. You can specify this field only for new replica set deployments starting in Kubernetes Operator version 1.19. You can't change the value of this field or any processes[n].hostname fields in the Ops Manager automation configuration for a running replica set deployment.

spec.members

Type: integer

Required. Number of Members of the Replica Set.

spec.memberConfig

Type: collection

Specification for each MongoDB replica set member deployed from the MongoDB resource.

The order of the elements in the array must reflect the order of members in the replica set. For example, the first element of the array affects the Pod at index 0, the second element affects index 1, and so on.

Example

Consider the following example specification for a three-member replica set:

spec:
  memberConfig:
    - votes: 1
      priority: "0.5"
      tags:
        tag1: "value1"
        environment: "prod"
    - votes: 1
      priority: "1.5"
      tags:
        tag2: "value2"
        environment: "prod"
    - votes: 0
      priority: "0.5"
      tags:
        tag2: "value2"
        environment: "prod"

spec.memberConfig.priority

Type: string

Number that indicates the relative likelihood of a MongoDB replica set member to become the primary.

• To increase the relative likelihood that a replica set member becomes the primary, specify a higher priority value.

• To decrease the relative likelihood that a replica set member becomes the primary, specify a lower priority value.

For example, a member with a memberConfig.priority of 1.5 is more likely than a member with a memberConfig.priority of 0.5 to become the primary.

A member with a memberConfig.priority of 0 is ineligible to become the primary. To learn more, see Member Priority.

spec.memberConfig.tags

Type: map

Map of replica set tags for directing read and write operations to specific members of your MongoDB replica set.

spec.memberConfig.votes

Type: number

Determines whether a MongoDB replica set member can vote in an election. Set to 1 to allow the member to vote. Set to 0 to exclude the member from an election.

The following settings apply only to replica set resource types:

spec.backup.autoTerminateOnDeletion

Type: boolean

Flag that controls whether the Kubernetes Operator stops and terminates the backup when you delete a MongoDB resource. If omitted, the default value is false. Setting this flag to true is useful when you want to delete the MongoDB custom resource while the spec.backup.mode setting is set to enabled.

Sharded Cluster Settings

The following settings apply only to sharded cluster resource types:

spec.backup.snapshotSchedule.clusterCheckpointIntervalMin

Type: number

Number of minutes between successive cluster checkpoints. This setting applies only to sharded clusters that run MongoDB with a feature compatibility version of 4.0 or earlier. This number determines the granularity of point-in-time restores for sharded clusters. You can set a value of 15, 30, or 60.

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 each config server member.

The Kubernetes Operator supports all configuration options that the MongoDB version you deploy through the MongoDB Agent supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:

• net.tls.certificateKeyFile

• net.tls.clusterFile

• 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 learn which configuration options you can use, see Advanced Options for MongoDB Deployments in the Ops Manager documentation.

spec.configSrv.agent

Type: collection

MongoDB Agent configuration settings for each config server member.

spec.configSrv.agent.startupOptions

Type: collection

MongoDB Agent settings with which you want to start each config server member.

You must provide MongoDB Agent settings as key-value pairs. The values must be strings.

For a list of supported MongoDB Agent settings, see:

• MongoDB Agent Settings for Cloud Manager projects.

• MongoDB Agent Settings for the Ops Manager version you deployed with the Kubernetes Operator.

1
---
2
apiVersion: mongodb.com/v1
3
kind: MongoDB
4
metadata:
5
  name: my-sharded-cluster-options
6
spec:
7
  version: "8.0.0"
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
...

spec.configSrvPodSpec

Type: object

Object that contains the specifications for the MongoDB CustomResourceDefinition config server Pods.

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. For example, if each config server member in 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. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 each 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. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for each config server member. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 each 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. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for each config server member. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 each 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. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for each config server member. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.configSrvPodSpec.podTemplate

Type: collection

Template for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for each config server member.

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.affinity.podAffinity

Type: collection

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.configSrvPodSpec.podTemplate.affinity.nodeAffinity

Type: collection

Kubernetes rule to place Pods for replica set on a specific range of nodes.

For optimized read-write performance, use node affinity rules that restrict Pods to run on particular nodes, or to prefer to run on particular nodes.

spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity

Type: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

spec.configSrvPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

Type: string

Default: kubernetes.io/hostname

This key defines which label is used to determine which topology domain a node belongs to.

spec.configSrvPodSpec.podTemplate.metadata

Type: collection

Metadata for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for each config server member.

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 each config server member.

To review which fields you can add to spec.configSrvPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

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 each config server member containers in the pod.

Use this setting to specify the CPU and RAM allocations for each pod. For examples, see the samples on GitHub.

spec.mongodsPerShardCount

Type: integer

Required. Number of members per shard.

spec.mongosCount

Type: integer

Required. Number of mongos instances in the sharded cluster.

spec.mongos.additionalMongodConfig

Type: collection

Additional configuration options with which you want to start each mongos instance.

The Kubernetes Operator supports all configuration options that the MongoDB version you deploy through the MongoDB Agent supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:

• net.tls.certificateKeyFile

• net.tls.clusterFile

• 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 learn which configuration options you can use, see Advanced Options for MongoDB Deployments in the Ops Manager documentation.

spec.mongos.agent

Type: collection

MongoDB Agent configuration settings for each mongos instance.

spec.mongos.agent.startupOptions

Type: collection

MongoDB Agent settings with which you want to start each mongos instance.

You must provide MongoDB Agent settings as key-value pairs. The values must be strings.

For a list of supported MongoDB Agent settings, see:

• MongoDB Agent Settings for Cloud Manager projects.

• MongoDB Agent Settings for the Ops Manager version you deployed with the Kubernetes Operator.

1
---
2
apiVersion: mongodb.com/v1
3
kind: MongoDB
4
metadata:
5
  name: my-sharded-cluster-options
6
spec:
7
  version: "8.0.0"
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
...

spec.mongosPodSpec

Type: object

Object that contains the specifications for the MongoDB CustomResourceDefinition mongos Pods.

spec.mongosPodSpec.podTemplate

Type: collection

Template for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for each mongos instance.

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.affinity.podAffinity

Type: collection

Optional. Kubernetes rule to determine if multiple MongoDB resource Pods must be co-located with other Pods.

spec.mongosPodSpec.podTemplate.affinity.nodeAffinity

Type: collection

Kubernetes rule to place Pods for replica set on a specific range of nodes.

For optimized read-write performance, use node affinity rules that restrict Pods to run on particular nodes, or to prefer to run on particular nodes.

spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity

Type: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

spec.mongosPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

Type: string

Default: kubernetes.io/hostname

This key defines which label is used to determine which topology domain a node belongs to.

spec.mongosPodSpec.podTemplate.metadata

Type: collection

Metadata for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for each mongos instance.

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 each mongos instance.

To review which fields you can add to spec.mongosPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

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 each mongos instance containers in the pod.

Use this setting to specify the CPU and RAM allocations for each pod. For examples, see the samples on GitHub.

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 each sharded cluster shard member.

The Kubernetes Operator supports all configuration options that the MongoDB version you deploy through the MongoDB Agent supports, except that the Kubernetes Operator overrides values that you provide for any of the following options:

• net.tls.certificateKeyFile

• net.tls.clusterFile

• 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 learn which configuration options you can use, see Advanced Options for MongoDB Deployments in the Ops Manager documentation.

spec.shard.agent

Type: collection

MongoDB Agent configuration settings for each sharded cluster shard member.

spec.shard.agent.startupOptions

Type: collection

MongoDB Agent settings with which you want to start each sharded cluster shard member.

You must provide MongoDB Agent settings as key-value pairs. The values must be strings.

For a list of supported MongoDB Agent settings, see:

• MongoDB Agent Settings for Cloud Manager projects.

• MongoDB Agent Settings for the Ops Manager version you deployed with the Kubernetes Operator.

1
---
2
apiVersion: mongodb.com/v1
3
kind: MongoDB
4
metadata:
5
  name: my-sharded-cluster-options
6
spec:
7
  version: "8.0.0"
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
...

spec.shardPodSpec

Type: object

Object that contains the specifications for the MongoDB CustomResourceDefinition shard Pods.

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 each 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. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for each sharded cluster shard member. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 each 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. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for each sharded cluster shard member. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

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 each 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. For example, if this MongoDB resource requires 60 gigabytes of storage space, set this value to 60Gi.
storageClass	string	Type of storage needed for each sharded cluster shard member. You may create this storage type as a StorageClass object before using it in this object specification. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.

spec.shardPodSpec.podTemplate

Type: collection

Template for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for each sharded cluster shard member.

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.affinity.podAffinity

Type: string

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.shardPodSpec.podTemplate.affinity.nodeAffinity

Type: string

Kubernetes rule to place Pods for replica set on a specific range of nodes.

For optimized read-write performance, use node affinity rules that restrict Pods to run on particular nodes, or to prefer to run on particular nodes.

spec.shardPodSpec.podTemplate.affinity.podAntiAffinity

Type: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

spec.shardPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

Type: string

Default: kubernetes.io/hostname

This key defines which label is used to determine which topology domain a node belongs to.

spec.shardPodSpec.podTemplate.metadata

Type: collection

Metadata for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for each sharded cluster shard member.

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 each sharded cluster shard member.

To review which fields you can add to spec.shardPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

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 each sharded cluster shard member containers in the pod.

Use this setting to specify the CPU and RAM allocations for each pod. For examples, see the samples on GitHub.

spec.shardSpecificPodSpec

Type: array

List that contains StatefulSet overrides per shard.

spec.shardSpecificPodSpec.podTemplate

Type: collection

Template for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for the specific shard.

Template values take precedence over values specified in spec.shardSpecificPodSpec.

Note

The Kubernetes Operator doesn't validate the fields you provide in spec.shardSpecificPodSpec.podTemplate.

spec.shardSpecificPodSpec.podTemplate.affinity.podAffinity

Type: string

Kubernetes rule to determine whether multiple MongoDB resource Pods must be co-located with other Pods. To learn more about the use cases, see Affinity and Anti-Affinity in the Kubernetes documentation.

spec.shardSpecificPodSpec.podTemplate.affinity.podAntiAffinity

Type: string

Default: kubernetes.io/hostname

Sets a rule to spread Pods hosting MongoDB resource to different locations. A location can be a single node, rack, or region. By default, Kubernetes Operator tries to spread pods across different nodes.

spec.shardSpecificPodSpec.podTemplate.affinity.podAntiAffinity.requiredDuringSchedulingIgnoredDuringExecution.topologyKey

Type: string

Default: kubernetes.io/hostname

This key defines which label is used to determine which topology domain a node belongs to.

spec.shardSpecificPodSpec.podTemplate.metadata

Type: collection

Metadata for the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for the specific shard.

To review which fields you can add to spec.shardSpecificPodSpec.podTemplate.metadata, see the Kubernetes documentation.

spec.shardSpecificPodSpec.podTemplate.spec

Type: collection

Specifications of the Kubernetes Pods that the MongoDB Enterprise Kubernetes Operator creates for the specific shard.

To review which fields you can add to spec.shardSpecificPodSpec.podTemplate.spec, see the Kubernetes PodSpec v1 core API.

Note

When you add containers to spec.shardSpecificPodSpec.podTemplate.spec.containers, the Kubernetes Operator adds them to the Kubernetes pod. These containers are appended to the specific shard containers in the pod.

Use this setting to specify the CPU and RAM allocations for each pod. For examples, see the samples on GitHub.

spec.topology

Type: string

Optional

Default: SingleCluster

Defines the topology of the sharded cluster. Cannot be changed for an existing deployment. If set to MultiCluster:

• All sharded cluster components must have clusterSpecList defined:

  • spec.mongos.clusterSpecList

  • spec.configSrv.clusterSpecList

  • spec.shard.clusterSpecList

• The following fields are ignored, as their equivalent values are passed for each cluster in the spec.<section>.clusterSpecList objects:

  • spec.mongodsPerShardCount is defined in spec.shard.clusterSpecList.members

  • spec.mongosCount is defined in spec.mongos.clusterSpecList.members

  • spec.configServerCount is defined in spec.configSrv.clusterSpecList.members

  • spec.shardOverrides.memberConfig is defined in spec.shardOverrides.clusterSpecList.memberConfig

  • spec.shardOverrides.members is defined in spec.shardOverrides.clusterSpecList.members

  • spec.shardOverrides.statefulSet is defined in spec.shardOverrides.clusterSpecList.statefulSet

Example:

apiVersion: mongodb.com/v1
kind: MongoDB
metadata:
  name: sc
spec:
  shardCount: 3
  # we don't specify mongodsPerShardCount, mongosCount and configServerCount as they don't make sense for multi-cluster
  topology: MultiCluster
  type: ShardedCluster
  version: 7.0.12
  cloudManager:
    configMapRef:
      name: my-project
  credentials: my-credentials
  persistent: true
  shard:
    clusterSpecList:
      - clusterName: member-cluster-0
        members: 2 # each shard will have 2 members in cluster 0, unless overriden
      - clusterName: member-cluster-1
        members: 2
      - clusterName: member-cluster-2
        members: 1
  shardOverrides:
    - shardNames: [sc-2] # this override will apply to the third shard (here, shards are indexed from 0 to 2 as we have 3 shards)
      clusterSpecList:
        - clusterName: member-cluster-0 # all other fields are optional, if not provided the fields from matching member cluster from shard.clusterSpecList will be taken by default
          members: 3
        - clusterName: member-cluster-1 # we don't deploy this shard to member-cluster-1
          # Note that it is also possible to make it explicit with members: 0
        # we don't provide entry for clusterName: member-cluster-1, so it won't be deployed there
        - clusterName: member-cluster-2
          members: 2
  configSrv:
    clusterSpecList:
      - clusterName: member-cluster-0
        members: 2 # config server will have 2 members in this cluster
      - clusterName: member-cluster-1
        members: 1
      - clusterName: member-cluster-2
        members: 2
  mongos:
    clusterSpecList:
      - clusterName: member-cluster-0
        members: 2 # router will have 2 members in this cluster
      - clusterName: member-cluster-1
        members: 1

The following fields relate exclusively to deployments in which topology=MultiCluster:

spec.configSrv.clusterSpecList

Note

This field is exclusively available for multi-cluster sharded cluster deployments.

Type: array of objects

Required if topology=MultiCluster

An array of objects for use in multi-cluster sharded cluster deployments with the following top-level fields:

clusterName

Type: string

Name of the cluster where the MongoDB Enterprise Kubernetes Operator schedules the StatefulSet.

externalAccess

Type: collection

Specification to expose your multi-Kubernetes cluster MongoDB deployment for external connections. To learn how to connect to your multi-Kubernetes cluster MongoDB deployment from outside of the Kubernetes cluster, see Connect to Multi-Cluster Resource from Outside Kubernetes.

These settings apply to services across all clusters. To override these global settings in a specific cluster, use spec.clusterSpecList.externalAccess.externalService.

If you add spec.externalAccess, the Kubernetes Operator creates an external service for each Pod in a replica set. External services provide an external entry point for each MongoDB database Pod in a cluster. Each external service has selectors that match the external service to a specific Pod.

If you add this setting without any values, the Kubernetes Operator creates an external service with the following default values:

Field	Value	Description
Name	<pod-name>-svc-external	Name of the external service. You can't change this value.
Type	LoadBalancer	Creates an external LoadBalancer service.
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

Note

If you set spec.clusterSpecList.externalAccess.externalDomain, the external service adds another port (Port Number + 1) for backups.

members

Type: number

Number of members in the MongoDB replica set.

memberConfig

Type: collection

Specification for each MongoDB shard and its members in your multi-Kubernetes cluster MongoDB deployment.

The order of the elements in the object for shard must reflect the order of members in the replica set. For example, the first element affects the Pod at index 0, the second element affects index 1, and so on.

Example

Consider the following example specification for a multi-Kubernetes cluster MongoDB deployment with three replica sets:

apiVersion: mongodb.com/v1
kind: MongoDBMultiCluster
metadata:
  name: multi-replica-set
spec:
  version: 8.0.0
  type: ReplicaSet
  duplicateServiceObjects: false
  credentials: my-credentials
  opsManager:
    configMapRef:
      name: my-project
  clusterSpecList:
    - clusterName: cluster1.example.com
      members: 2
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
                  tag2: "value2"
                  environment: "prod"
    - clusterName: cluster2.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
    - clusterName: cluster3.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"

podSpec.persistence

Type: collection

Only available in clusterSpecItem objects passed to spec.configSrv.clusterSpecList and spec.shard.clusterSpecList. Overrides the existing persistence configuration for a given cluster.

statefulSet

Type: collection

Provides the configuration for the StatefulSet override for each of the cluster's StatefulSets in a multi-Kubernetes cluster MongoDB deployment. To set the global configuration that applies to all clusters in your multi-Kubernetes cluster MongoDB deployment, see spec.statefulSet.spec.

This setting applies only to replica set resource types in multi-Kubernetes cluster MongoDB deployments.

spec.duplicateServiceObjects

Note

This field is exclusively available for multi-cluster sharded cluster deployments.

Type: boolean

Optional

Default: true

Ignored if topology is not MultiCluster. Applies to services for the all sharded cluster components: mongos, configSrv and shards.

If set to true:

The Kubernetes Operator creates all Pod Services from all member clusters in each member cluster.

If set to false:

The Kubernetes Operator creates only

spec.mongos.clusterSpecList

Note

This field is exclusively available for multi-cluster sharded cluster deployments.

Type: array of objects

Required if topology=MultiCluster

An array of objects for use in multi-cluster sharded cluster deployments with the following top-level fields:

clusterName

Type: string

Name of the cluster where the MongoDB Enterprise Kubernetes Operator schedules the StatefulSet.

externalAccess

Type: collection

Specification to expose your multi-Kubernetes cluster MongoDB deployment for external connections. To learn how to connect to your multi-Kubernetes cluster MongoDB deployment from outside of the Kubernetes cluster, see Connect to Multi-Cluster Resource from Outside Kubernetes.

These settings apply to services across all clusters. To override these global settings in a specific cluster, use spec.clusterSpecList.externalAccess.externalService.

If you add spec.externalAccess, the Kubernetes Operator creates an external service for each Pod in a replica set. External services provide an external entry point for each MongoDB database Pod in a cluster. Each external service has selectors that match the external service to a specific Pod.

If you add this setting without any values, the Kubernetes Operator creates an external service with the following default values:

Field	Value	Description
Name	<pod-name>-svc-external	Name of the external service. You can't change this value.
Type	LoadBalancer	Creates an external LoadBalancer service.
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

Note

If you set spec.clusterSpecList.externalAccess.externalDomain, the external service adds another port (Port Number + 1) for backups.

members

Type: number

Number of members in the MongoDB replica set.

memberConfig

Type: collection

Specification for each MongoDB shard and its members in your multi-Kubernetes cluster MongoDB deployment.

The order of the elements in the object for shard must reflect the order of members in the replica set. For example, the first element affects the Pod at index 0, the second element affects index 1, and so on.

Example

Consider the following example specification for a multi-Kubernetes cluster MongoDB deployment with three replica sets:

apiVersion: mongodb.com/v1
kind: MongoDBMultiCluster
metadata:
  name: multi-replica-set
spec:
  version: 8.0.0
  type: ReplicaSet
  duplicateServiceObjects: false
  credentials: my-credentials
  opsManager:
    configMapRef:
      name: my-project
  clusterSpecList:
    - clusterName: cluster1.example.com
      members: 2
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
                  tag2: "value2"
                  environment: "prod"
    - clusterName: cluster2.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
    - clusterName: cluster3.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"

statefulSet

Type: collection

Provides the configuration for the StatefulSet override for each of the cluster's StatefulSets in a multi-Kubernetes cluster MongoDB deployment. To set the global configuration that applies to all clusters in your multi-Kubernetes cluster MongoDB deployment, see spec.statefulSet.spec.

This setting applies only to replica set resource types in multi-Kubernetes cluster MongoDB deployments.

spec.shard.clusterSpecList

Note

This field is exclusively available for multi-cluster sharded cluster deployments.

Type: array of objects

Required if topology=MultiCluster

An array of objects for use in multi-cluster sharded cluster deployments with the following top-level fields:

clusterName

Type: string

Name of the cluster where the MongoDB Enterprise Kubernetes Operator schedules the StatefulSet.

externalAccess

Type: collection

Specification to expose your multi-Kubernetes cluster MongoDB deployment for external connections. To learn how to connect to your multi-Kubernetes cluster MongoDB deployment from outside of the Kubernetes cluster, see Connect to Multi-Cluster Resource from Outside Kubernetes.

These settings apply to services across all clusters. To override these global settings in a specific cluster, use spec.clusterSpecList.externalAccess.externalService.

If you add spec.externalAccess, the Kubernetes Operator creates an external service for each Pod in a replica set. External services provide an external entry point for each MongoDB database Pod in a cluster. Each external service has selectors that match the external service to a specific Pod.

If you add this setting without any values, the Kubernetes Operator creates an external service with the following default values:

Field	Value	Description
Name	<pod-name>-svc-external	Name of the external service. You can't change this value.
Type	LoadBalancer	Creates an external LoadBalancer service.
Port	<Port Number>	A port for mongod.
publishNotReadyAddress	true	Specifies that DNS records are created even if the Pod isn't ready. Do not set to false for any database Pod.

Note

If you set spec.clusterSpecList.externalAccess.externalDomain, the external service adds another port (Port Number + 1) for backups.

members

Type: number

Number of members in the MongoDB replica set.

memberConfig

Type: collection

Specification for each MongoDB shard and its members in your multi-Kubernetes cluster MongoDB deployment.

The order of the elements in the object for shard must reflect the order of members in the replica set. For example, the first element affects the Pod at index 0, the second element affects index 1, and so on.

Example

Consider the following example specification for a multi-Kubernetes cluster MongoDB deployment with three replica sets:

apiVersion: mongodb.com/v1
kind: MongoDBMultiCluster
metadata:
  name: multi-replica-set
spec:
  version: 8.0.0
  type: ReplicaSet
  duplicateServiceObjects: false
  credentials: my-credentials
  opsManager:
    configMapRef:
      name: my-project
  clusterSpecList:
    - clusterName: cluster1.example.com
      members: 2
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
          - votes: 1
            priority: "1.5"
            tags:
                  tag2: "value2"
                  environment: "prod"
    - clusterName: cluster2.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"
    - clusterName: cluster3.example.com
      members: 1
      memberConfig:
          - votes: 1
            priority: "0.5"
            tags:
                tag1: "value1"
                environment: "prod"

podSpec.persistence

Type: collection

Only available in clusterSpecItem objects passed to spec.configSrv.clusterSpecList and spec.shard.clusterSpecList. Overrides the existing persistence configuration for a given cluster.

statefulSet

Type: collection

Provides the configuration for the StatefulSet override for each of the cluster's StatefulSets in a multi-Kubernetes cluster MongoDB deployment. To set the global configuration that applies to all clusters in your multi-Kubernetes cluster MongoDB deployment, see spec.statefulSet.spec.

This setting applies only to replica set resource types in multi-Kubernetes cluster MongoDB deployments.

spec.shardOverrides

Type: array of objects

Optional

List that contains overrides per shard. Each object contains the following fields:

• shardNames

  Required

  The name of the shard this override applies to.

• podSpec.Persistence

  Optional

  Defines how the Kubernetes Operator creates and binds persistent volumes to shards. For topology=MultiCluster it sets persistence settings for all member clusters. You can define persistence settings for a particular member cluster in spec.shardOverrides.clusterSpecList.persistence.

• additionalMongodConfig

  Optional

  Shard-specific override for spec.shard.additionalMongodConfig.

• agent

  Optional

  Shard-specific override for spec.shard.agent.

• statefulSet

  Optional

  Shard-specific override for spec.shardPodSpec.podTemplate and spec.shard.clusterSpecList.statefulSet.

• members

  Optional

  Only available when topology=SingleCluster. Shard-specific override for override for spec.mongodsPerShardCount.

• memberConfig

  Optional

  Only available when topology=SingleCluster. Shard-specific override for spec.shard.memberConfig.

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. For example, if each sharded cluster shard member in 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. Make sure to set the StorageClass reclaimPolicy to Retain. This ensures that data is retained when a Persistent Volume Claim is removed.