IBM Support

MongoDB database backup and restore requirements: IBM Spectrum Protect Plus V10.1.5

Preventive Service Planning


Abstract

This document details the MongoDB database backup and restore requirements for IBM Spectrum Protect Plus Version 10.1.5.

Content

This document is divided into linked sections for ease of navigation. Use the following links to jump to the section of the document that you require:


General

Before you register a MongoDB application server with IBM Spectrum Protect Plus, ensure that the system environment meets the following requirements.



 


Configuration

Database versions

  • MongoDB Version 3.6 and later maintenance and modification levels: Community Server and Enterprise Server Editions
  • MongoDB Version 4.0 and later maintenance levels and modification levels: Community Server and Enterprise Server Editions
     

Operating systems

  • On Linux® x86_64:
    • Red Hat Enterprise Linux (RHEL) 6.8 and later maintenance and modification levels
    • CentOS 6.8 and later maintenance and modification levels
    • RHEL 7 and later maintenance and modification levels
    • CentOS 7 and later maintenance and modification levels
    • SUSE Linux Enterprise Server 12.0 SP1 and later maintenance and modification levels
  • On Linux on Power Systems (little endian):
    • RHEL 7.1 and later maintenance and modification levels
    • CentOS 7 and later maintenance and modification levels

Restriction: On Linux on Power Systems (little endian), only the MongoDB Enterprise Server Edition is supported.
 

Additional notes

Install the latest MongoDB patches and updates in your environment.

Ensure that your MongoDB environment is configured to meet the following criteria:

  • The MongoDB is configured as a stand-alone instance or replica set. Backups of MongoDB sharded cluster instances are not supported. A backup always includes all databases in the instance.
  • The MongoDB instance is configured to use the WiredTiger Storage Engine.
  • The user in the MongoDB application server registration in IBM Spectrum Protect Plus must be able to retrieve server information and status from the MongoDB admin database.
  • Logical volumes of MongoDB data and log paths are managed by Linux Logical Volume Manager (LVM2). LVM2 is used to create temporary volume snapshots. The database files and the journal must be on a single volume. The logical volume grows in size with data as the data changes on the source volume while the snapshot exists. For more information, see LVM2
  • In MongoDB, you must use file path names with ASCII characters.



 


Software

  • When the MongoDB application server runs RHEL 6 or CentOS 6, ensure that the openssl package is at version 1.0.1e-57 or later. To update the version, run the following command:
    yum update openssl
  • Ensure that the supported version of Linux x86_64 or Linux on Power Systems (little endian) is installed.



 


Connectivity

Ensure that the following connectivity criteria are in place:

  • The Secure Shell (SSH) service is running on port 22 on the server.
  • Firewalls must be configured to allow IBM Spectrum Protect Plus to connect to the server by using SSH.
  • The secure file transfer protocol (SFTP) subsystem for SSH is enabled.
  • The application server can be registered in IBM Spectrum Protect Plus by using a Domain Name System (DNS) name or Internet Protocol (IP) address. DNS names must be resolvable by IBM Spectrum Protect Plus.



 


Authentication and privileges

  • The MongoDB server must be registered with IBM Spectrum Protect Plus by using an operating system user that exists on the MongoDB server (referred to IBM Spectrum Protect Plus agent user for the rest of this topic).
  • Ensure that the password is correctly configured and that the user can log in without facing any other prompts, such as prompts to reset the password.
  • On MongoDB, SSL-based encryption and certificate-based authentication are not supported.
  • With the MongoDB Enterprise Server Edition,  only Encrypted Storage Engine is supported.
     

To use a MongoDB database, an IBM Spectrum Protect Plus agent user must have the following permissions:

  • Privileges to run commands as root and as a MongoDB software owner user by using sudo. IBM Spectrum Protect Plus requires these privileges for various tasks such as discovering storage layouts, mounting and unmounting disks, and managing databases.
    • The sudoers configuration must allow the IBM Spectrum Protect Plus agent user to run commands without a password.
    • The !requiretty setting must be specified.
  • Privileges to read the standard MongoDB server module /usr/local/bin/mongod. IBM Spectrum Protect Plus requires these privileges to use the PyMongo API to connect to the MongoDB servers by using the instance's assigned DNS name or IP address name and port. This mechanism is used to gather information about MongoDB instances and databases.
  • If the MongoDB server is protected by role-based authentication, you must set up the appropriate privileges, see Roles for MongoDB
     



 


Ports

The following ports are used by IBM Spectrum Protect Plus agents users. The ports use secure connections (HTTPS or SSL).

Table 1. Communication ports when the target is an IBM Spectrum Protect Plus agent
Port Protocol Initiator Target Description
22 Transmission Control Protocol (TCP) IBM Spectrum Protect Plus virtual appliance1 MongoDB Provides access to troubleshoot and maintain remote proxy host servers running guest applications components by using the Secure Shell (SSH) protocol

1The IBM Spectrum Protect Plus virtual appliance contains the base components: IBM Spectrum Protect Plus server, site, vSnap server, vSnap pool, and VADP proxy.
 

Table 2. Communication ports when the initiator is the IBM Spectrum Protect Plus agent
Port Protocol Initiator Target Description
111 TCP MongoDB vSnap server Allows Open Network Computing (ONC) clients to discover ports for communications with ONC servers
2049 TCP MongoDB vSnap server Used for Network File System (NFS) data transfer to and from vSnap servers
20048 TCP MongoDB vSnap server Mounts vSnap file systems on clients such as the VMware vStorage API for Data Protection (VADP) proxy, application servers, and virtualization data stores



 


Hardware

Table 3. Minimum hardware requirements
System Disk Space
Compatible hardware that is supported by the operating system and MongoDB A minimum of 500 MB of disk space for the product to be installed



 



 

[{"Business Unit":{"code":"BU058","label":"IBM Infrastructure w\/TPS"},"Product":{"code":"SSNQFQ","label":"IBM Spectrum Protect Plus"},"Component":"Not Applicable","Platform":[{"code":"PF016","label":"Linux"},{"code":"PF033","label":"Windows"}],"Version":"10.1.5","Edition":"","Line of Business":{"code":"LOB26","label":"Storage"}}]

Document Information

Modified date:
19 November 2019

UID

ibm11071988