NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.4)
  1. Overview of protecting MongoDB using NetBackup
    1.  
      About protecting a sharded, replica set, or standalone MongoDB cluster using NetBackup
    2.  
      Protecting MongoDB data using NetBackup
    3.  
      NetBackup for MongoDB terminologies
    4.  
      Limitations
    5.  
      Prerequisites and the best practices for protecting MongoDB
  2. Verify the pre-requisites for the MongoDB plug-in for NetBackup
    1.  
      Operating system and platform compatibility
    2.  
      Prerequisites for configuring the MongoDB plug-in
  3. Configuring NetBackup for MongoDB
    1.  
      About the MongoDB configuration tool
    2.  
      Prerequisites for manually creating the mongodb.conf file
    3. Configuring backup options for MongoDB using the mongodb.conf file
      1.  
        Including the configuration file path in the allowed list on the NetBackup primary server
    4.  
      Obtaining the RSA key of the MongoDB nodes
    5. Adding MongoDB credentials in NetBackup
      1.  
        About the credential configuration file
      2.  
        How to add the MongoDB credentials in NetBackup
      3.  
        About the MongoDB roles for protecting the data
    6.  
      Host user requirements
    7. Managing backup hosts
      1.  
        Including a NetBackup client on NetBackup primary server allowed list
  4. Backing up MongoDB using NetBackup
    1. About backing up MongoDB data
      1.  
        Backing up a MongoDB cluster
    2.  
      Prerequisites for backing up a MongoDB cluster
    3. Configuring NetBackup policies for MongoDB plug-in
      1.  
        Creating a BigData backup policy for MongoDB clusters with web UI
  5. Restoring or recovering MongoDB data using NetBackup
    1.  
      About restoring MongoDB data
    2.  
      Prerequisites for MongoDB restore and recovery
    3.  
      Restore the MongoDB data on the same cluster
    4.  
      Restore the MongoDB data on an alternate cluster
    5.  
      Restoring MongoDB data in a high availability setup to an alternate client
    6.  
      Manual steps after the recovery process
  6. Troubleshooting
    1.  
      About NetBackup for MongoDB debug logging
    2.  
      Known limitations for MongoDB protection using NetBackup
  7. Appendix A. Additional information
    1.  
      Sample MongodB configuration utility workflow to add and update MongodB credentials

About protecting a sharded, replica set, or standalone MongoDB cluster using NetBackup

NetBackup supports the protection of the following MongoDB configurations:

  • Sharded MongoDB cluster

  • Replica set MongoDB cluster

  • Standalone MongoDB cluster without replica sets

Protecting a sharded, replica set, or standalone MongoDB cluster using NetBackup

Use the NetBackup for MongoDB plug-in to protect your sharded (MongoDB cluster with configuration server and shards), replica set, or standalone MongoDB cluster using the following high-level steps:

Table: Protecting a sharded, replica set, or standalone MongoDB cluster using NetBackup

Step overview

Details

Use NetBackup to protect MongoDB.

On a very high level, to protect MongoDB you need:

  • NetBackup primary server

  • NetBackup media server

  • A backup host (NetBackup media server or a NetBackup client)

Refer to the NetBackup compatibility lists for the supported primary and media server configurations. The backup host (NetBackup media server or a NetBackup client) is supported only on an RHEL or a SUSE host.

NetBackup appliance including Flex appliance is also supported as a NetBackup primary, a media server, or as a client that can act as a backup host.

Refer to the following topics to get a protection overview and the best practices:

Verify the pre-requisites for the MongoDB plug-in.

Refer to the following topics before you use the plug-in:

Run the MongoDB configuration tool.

Run MongoDB configuration tool to generate the following files automatically:

  • The file for the MongoDB cluster topology credentials.

  • The MongoDB configuration file that configures the global NetBackup parameters for the MongoDB cluster.

You can access the MongoDB configuration tool using the tpconfig command line on the NetBackup primary server. The path to access the tpconfig command is /usr/openv/volmgr/bin/ for UNIX and <install_path>\Volmgr\bin\ for Windows.

For more information, See About the MongoDB configuration tool.

Configure the MongoDB plug-in and the communication between NetBackup and MongoDB.

Note:

If you use the MongoDB configuration tool, some of these configuration steps are not required.

Create a mongodb.conf file to configure backup options in NetBackup:

Get the RSA key of the MongoDB node for adding MongoDB credentials to NetBackup:

Add the MongoDB credentials to NetBackup to facilitate communication:

Give the appropriate permissions to a NetBackup user in MongoDB:

To use a non-root user or a user without root permissions as a host user:

Identify and configure a backup host.

Back up your MongoDB database with NetBackup.

Overview of the backup process:

Prerequisites or the best practices for backing up MongoDB databases:

Restore and recover the MongoDB database.

Overview of the restore and the recovery process:

Prerequisites or the best practices for backing up MongoDB databases: