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

Prerequisites for manually creating the mongodb.conf file

Note:

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

  • If you do not specify any values in the mongodb.conf file for MongoDB cluster ports and paths to deploy the thin clients, create snapshots, or logs, the default values are considered.

  • The minimum value of the max_streams field is 32. If max_streams is not defined, the default value is 32 parallel data streams per backup host.

    For the max_streams field in the mongodb.conf file, the value of the backup host takes priority over the global_default value.

    For example, the value 32 takes priority over the value 34 and the job runs 32 streams during a backup in this scenario:

    "max_streams": {
              "global_default": 34,
              "Backup_Host":32}

    The backup streams are distributed across the backup hosts as defined in the backup policy and not as per the backup hosts that are defined in the max_streams option in the mongodb.conf file.

  • For a sharded MongoDB environment, ensure that the mongodb.conf file has the latest primary config server and secondary config server.

  • Ensure that the folders or directories that are mentioned in the mongodb.conf file are available on the MongoDB cluster. For example, the folders or directories for snapshot_mount_path, oplog_location, logdir, etc.

  • 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.

  • Give the host user access to the port and the port range that is specified in the mongodb.conf file.