Veritas NetBackup for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup (8.2)
  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. Installing and deploying MongoDB plug-in for NetBackup
    1.  
      Deploying the MongoDB plug-in
    2.  
      Operating system and platform compatibility
    3.  
      Downloading the plug-in
    4.  
      Installing the MongoDB plug-in and the required EEBs
    5.  
      Prerequisites and the best practices for deploying the MongoDB plug-in
    6.  
      Post installation procedures
    7.  
      Verifying the installation of 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.  
        Whitelisting the configuration file path on NetBackup master 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.  
      Using a non-root user as a host user
    7. Managing backup hosts
      1.  
        Whitelisting a NetBackup client on NetBackup master server
  4. Backing up MongoDB using NetBackup
    1. 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
      2.  
        Creating BigData policy using the NetBackup Administration Console
      3.  
        Using the Policy Configuration Wizard to create a BigData policy for MongoDB clusters
      4.  
        Using the NetBackup Policies utility to create a BigData policy for MongoDB clusters
      5.  
        Using NetBackup Command Line Interface (CLI) to create a BigData policy for MongoDB clusters
  5. Restoring or recovering MongoDB data using NetBackup
    1.  
      Restoring MongoDB data
    2.  
      Prerequisites for MongoDB restore and recovery
    3. About the restore scenarios for MongoDB database from the BAR interface
      1.  
        High-level steps involved in the Restore and Recovery process
    4.  
      Using the BAR interface to restore the MongoDB data on the same cluster
    5.  
      Using the BAR interface to restore the MongoDB data on an alternate cluster
    6.  
      About restoring MongoDB data in a high availability setup on an alternate client
    7. Recovering a MongoDB database using the command line
      1.  
        Creating or modifying the rename file
      2.  
        Using the command line to recover a MongoDB database
    8.  
      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.  
      Contents of the MongoDB plug-in installer package file
    2.  
      Sample MongodB configuration utility workflow to add and update MongodB credentials

Prerequisites for backing up a MongoDB cluster

  • NetBackup chooses the node in a MongoDB cluster to take a backup in the following order:

    • Active hidden node

    • Active secondary node

    • Active primary node

    If you want NetBackup to select a particular backup node in the MongoDB cluster, set it as a hidden node.

  • Before you run a backup job, ensure that you get a successful ping response from all the MongoDB nodes on the backup host. Check and update the firewall settings so that the backup hosts can communicate with the MongoDB cluster.

  • Ensure that the MongoDB cluster that you want to protect lets you take LVM snapshots.

  • Logical volume requirement for snapshot:

    • Ensure that the MongoDB database directory is mounted on a logical volume to complete the snapshot operations.

    • Use the vgdisplay command to ensure that the free physical extent size is sufficient in the logical volume group to complete the snapshot operations.

  • Renaming the volume group or the physical and logical volumes of the LVM for MongoDB database paths causes the backup to fail. If you rename the volume group or the physical and logical volumes of the LVM, ensure that the MongoDB database is mounted on the new path before taking a backup.

  • The backup shuts down the balancer on the mongos process and blocks all the other operations. Hence, during a backup process, ensure that you do not run any other operation that uses the mongos process. For example, import the database.

  • Always run a full backup when you make change to the database path, or modify the configuration file for the mongod or the mongos processes, or change the MongoDB topology.

  • If there are multiple MongoDB clients in a single Netbackup backup policy increase the Client read timeout parameter for master server, media server, and the client to ensure that the all the backups are successful.

    For more information, refer to the NetBackup™ Administrator's Guide, Volume I and the Timeouts properties section.

  • Incremental backup jobs use consistent backup images as a reference for determining the incremental changes. If the previous backup has failed, or was partially successful (failed for one of the nodes), it is skipped completely and a backup image prior to that is considered. In such cases, the backup operation can take longer and the image that is created might be of a larger size.

  • The oplog file has a capped or rolling cache and you can configure the size of the file. NetBackup uses oplog to capture incremental data. Oplog roll-over can cause the incremental backups to fail. To prevent this, make sure that oplog file size is sufficient to hold the incremental data that is generated between the incremental backups.