×

Welcome to Knowledge Base!

KB at your finger tips

This is one stop global knowledge base where you can learn about all the products, solutions and support features.

Categories
All
Database-MongoDB
Install the MongoDB Agent to Manage Deployments — MongoDB Cloud Manager

Install the MongoDB Agent to Manage Deployments¶

  • Windows
  • Ubuntu/Debian
  • RHEL/CentOS/SLES/AMZ
  • Linux

You have a project and want to install the MongoDB Agent to manage your MongoDB deployments. You can also monitor and back up your MongoDB deployments following this workflow.

Review the Prerequisites First

Please review the MongoDB Agent Prerequisites before installing the MongoDB Agent.

Use this procedure to install the MongoDB Agent on x86_64 architecture running Microsoft Windows:

1

Log in to the Cloud Manager.¶

2

Begin or Manage a Deployment.¶

Your project has no deployments and you see a prompt to get started.

  1. From the Build New Deployment menu, select the type of deployment you wish to add:

    • New Sharded Cluster
    • New Replica Set
    • New Standalone
  2. If, on the Create New <Deployment> page, Cloud Manager cannot detect any hosts with the MongoDB Agent installed, you see a banner displayed at the top of the Create New <Deployment> page.

    Click the see instructions link.

  3. From the Select Your Server’s Operating System menu, click Windows - MSI .

  4. Click Next .

3

Download the MongoDB Agent.¶

The MongoDB Agent Installation Instructions box displays the following information:

  • Project ID (Required for binding to a project)

  • API Key

    If you do not have an API Key, click plus icon Generate Key .

Some or all of these values are required in a later step. Copy these values then store them where you can access them later.

4

Install the MongoDB Agent.¶

  1. After the MSI downloads, double-click:

    mongodb-mms-automation-agent-<VERSION>.windows_x86_64.msi

  2. If a security warning appears, click Run .

  3. At the Configuration/Log Folder step

    Provide the directory into which these files are saved.

  4. At the Key Type step, select Agent API Key to bind to a specific project .

  5. Enter the appropriate agent keys.

    Note

    These keys are provided in the MongoDB Agent Installation Instructions modal described in the previous step.

    • Type your Project ID into the Project ID field.
    • Type your Agent API Key into the Agent API Key field.
  6. At the MongoDB Paths step, specify the Log and Backup directories

  7. At the Windows Firewall Configuration step, click your preferred firewall configuration.

    If you click Configure firewall rules allowing access from only the specified |ipaddr| addresses. , type the necessary IPv4 addresses into the provided box.

  8. (Conditional) Windows enables Stealth Mode for the Windows Firewall by default. If you have not disabled it on the MongoDB host on which you are installing the MongoDB Agent, you are asked to disable it. Stealth Mode significantly degrades the performance and capability of the MongoDB Agent. Click Disable Stealth Mode .

  9. (Conditional) Windows does not enable Disk Performance Counters by default. If you have not enabled Disk Performance Counters for the MongoDB host, click Enable Disk Performance Counters . The MongoDB Agent uses these counters for some of its hardware monitoring activities.

  10. Click Install .

  11. Click Finish once setup is complete.

5

Finish the installation of the MongoDB Agent.¶

In the Install Agent Instructions modal:

  1. Click Verify Agent to make sure the MongoDB Agent can connect to Cloud Manager.
  2. Click Done .
6

(Optional) Change the location of the MongoDB Agent binaries and configuration backup files.¶

By default, the MongoDB binaries and Cloud Manager configuration backup file are located in %SystemDrive%\MMSMongoDB\versions .

Note

Windows sets the %SystemDrive% environment variable to the drive on which you installed Windows. By default, you would be directed to install Windows on the C: drive. To find your %SystemDrive% , issue with following command from PowerShell:

get-childitem env:SystemDrive

If you want to store these files in a different directory, follow these procedures:

To change the location of the MongoDB Agent Binaries

  1. Click Deployment , then Agents , and then Downloads & Settings .

  2. Below the Download Directory heading, click edit icon to the right of the path shown in Download Directory (Windows) .

  3. Change the path to the new path you want.

  4. Click Save .

  5. Create the new directory you specified on each host that runs an MongoDB Agent. Use Windows Explorer to move the file or issue the following command from a Command Prompt or PowerShell:

    md \<newPath>
    

    Important

    Make sure the system user that runs the MongoDB Agent can write to this new directory. This is usually the SYSTEM user, which requires no additional configuration unless you changed the user.

To change the location of the MongoDB Agent configuration backup

  1. Open the MongoDB Agent configuration file in your preferred text editor.

  2. Change the mmsConfigBackup setting to the new path for the configuration backup file. Replace X with the drive letter on which your backup is stored.

    mmsConfigBackup=X:\<newPath>\mms-cluster-config-backup.json
    
  3. Save the MongoDB Agent configuration file.

  4. Move the configuration backup file to the new directory. Use Windows Explorer to move the file or issue the following command from a Command Prompt or PowerShell:

    move %SystemDrive%\MMSMongoDB\versions\mms-cluster-config-backup.json \<newPath>
    
7

Repeat the installation procedure for each MongoDB host.¶

Return All Connected Organizations — MongoDB Cloud Manager

Return All Connected Organizations¶

On this page

  • Required Roles
  • Resource
    • Request Path Parameters
    • Request Query Parameters
    • Request Body Parameters
  • Response
    • Response Document
    • results Embedded Document
  • Example Request
  • Example Response

The federationSettings resource allows you to return all connected organizations for a federated authentication configuration.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Required Roles¶

You must have the Organization Owner role for at least one connected organization in the federation configuration to call this endpoint.

Resource¶

GET /federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs/

Request Path Parameters¶

Name Type Description
FEDERATION-SETTINGS-ID string Unique 24-hexadecimal digit string that identifies the federated authentication configuration.

Request Query Parameters¶

The following query parameters are optional:

Name Type Necessity Description Default
pageNum number Optional One-based integer that returns a subsection of results. 1
itemsPerPage number Optional Number of items to return per page, up to a maximum of 500. 100
pretty boolean Optional Flag that indicates whether the response body should be in a prettyprint format. false
envelope boolean Optional

Flag that indicates whether or not to wrap the response in an envelope.

Some API clients cannot access the HTTP response headers or status code. To remediate this, set envelope : true in the query.

For endpoints that return a list of results, the results object is an envelope. Cloud Manager adds the status field to the response body.

false

Request Body Parameters¶

This endpoint does not use HTTP request body parameters.

Response¶

Response Document¶

The response JSON document includes an array of result objects, an array of link objects and a count of the total number of result objects retrieved.

Name Type Description
results array of objects One object for each item detailed in the results Embedded Document section.
links array of objects One or more links to sub-resources and/or related resources. All links arrays in responses include at least one link called self . The relationships between URL s are explained in the Web Linking Specification .
totalCount integer Count of the total number of items in the result set. It may be greater than the number of objects in the results array if the entire result set is paginated.

results Embedded Document¶

Each document in the result array contains the federated authentication configuration for each connected organization.

Name Type Description
domainAllowList array List that contains the approved domains from which organization users can log in.
domainRestrictionEnabled boolean

Flag that indicates whether domain restriction is enabled for the connected organization.

Note

userConflicts returns null when "domainRestrictionEnabled": false .

identityProviderId string Unique 20-hexadecimal digit string that identifies the identity provider associated with the connected organization.
orgId string Unique 24-hexadecimal digit string that identifies the connected organization.
postAuthRoleGrants array List that contains the default roles granted to users who authenticate through the IdP in a connected organization.
roleMappings array List that contains the role mappings configured in this organization.
userConflicts array

List that contains the usernames that don’t match any domain on the allowed list.

Note

userConflicts returns null when "domainRestrictionEnabled": false .

Example Request¶

curl --user "{PUBLIC-KEY}:{PRIVATE-KEY}" --digest \
     --header "Accept: application/json" \
     --header "Content-Type: application/json" \
     --include \
     --request GET "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs"

Example Response¶

{
 "links": [
     {
         "href": "https://<OpsManagerHost>:<Port>/api/public/v1.0/federationSettings/{FEDERATION-SETTINGS-ID}/connectedOrgConfigs?pageNum=1&itemsPerPage=100",
         "rel": "self"
     }
 ],
 "results": [
     {
         "domainAllowList": [],
         "domainRestrictionEnabled": false,
         "identityProviderId": null,
         "orgId": "5f86fb11e0079069c9ec3132",
         "postAuthRoleGrants": [],
         "roleMappings": [],
         "userConflicts": null
     }
 ],
 "totalCount": 1
}
Read article
Disks — MongoDB Cloud Manager

Disks¶

Retrieves the disks and disk partitions on which MongoDB runs.

Base URL: https://cloud.mongodb.com/api/public/v1.0

Endpoints¶

The following endpoints are available for hosts .

Method Endpoint Description
GET /groups/{PROJECT-ID}/hosts/{HOST-ID}/disks Retrieves all disk partitions on the specified host.
GET /groups/{PROJECT-ID}/hosts/HOST-ID/disks/{PARTITION-NAME} Retrieves a single disk parition.
Read article
Configure AWS Integration — MongoDB Cloud Manager

Configure AWS Integration¶

On this page

  • Considerations
  • Rolling Resync onto New EC2 Instances
  • Update a Replica Set’s Hostnames

Important

The ability to provision MongoDB servers in AWS using Cloud Manager was retired in October 2017.

  • Any existing clusters continue as they are.
  • This retirement impacts DNS entries in the following ways:
    • Entries for existing servers continue to resolve to the same IP address to which they currently resolve until at least January 1, 2023.
    • Servers that undergo a change of IP address due to maintenance or an instance stop/restart will no longer be resolvable via their mongodbdns.com hostname.
    • All existing mongodbdns.com hostnames will stop working in May 2023.
  • Cloud Manager can manage hosts provisioned directly through AWS . See Provision Servers for Automation .
  • If you are interested in fully managed provisioning on AWS , evaluate MongoDB Atlas.

If you want to continue using Cloud Manager to manage these deployments, update the hostname for each host using one of the following methods for a replica set:

  • Rolling Resync onto New EC2 Instances
  • Update a Replica Set’s Hostnames

Considerations¶

These procedures involve stepping down the old primary and triggering at least one election for a new primary. All writes to the primary fail during the period starting when the rs.stepDown() method is received until either a new primary is elected, or if there are no electable secondaries, the original primary resumes normal operation. For MongoDB versions 4.0 and earlier, all client connections are closed.

Consider performing this procedure during a maintenance window during which applications stop all write operations to the cluster.

To learn more about elections, see rs.stepDown() behavior and Replica Set Elections .

Rolling Resync onto New EC2 Instances¶

1

Create a new EC2 instance for each member of the replica set.¶

2

Replace each non-primary replica set member with a new EC2 instance.¶

  1. Add a new instance to the replica set using its EC2 hostname. To learn more, see Add Members to a Replica Set.
  2. Wait for the initial sync to complete. To learn how to get the status of an initial sync, see the MongoDB manual.
  3. Remove one old replica set member with a mongodbdns.com hostname. To learn more, see Remove Members from Replica Set.

Repeat for each non-primary replica set member.

3

Change your application connection string to use the AWS EC2 hostnames.¶

4

Replace the primary with a new EC2 instance.¶

  1. Add the last new instance to the replica set using its EC2 hostname. To learn more, see Add Members to a Replica Set.

  2. Wait for the initial sync to complete. To learn how to get the status of an initial sync, see the MongoDB manual.

  3. Connect to the primary and step it down. To learn more, see rs.stepDown() .

    Note

    Stepping down the primary triggers at least one election for a new primary. To learn more about elections, see Replica Set Elections .

  4. Remove the old primary with the mongodbdns.com hostname from the replica set. To learn more, see Remove Members from Replica Set.

Update a Replica Set’s Hostnames¶

Follow the Change Hostnames while Maintaining Replica Set Availability procedure in the MongoDB manual.

An overview of the linked procedure is as follows:

1

Connect to the primary.¶

2

Remove a secondary member from the replica set and re-add it using its EC2 hostname.¶

Repeat for each non-primary member of the replica set.

3

Change your application connection string to use the AWS EC2 hostnames.¶

4

Reconnect to the primary and step it down.¶

Note

Stepping down the primary triggers at least one election for a new primary. To learn more about elections, see Replica Set Elections .

5

Connect to the new primary.¶

6

Remove the old primary from the replica set and re-add it using its EC2 hostname.¶

Read article
Stop, Restart, or Terminate a Backup — MongoDB Cloud Manager

Stop, Restart, or Terminate a Backup¶

On this page

  • Stop Backup for a Deployment
  • Restart Backup for a Deployment
  • Terminate a Deployment’s Backups

When you stop backups for a replica set or sharded cluster Cloud Manager stops taking new snapshots but retains existing snapshots until their listed expiration date.

If you later restart backups for replica set or cluster, Cloud Manager might perform an initial sync , depending on how much time has elapsed.

If you terminate a backup, Cloud Manager immediately deletes all the backup’s snapshots.

Stop Backup for a Deployment¶

1

Click Continuous Backup , then the Overview tab.¶

2

On the line listing the process, click the ellipsis icon and click Stop

3

Click the Stop button.¶

If prompted for an authentication code, enter the code and click Verify . Click Stop again.

Restart Backup for a Deployment¶

1

Click Continuous Backup , then the Overview tab.¶

2

On the line listing the process, click the ellipsis icon and click Restart

3

Select a Sync source and click Restart.

Terminate a Deployment’s Backups¶

Terminating a backup triggers a full backup

If you terminate a backup, Cloud Manager immediately deletes the backup’s snapshots. The next backup job runs as a full backup rather than an incremental backup.

1

Click Continuous Backup , then the Overview tab.¶

2

Click the ellipsis h icon next to the backup.¶

3

Click the Stop button.¶

If prompted for an authentication code, enter the code and click Verify . Click Stop again.

4

Once the backup has stopped, click the backup’s ellipsis icon and click Terminate

5

Click the Terminate button.¶

Read article
Manage Alerts — MongoDB Cloud Manager

Manage Alerts¶

On this page

  • Overview
  • View Alerts
  • View All Activity
  • Retrieve the Activity Feed
  • Acknowledge an Alert
  • Unacknowledge an Alert
  • Disable Alerts for a Specific Process
  • Suspend Alerts by Adding a Maintenance Window

Overview¶

Cloud Manager issues alerts for the database and server conditions configured in your alert settings . When a condition triggers an alert, you receive the alert at regular intervals until the alert resolves or Cloud Manager cancels it. You should fix the immediate problem, implement a long-term solution, and view metrics to monitor your progress.

View Alerts¶

1
2

If it is not already displayed, click the All Alerts tab.¶

View All Activity¶

1
2

Filter the activity feed.¶

You can filter the organization activity feed by event type and time range. You can combine filtering methods together for greater control over the activity feed output.

Filter by event

Select the event categories or specific events you want to see from the activity feed. To exclude specific categories or events from the activity feed, click Select all categories and events , then deselect the categories and events you want to exclude.

You can filter events based on the following categories:

Category Description
Access Events related to Cloud Manager users.
Alerts Events related to alert configuration and monitoring.
Billing Events related to payments and payment methods.
Others Miscellaneous events, including log retrieval and mLab events.
Organization Events related to your Cloud Manager organization.
Projects Events related to Cloud Manager projects.
Filter by time range
Select a Start Date and End Date to view events from within a specified time range. Once you have configured a time range, click Apply Dates to update the activity feed with the specified range.

Retrieve the Activity Feed¶

You can retrieve events for a specified organization or project using the Events API resource.

Acknowledge an Alert¶

When you acknowledge the alert, Cloud Manager sends no further notifications to the alert’s distribution list until the acknowledgment period has passed or until you resolve the alert. The distribution list receives no notification of the acknowledgment.

If the alert condition ends during the acknowledgment period, Cloud Manager sends a notification of the resolution.

If you configure an alert with PagerDuty, a third-party incident management service, you can only acknowledge the alert on your PagerDuty dashboard.

1

Navigate to the Alerts page for your organization.¶

  1. If it is not already displayed, select your desired organization from the office icon Organizations menu in the navigation bar.
  2. Click Alerts in the sidebar.
2

Acknowledge alerts¶

To acknowledge a single alert, on the line item for the alert, click Acknowledge .

To acknowledge multiple, but not all, alerts:

  1. Check the checkbox to the left of each alert to acknowledge.
  2. Click Mark Acknowledge above the table.

To acknowledge all alerts:

  1. Select the checkbox in the table header to select every alert.
  2. Click Mark Acknowledge above the table.
3

Select the time period for which to acknowledge the alert.¶

Click the time frame for which you no longer wish to receive alerts.

Cloud Manager sends no further alert messages for the period of time you select.

4

Optional: If all Alerts were checked, select All Visible or All Open Alerts

If all alerts are checked, then another set of radio buttons appear:

  • Click Acknowledge all visible checked alerts to acknowledge all alerts that were loaded onto the page.
  • Click Acknowledge all open alerts to acknowledge all alerts: checked, unchecked, visible and not visible on the current page.
5

Click Acknowledge to confirm.¶

Unacknowledge an Alert¶

You can undo an acknowledgment and again receive notifications if the alert condition still applies.

1

Navigate to the Alerts page for your organization.¶

  1. If it is not already displayed, select your desired organization from the office icon Organizations menu in the navigation bar.
  2. Click Alerts in the sidebar.
2

On the line item for the alert, click Unacknowledge

3

Click Confirm

If the alert condition continues to exist, Cloud Manager resends the alerts.

Disable Alerts for a Specific Process¶

You can turn off alerts for a given process. This might be useful, for example, if you want to temporarily disable the process but do not want it hidden from monitoring. Use the following procedure both to turn alerts off or on.

1
2

On the line listing the process, click the ellipsis icon and select Monitoring Settings

3

Select Alert Status and then modify the alert settings.¶

Suspend Alerts by Adding a Maintenance Window¶

Specify maintenance windows to temporarily turn off alert notifications for a given resource while you perform maintenance.

To view maintenance windows:

1
2

Click the Maintenance Windows filter.¶

Add or Edit a Maintenance Window¶

1

Navigate to the Alert Settings tab.¶

  1. If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Click the bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
  4. Click the Alert Settings tab.
2

Add or edit a maintenance window.¶

  • To add a maintenance window: Click the Add button and select New Maintenance Window .
  • To edit a maintenance window: Click the Maintenance Windows filter, then click the ellipsis icon for a mainenance window and select Edit .
3

Select the target components for which to suspend alerts.¶

Note that selecting the Host target selects both HOST and HOST_METRIC alert configurations returned through the alertConfigs endpoint .

4

Select the time period for which to suspend alerts.¶

5

Enter an optional description for the maintenance window.¶

6

Click Save

Delete a Maintenance Window¶

1

Navigate to the Alert Settings tab.¶

  1. If it is not already displayed, select the organization that contains your desired project from the office icon Organizations menu in the navigation bar.
  2. If it is not already displayed, select your desired project from the Projects menu in the navigation bar.
  3. Click the bell icon Project Alerts icon in the navigation bar, or click Alerts in the sidebar.
  4. Click the Alert Settings tab.
2

Click the Maintenance Windows filter.¶

3

For the window to delete, click the ellipsis icon and select Delete

4

Click Confirm

Read article

Still Thinking?
Give us a try!

We embrace agility in everything we do.
Our onboarding process is both simple and meaningful.
We can't wait to welcome you on AiDOOS!