Add a MongoDB Cluster

You can add a MongoDB cluster.

To add a MongoDB cluster, follow these steps:

1. From the navigation pane, go to Service catalog.

2. On the Welcome page, in the Big Data tile, click Configure.

3. In the Configure Big Data App page, select MongoDB, and then click Next.

4. Install the MongoDB package on your cluster nodes using one of the following methods.

   If already installed, from the existing nodes list, select a MongoDB master node.

   Interactive installation

   1. Select Interactive installation.

   2. To use backup gateway, enable the Backup gateway toggle key, and select an existing backup gateway or click the add button to add a new backup gateway.

   3. Follow the on-screen instructions to download and install the MongoDB package on the nodes of the MongoDB cluster.

   4. Click the refresh button, and then select the MongoDB master node

   5. Click Next.

   Push installation

   1. Select Push installation.

   2. Click Add to add the MongoDB servers.

   3. Enter the fully qualified host name (FQHN) of the MongoDB node.

   4. Select the OS Type for the node.

   5. Select the credentials or click the add button to add new credentials.

   6. Enter the installation location path, and then click Install.

   7. Click the refresh button, and then select the MongoDB master node

   8. Click Next.

   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.

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

6. Click Next.

7. Enter a name for the MongoDB cluster.

8. For Binary path, specify or browse 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. For OS user name, enter the OS user name to use for the MongoDB servers.

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

   Permissions for OS user

   The OS user must have 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. For Port number, enter the mongod or mongos port number, and then click Next.

11. From the Database credential list, select an existing credential or click the add button to create new credentials.

    Need help creating credentials?

    1. For Credential name, enter the credential name.

    2. For Username, enter the user name of the MongoDB user account.

    3. For Password, enter the password of the database user.

    4. Enter a description, and then click Save.

    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.

12. From the SSL configuration list, select an existing credential or click the add button to create new credentials.

    Need help creating credentials?

    1. For Credential name, enter the credential name.

    2. For SSL CA Certificate path, enter the full path to the Certificate Authority (CA) file that will be used with the mongo commands.

    3. For SSL PEM key file box, enter the full path to the client pem key file that will be used with the mongo commands, to connect to the MongoDB server.

    4. For SSL PEM key password, enter the password to decrypt the client certificate key file.

    5. Enter a description, and then click Save.

    Note

    • Verify that the parameters in the TLS/SSL CA certificate file and the TLS/SSL pem key file have the same names across all nodes of the cluster. The TLS/SSL pem key password value must be the same on all the nodes of the cluster.

    • If you have customized TLS/SSL CA certificate file and the TLS/SSL pem key files across nodes, then you can configure the bEnableMongoSSL, sMongoSSLClientCAFile, sMongoSSLClientPEMKeyFile and pMongoSSLClientPEMKeyPassword additional settings.

13. Click Next, and then complete the configuration wizard.

14. To run a manual backup, go to the cluster, and then in the upper-right area of the page, click Backup.