System Requirements for MongoDB

Verify that your environment meets the system requirements.

All Environments

• All mongod and mongos instances must run with configuration files in the YAML format.

• If the ports between the master node and the other cluster nodes are blocked, the nodes must connect through a firewall.

• If the client name and the MongoDB host name differ, the MongoDB host name must resolve to an IP address that is accessible by Commvault and is included in the MongoDB bind_ip setting.

• The security.keyFile parameter value must be identical across cluster nodes.

Linux Environments

• Database authentication is supported on Windows and Linux for full backups. For incremental backups, authentication is supported only on Linux.

• For MongoDB deployments with authentication enabled, use a database user with one of the following role configurations:

  • root role on the admin database (superuser)

  • backup, restore, and clusterAdmin roles on the admin database as an alternative to the root role.

• Logical Volume Manager (LVM) volume groups must have enough free space to create IntelliSnap snapshots. By default, the copy-on-write (COW) cache size is 4096 MB or 10% of the volume size, whichever is greater. You can increase the COW cache size if needed.

  Note

  • As a best practice, keep at least 10% free space in the volume group. This free space is typically sufficient for environments with low to moderate write activity. If your workload changes data frequently, you may need more free space to prevent the snapshot from becoming invalid.

  • For native LVM snapshots, the lvm.conf setting event_activation in the /etc/lvm/lvm.conf file can be set to either 0 or 1. Both settings are supported.

Replica Set Environments

Replica sets must have at least one secondary node.

Protect Encrypted Database

Commvault protects MongoDB Replica Set clusters that use encrypted databases. MongoDB clusters must use a local master encryption key file on all the nodes to encrypt the databases. You must configure the bMongoDbEnableBkpEncryptionKey additional setting on all MongoDB clients for backup and restore operations. During discovery or a full backup, the software backs up the key file from the source master node.

• For encrypted database restores, the Commvault software performs the following actions:

  • In-place restore

    • Restores the key file to its original location.

    • Automatically renames the existing key file.

  • Out-of-place restore

    • Restores the key file to all destination clients.

    • Creates the key file path if it does not exist.

  • Granular restore

    • Creates the key file on the 3DFS share that is used to start the staging server.

Enable encryption on the destination clients only when restoring from an encrypted backup.

Sharded Cluster Environments

• Create the same database user on all shard servers and the config server.

• Each sharded server must be a replica set, and the replica set must have at least one secondary node.

• The Commvault software is not required on the arbiter nodes. No client is associated with the arbiter during node discovery, and this does not impact backup or restore operations.

Job Results Directory Space Requirements

For incremental backups, the software creates oplog dump files every 15 minutes in the job results directory.

Ensure that the job results directory has sufficient free space to accommodate the cumulative size of the oplog dump files that are generated until the next incremental backup.

Supported MongoDB and Percona Server Versions

MongoDB Versions

Percona Server for MongoDB Versions

Percona Server 7.x, 6.x