Adding a MongoDB Cluster

You can add a MongoDB cluster.

Before You Begin

• 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.

• Verify that all mongod and mongos instances use configuration files in YAML format (required on all operating systems).

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

  • root role on the admin database (superuser), or

  • backup, restore, and clusterAdmin roles on the admin database (as an alternative to superuser access).

• In sharded clusters, create the same database user on all shard servers and the config server.

• 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.

• On Linux platforms, the default subclient uses the IntelliSnap Native engine (Logical Volume Manager (LVM) snapshots) for the snapshot operations.

  • For Linux LVM snaps, there must be sufficient free space in the LVM volume group for snapshot creation.

  • The default COW cache size is set to 4096 MB or 5% of the volume size, whichever is greater. To increase the COW cache size, configure the nSnapCowSizeMB additional setting.

Procedure

1. From the navigation pane, go to Protect > Big data.

   The Big data page appears.

   Note

   If Big data is not listed under Protect menu in the navigation pane, then go to Guided setup and click Configure on the Big data tile to add your first MongoDB cluster.

2. Click Add cluster.

   The Configure Big Data App page appears.

3. Select MongoDB, and then click Next.

   The Configure MongoDB Cluster page appears.

4. Select an existing backup plan or create a new backup plan.

5. Click Next

   The Add MongoDB Cluster page appears.

6. In the Cluster name box, enter a name for the cluster.

7. From the Master node list, select the master node.

   Note

   If the selected master node is not available due to a network failure or any other reason and a backup is in progress, then the Commvault software does the following:

   • For the replica set environments, the software picks another node as master node from the replica set for backup operation.

   • For sharded cluster environments, the node with mongos (routing service) is picked as master node.

8. In the Binary path box, enter the path to the folder that contains the mongod or mongos executable file.

   The Commvault software uses mongo/mongosh, mongod, mongodump, and mongorestore for backup and restore operations. Keep the binaries in bin path and verify that the bin path is same across all the nodes in the cluster.

9. In the OS user name box, enter the OS user name that you want to use to run the MongoDB servers.

   Commvault software uses the OS user name to start the MongoDB servers after the restore operation.

   Note

   The OS user must have the permissions to do the following:

   • Start/stop the MongoDB service.

   • Read/write access to the files in dbPath and log directories.

   • Execute permissions on MongoDB binaries.

   • Access to the configured network ports.

10. In Port number box, enter the mongod or mongos port number.

11. Click Next.

    The Database Authentication page appears.

12. In the DB user name box, enter the database user name.

    Note

    • The MongoDB authentication user account must be associated with the admin database.

    • For sharded cluster environments, you must create the same database user on all the sharded servers and the config server.

13. In the DB password box, enter the password.

14. Click Next.

    The Summary page appears, where you can see the MongoDB configuration details.

15. Click Finish.