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

Installing the MongoDB plug-in and the required EEBs

Log on to the Veritas Support site to download the MongoDB plug-in and store it in a local directory.

See Downloading the plug-in.

For the detailed contents of the NetBackup_MongoDB_Plugin_8.2.zip file, See Contents of the MongoDB plug-in installer package file..

For NetBackup application

  • The plug-in installer for NetBackup is in the /Plugins/NetBackup directory.

  • Install MongoDB plug-in for the appropriate platform on the backup host.

    Platform

    Plug-in

    linuxR_x86

    NBPSF_MongoDB_Plugin_8.2_linuxR_x86

    linuxS_x86

    NBPSF_MongoDB_Plugin_8.2_linuxS_x86

  • Install the following EEBs found in the /EEB directory:

    • The EEB for bpbrm for the appropriate platform on all the media servers that are used for MongoDB.

    • The EEB for nbjP.jar for the appropriate platform that runs the NetBackup Administration console.

      Note:

      After installing the EEB on Windows, update NBUCLASSPATH as mentioned in "Additional Notes" of the EEB installer.

    • For Solaris SPARC master servers, install EEB for libnbmangle.

    • The EEB for tpconfig for the appropriate platform on the master server.

      For the detailed contents of the NetBackup_MongoDB_Plugin_8.2.zip file, See Contents of the MongoDB plug-in installer package file..

  • The EEB for nbjP.jar on the remote Windows NetBackup Administration console (stand-alone).

    You must install MongoDB plug-in on all the media servers, clients, or master server that you want to use as backup hosts.

For NetBackup Appliance (NBA)

  • The plug-in installer for NetBackup Appliance is in the /Plugins/NBAPP directory.

  • Install MongoDB plug-in for the appropriate platform on the appliance.

    Platform

    Plug-in

    NetBackup Appliance

    NBAPP_addon_PSF_MongoDB_Plugin-8.2.0.0.x86_64.rpm

  • Install the following EEBs found in the /EEB directory:(Remote installation using AMS is supported.)

    • The EEB NBAPP_EEB_ET3983324-3.2.0.0-1.x86_64.rpm for bpbrm.

    • The EEB NBAPP_EEB_ET3988174-3.2.0.0-2.x86_64.rpm for nbjP.jar.

    • The EEB NBAPP_EEB_ET3992241-3.2.0.0-2.x86_64.rpm for tpconfig.

      For the detailed contents of the NetBackup_MongoDB_Plugin_8.2.zip file, See Contents of the MongoDB plug-in installer package file..

  • To use a remote NetBackup Administration console with the appliance, follow instructions to install EEB for nbjP.jar on NetBackup 8.2.

For Flex Appliance

  • The plug-in installer for Flex Appliance is in the /Plugins/VRTSflex directory.

  • Install MongoDB plug-in on the Flex Appliance container that is used as a backup host.

    Platform

    Plug-in

    NetBackup Flex Appliance

    VRTSflex-nbpsf-mongodb-8.2-0.x86_64.rpm

  • Install the following EEBs found in the /EEB directory:(Remote installation using AMS is supported.)

  • To use a remote NetBackup Administration console with the appliance, follow instructions to install EEB for nbjP.jar on NetBackup 8.2.

To install MongoDB plug-in on a backup host

  1. Log in to the backup host with root privileges.
  2. Extract the plug-in. Run the following command:

    tar -xvf package_name

    Following files are extracted:

    • plug-in_pkg.linuxR_x86.tar

    • plug-in_pkg.linuxS_x86.tar

    • install

    • LICENSE

  3. Run the installer. Run the following command:

    ./install

  4. Accept the End User License Agreement (EULA).

    Enter y for the prompt.