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, then the MongoDB host name must resolve to an IP address 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 both Windows and Linux for full backups. Authentication is supported only on Linux for incremental backups.
-
For MongoDB deployments with authentication enabled, use a database user with one of the following:
-
rootrole on the admin database (superuser) -
backup,restore, andclusterAdminroles on the admin database as an alternative to superuser access.
-
-
Logical Volume Manager (LVM) volume groups must have sufficient free space for creating the IntelliSnap snapshots. The default COW cache size is set to 4096 MB or 5% of the volume size, whichever is greater. You can increase the COW cache size.
Replica Set Environments
Replica sets must have at least one secondary node.
Note
If you have a single node replica set that has only a primary node, add the bMongoDBEnableBkpForSingleNodeRepSet additional setting to the client node that you want to back up.
Protect Encrypted Database
The Commvault software protects MongoDB Replica Set clusters with 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 key file is backed up from the source master node.
Note
All nodes of the cluster must have the same key file contents.
-
For encrypted database restores, the Commvault software does following:
-
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 used to start the staging server.
-
-
Enable the encryption setting on destination clients only when restoring from an encrypted backup.
Note
The Encryption at rest support feature that is enabled by bMongoDbEnableBkpEncryptionKey is only supported for replica set clusters.
Sharded Cluster Environments
-
The same database user must be created 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.
Supported MongoDB and Percona Server Versions
MongoDB Versions
| Operating system | Processor architectures | MongoDB 8.x | MongoDB 7.x | MongoDB 6.x |
|---|---|---|---|---|
| Amazon Linux 2023 AMI | x86_64 | Yes | Yes | NA |
| Amazon Linux 2 | x86_64 | NA | Yes | Yes |
| Debian 12 | x86_64 | Yes | Yes | NA |
| Debian 11 | x86_64 | NA | NA | Yes |
| Debian 10 | x86_64 | NA | NA | Yes |
| RHEL/Rocky/Alma/Oracle Linux 9.x | x86_64 | Yes | Yes | 6.0.4+ |
| RHEL/Rocky/Alma/Oracle Linux 8.x | x86_64 | Yes | Yes | Yes |
| RHEL/Oracle Linux 7.x | x86_64 | NA | Yes | Yes |
| RHEL/CentOS 7 | PowerPC (little endian) | NA | NA | 6.0.7+ |
| SuSE Linux 15 | x86_64 | Yes | Yes | Yes |
| SuSE Linux 12 | x86_64 | NA | Yes | Yes |
| Ubuntu 24.04 | x86_64 | Yes | NA | NA |
| Ubuntu 22.04 | x86_64 | Yes | Yes | 6.0.4+ |
| Ubuntu 20.04 | x86_64 | Yes | Yes | Yes |
| Ubuntu 18.04 | x86_64 | NA | NA | Yes |
| Windows Server 2022 | x86_64 | Yes | Yes | Yes |
| Windows Server 2019 | x86_64 | NA | Yes | Yes |
| Windows Server 2016 | x86_64 | NA | NA | Yes |
Note
-
Starting from MongoDB 4.4, the mongodump and mongorestore utilities must be downloaded separately and copied to the bin path.
-
MongoDB 7.0 is supported only from CPR2023E (11.32) Maintenance Release 55 or higher. The most recent certified version of MongoDB 7.x is 7.0.14.
Percona Server for MongoDB Versions
Percona Server 7.x, 6.x, 5.x, 4.4.x, 4.2.x.
Note
-
Percona 7.x is supported only from CPR2023E (11.32) Maintenance Release 55 or higher.
-
The most recent certified version of Percona Server for MongoDB 7.x is 7.0.14-8.