Docs Menu
Docs Home
/
Ops Manager
/
Backup & Restore

Backup and Restore with Third-Party Platforms

To enable reuse of existing third-party backup solutions, you can integrate Ops Manager with one of the following third-party backup platforms that support certified MongoDB cluster snapshot backups and restores with secure and scalable storage (including cold storage), immutability enforcement, and compliance policy support:

  • Cohesity DataProtect

  • Rubrik

With these integrations, you can coordinate scheduled or on-demand backups and restores of your MongoDB clusters directly from your third-party management console to streamline your backup, retention, and recovery operations across data platforms without the complexity and additional operational costs of managing Ops Manager at backup scale.

To begin the backup or restore process, the third-party backup platform calls the Ops Manager Administration API to put your MongoDB cluster into a backup-ready or restore-ready state. The third-party platform handles all backup or restore operations, before it calls the Ops Manager Administration API again to return the cluster to a normal running state.

While MongoDB Support can help you configure the integration points in Ops Manager, contact your third-party vendor for functionality or performance issues related to the backup and restore process.

Note

Third-party backups can't run alongside Ops Manager's native backup process on the same cluster. However, you can run both types of backups in separate clusters within the same project for a flexible resilience strategy.

Prerequisites

  • Your Ops Manager project must run MongoDB Ops Manager version 8.0.8 or later to integrate with third-party backup platforms.

  • See your vendor's documentation for the tooling version to use.

  • Synchronize the clocks across all of your host machines before you configure Ops Manager for third-party backup integration. To learn more, see Clock Synchronization.

Integrate Ops Manager with a Third-Party Backup Platform

Complete the following preliminary setup in Ops Manager before you go to your third-party platform to finish setting up your integration:

1

Generate API keys for the Ops Manager Administration API.

To grant the appropriate level of Ops Manager Administration API access to your third-party vendor, you must generate either a global or project-level API key in Ops Manager.

See your third-party vendor's documentation to determine which level of API access is necessary for your integration.

To generate an API key for global Ops Manager Administration API access:

  1. In the Ops Manager Admin console, click General and API Keys.

  2. Click the Create API Key button.

  3. In the Enter API Key Information modal, provide a description for your API key and select Global Backup Admin from the Global Permissions drop-down menu.

  4. Click the Next button.

  5. Copy the Public Key and Private Key and store them in a secure location.

    Each API request requires these keys in the header to securely communicate with Ops Manager.

  6. Click Done.

To generate an API key for project-level Ops Manager Administration API access:

  1. In your Ops Manager project, expand the Access Manager drop-down menu and select Project Access.

  2. Click the API Keys tab.

  3. Click the Create API Key button.

  4. In the Enter API Key Information modal, provide a description for your API key and select Project Backup Admin from the Project Permissions drop-down menu.

  5. Click the Next button.

  6. Copy the Public Key and Private Key and store them in a secure location.

    Each API request requires these keys in the header to securely communicate with Ops Manager.

  7. Click Done.

To learn more about Ops Manager Administration API access, see Programmatic Access to Ops Manager.

2

Enable third-party backup in the Ops Manager configuration.

  1. In the Ops Manager Admin console, click General and Ops Manager Config.

  2. Click the Custom tab.

  3. Add one of the following key and value pairs to enable third-party backup at the global or project level.

    See your third-party vendor's documentation to determine which level of access is necessary for your integration.

    Access Level
    Key
    Value

    Project

    mms.featureFlag.backup.thirdPartyManaged

    controlled

    Global

    mms.featureFlag.backup.thirdPartyManaged

    enabled

  4. Click Save to enable third-party backup.

3

(Conditional) Enable third-party backup in the Ops Manager project settings.

If you enabled third-party backup at the project level in the previous step, you must enable third-party backup in your MongoDB project settings:

  1. In your Ops Manager project, click Settings.

  2. Click the Beta Features tab, and click Backup Third Party Managed.

4

Install MongoDB Agents on every server in the cluster.

If not already installed, install MongoDB Agents on every server in each MongoDB cluster that you want to back up:

  1. In your Ops Manager project, click Deployment, the Agents tab, and the Downloads & Settings tab.

  2. Select your host machine's operating system from the Select your operating system drop-down menu.

  3. Follow the instructions to install a MongoDB Agent on each of the MongoDB servers that you want to back up.

To learn more, see Install the MongoDB Agent to Manage Deployments.

5

Set an oplog file path for third-party backup.

To set an directory for MongoDB Agent oplog output:

  1. In the Ops Manager Admin console, click General and Ops Manager Config.

  2. Click the Custom tab, and add the following key and value pair:

    Key
    Value

    brs.thirdparty.baseOplogFilePath

    Path to a directory that the MongoDB Agent can access.

  3. Click Save to add your file path parameter.

  4. For each MongoDB Agent that you set up previously, verify that the Agent can read and write to the oplog directory.

    For verification methods, see your operating system's documentation.

6

Enable monitoring and backup on every server in the cluster.

In your Ops Manager project, click Deployment, and the Servers tab to view the MongoDB cluster servers that your Ops Manager project manages.

For each server:

  1. Click the menu next to your target server's MongoDB Agent.

  2. Click Activate Monitoring and Activate Backup.

  3. Click Review & Deploy.

    The Review Your Changes modal appears.

  4. After you review your changes, click Confirm & Deploy.

7

Set continuous backup to third-party managed.

  1. In your Ops Manager project, click Continuous Backup.

  2. Hover over the Status column for the target sharded cluster or replica set and click Manage.

  3. In the ensuing modal, click Manage.

    The cluster's Continuous Backup status changes to Third Party Managed.

8

Finish integrating with your third-party platform.

To finish integrating Ops Manager with your third-party backup platform, see your vendor's documentation:

Back

Single Database or Collection

Next

Security

On this page