Configure MongoDB Agent for Authentication

Configure Deployments Managed by Automation

When you install the MongoDB Agent with Automation, Cloud Manager creates a user to authenticate on the MongoDB database. Cloud Manager create this MongoDB user (mms-automation) in the admin database with the correct privileges for each MongoDB Agent function.

Configure these credentials in Cloud Manager.

1. In MongoDB Cloud Manager, go to the Security page for your project.

   1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. In the sidebar, click Security under the Database heading.

   The Security page displays.

2. Click Settings.

3. Continue through the modal until you see the Configure Cloud Manager Agents page.

4. Add the appropriate credentials:

   Setting	Value
   MongoDB Agent Username	Enter the MongoDB Agent username.
   MongoDB Agent Password	Enter the password for the MongoDB Agent username.

Configure Deployments Not Managed by Automation

Each MongoDB Agent function uses a different set of MongoDB shell (mongosh) commands to configure a user with the appropriate roles and privileges.

User creation commands vary depending on the version of MongoDB that you use:

db.getSiblingDB("admin").createUser(
   {
      user: "<username>",
      pwd: "<password>",
      roles: [ {
         role: "clusterAdmin", db: "admin"
      } ]
   }
)

db.getSiblingDB("admin").createUser(
   {
      user: "<username>",
      pwd: "<password>",
      roles: [ {
         role: "backup", db: "admin"
      } ]
   }
)

Configure Backup Credentials

After you create the user for the Backup function, add the credentials to the Backup Settings.

1. Navigate to Backup <backup-deployment> Edit Credentials.

2. Click Credentials.

3. Add the appropriate credentials:

   Setting	Value
   Backup Username	Enter the Backup username.
   Backup Password	Enter the password for the Backup username.

Configure Deployments Not Managed by Automation

Each MongoDB Agent function uses a different set of MongoDB shell (mongosh) commands to configure a user with the appropriate roles and privileges.

To monitor MongoDB 4.0 or later instances that use SCRAM authentication, add a user to the admin database in MongoDB. Assign this user the roles provided in the following example.

db.getSiblingDB("admin").createUser(
  {
    user: "<username>",
    pwd: "<password>",
    roles: [ {
      role: "clusterMonitor", db: "admin"
    } ]
  }
)

db.getSiblingDB("admin").createUser(
  {
    user: "<username>",
    pwd: "<password>",
    roles: [
      { role: "clusterMonitor", db: "admin" },
      { role: "directShardOperations", db: "admin" }
    ]
  }
)

To learn what roles this function requires, see Monitoring settings.

Configure Monitoring Credentials

After you create the user for the Monitoring function, add the credentials to the Monitoring Settings.

1. In MongoDB Cloud Manager, go to the Processes page for your project.

   1. If it's not already displayed, select the organization that contains your desired project from the Organizations menu in the navigation bar.

   2. If it's not already displayed, select your desired project from the Projects menu in the navigation bar.

   3. In the sidebar, click Processes under the Database heading.

   The Processes page displays.

2. Click the , and then Monitoring Settings.

3. Click Credentials.

4. Add the appropriate credentials:

   Setting	Value
   Monitoring Username	Enter the Monitoring username.
   Monitoring Password	Enter the password for the Monitoring username.