NetBackup™ for MongoDB Administrator's Guide

Last Published:
Product(s): NetBackup & Alta Data Protection (10.3.0.1, 10.3)
  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 primary 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 primary 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 for MongoDB clusters with web UI
  5. Restoring or recovering MongoDB data using NetBackup
    1.  
      Restoring MongoDB data
    2.  
      Prerequisites for MongoDB restore and recovery
    3.  
      Using NetBackup web UI to restore the MongoDB data on the same cluster
    4.  
      Using NetBackup web UI to restore the MongoDB data on an alternate cluster
    5.  
      About restoring MongoDB data in a high availability setup on an alternate client
    6.  
      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

Adding MongoDB credentials in NetBackup

Note:

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

To establish a seamless communication between MongoDB clusters and NetBackup for successful backup and restore operations, you must add and update MongoDB credentials to the NetBackup primary server.

About the authentication types for MongoDB that NetBackup supports

NetBackup supports the following authentication types for protecting the MongoDB data:

  • No authentication

  • Simple - Salted Challenge Response Authentication Mechanism (SCRAM)

  • Certificate-based - x.509

Different options are required for each of the authentication types when you add the credentials using the tpconfig command.

The following table describes the options that are required for each authentication type:

Table: Required options for authentication types

Options

Option description

No authentication

Simple authentication

Certificate-based authentication

AppUserId

Specifies the username that is required to log into the application server.

✖

✔

✖

AppUserPassword

Specifies the user password that is required to log into the application server.

✖

✔

✖

HostUser

Specify the host's user ID for SSH implementation.

If the host user that you want to use is a non-root user or does not have root permissions for the MongoDB server then:

See Using a non-root user as a host user.

✔

✔

✔

HostPassword

Specify the host's user password for SSH implementation.

✔

✔

✔

HostRSAKey

RSA key is required to perform password-less remote operations.

✔

✔

✔

ServerPemPath

Path to the PEM certificate file on the MongoDB node.

✖

✖

✔

CAPemPath

Path to the CA PEM certificate file on the MongoDB node.

✖

✖

✔

Passkey

Password of CA certificate.

✖

✖

✔

CADir

Path to the CA certificate.

✖

✖

✔

CARole

User role that is defined in the CA.

✖

✖

✔

CertificateUser

Specifies the details for the certificate user.

✖

✖

✔

application_server_conf

Specifies a path to the credential configuration file that contains the authentication type, user details, and the directory paths for the CA security certificates.

See About the credential configuration file.

✔

✔

✔