Veritas NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup (9.0.0.1, 9.0)
  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.  
        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.  
      Sample MongodB configuration utility workflow to add and update MongodB credentials
  8.  
    Index

About the MongoDB configuration tool

NetBackup provides a command line based configuration tool that enables you to accurately capture and update the information that is required to protect the MongoDB.

You can use the MongoDB configuration tool to generate the following files automatically:

  • The credentials file that configures the MongoDB cluster topology and credentials for NetBackup.

    For more information about the credential configuration file and the manual method to create it, refer to the following topic:

    See Adding MongoDB credentials in NetBackup.

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

    For more information about the MongoDB configuration file and the manual method to create it, refer to the following topic:

    See Configuring backup options for MongoDB using the mongodb.conf file .

Note:

You can create the two files manually, but you must ensure that the formatting and the parameters are correct.

You can access the MongoDB configuration tool using the tpconfig command line on the NetBackup master server. The path to access the tpconfig command is /usr/openv/volmgr/bin/.

  • On a Windows master server run the tpconfig -mongo_configurationcommand to activate Mongo configuration interface.

  • On a Linux and Solaris master server, run ./tpconfig and tpconfig and select the fourth option for MongoDB configuration.

See Sample MongodB configuration utility workflow to add and update MongodB credentials.

For more information about the tpconfig command, refer to the NetBackup Commands Reference Guide.

Whitelist the mongodb.conf file path in bp.conf using the BPCD_WHITELIST_PATH option. For more information, See Whitelisting the configuration file path on NetBackup master server.

Adding MongoDB credentials during recovery to an alternate MongoDB cluster

To recover to an alternate MongoDB cluster, use the configuration tool to add credentials of the alternate cluster in the existing cluster credentials.

Sharded MongoDB cluster

  1. Use the configuration tool to update credentials of the existing cluster.

  2. Add new configuration server using the Add new secondary config server option and save.

  3. Add shards of the new cluster using the Add new shard host server option and save.

  4. Initiate the alternate recovery job.

Replica Set MongoDB

  1. Use the configuration tool to update credentials of the existing replica set.

  2. Add new primary server using the Add secondary server option and save.

  3. Add all of the secondary servers using the Add secondary server option and save.

  4. Initiate the alternate recovery job.

Note:

If you are using the credentials file, you can manually update the file and upload the file using the tpconfig command.