Veritas NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup (9.1)
  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 on NetBackup master server allowed list
    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.  
        Including a NetBackup client on NetBackup master server allowed list
  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

Using the NetBackup Policies utility to create a BigData policy for MongoDB clusters

Use the following procedure to create a BigData policy with the NetBackup Policies utility.

To create a BigData policy with the NetBackup Policies utility

  1. In the NetBackup Administration Console, in the left pane, expand NetBackup Management > Policies.
  2. On the Actions menu, click New > Policy.
  3. Type a unique name for the new policy in the Add a New Policy dialog box.

    Click OK.

  4. On the Attributes tab, select BigData as the policy type.
  5. On the Attributes tab, select the storage unit for BigData policy type.
  6. On the Schedules tab, click New to create a new schedule.

    You can create a schedule for a Full Backup or Differential Incremental Backup for your BigData policy. Once you set the schedule, MongoDB data is backed up automatically as per the set schedule without any further user intervention.

  7. On the Clients tab, based on your MongoDB setup, enter the following value:
    • Sharded MongoDB cluster

      The client name as seen in the MongoDB shell and the mongod port number of the primary configuration server in the following format:

      MongoDBNode-portnumber

    • Replica set MongoDB cluster

      The client name as seen in the MongoDB shell and the mongod port number of the primary node of the replica set in the following format:

      MongoDBNode-portnumber

    • Standalone MongoDB setup

      The client name as seen in the MongoDB shell and the mongod port number of the standalone node in the following format:

      MongoDBNode-portnumber

    Warning:

    Do not enter the node that acts an Arbiter node for MongoDB.

  8. On the Backup Selections tab, enter the following parameters and their values as shown:
    • Application_Type=mongodb

      The parameter values are case-sensitive.

    • Backup_Host=FQDN or hostname

      The backup host must have a Linux operating system. The backup host can be a NetBackup client or a media server.

      You can specify multiple backup hosts.

    • Manually add the ALL_DATABASES directive.

  9. Click OK to save the changes.

For more information on using NetBackup for big data applications, refer to the Veritas NetBackup documentation section on the Veritas support page.