Navigation
You were redirected from a different version of the documentation. Click here to go back.

MongoDB Agent Prerequisites

    This section describes the requirements for the hosts that run the MongoDB Agent.

    Operating Systems Compatible with the MongoDB Agent

    The following platforms support MongoDB Agent working with MongoDB 4.0 and later.

    Intel/AMD (x86_64) Hardware Architectures

    MongoDB Server 5.0.x on x86_64

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the x86_64 architectures:

    Operating System MongoDB 5.0.x Community MongoDB 5.0.x Enterprise
    Amazon Linux 2 LTS 2 LTS
    Debian 9, 10 9, 10
    Red Hat Enterprise Linux / CentOS 7.x, 8.x 7.x, 8.x
    SUSE Linux Enterprise Server 12, 15 12, 15
    Ubuntu 18.x, 20.x 18.x, 20.x
    Windows Server 2016, 2019, 2020 2016, 2019, 2020
    Windows 10 10

    MongoDB Server 4.4.x on x86_64

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the x86_64 architectures:

    Operating System MongoDB 4.4.x Community MongoDB 4.4.x Enterprise
    Amazon Linux 1, 2 LTS 1, 2 LTS
    Debian 9, 10 9, 10
    Red Hat Enterprise Linux / CentOS 7.x, 8.x 7.x, 8.x
    SUSE Linux Enterprise Server 12, 15 12, 15
    Ubuntu 18.x, 20.x 18.x, 20.x
    macOS 10.13, 10.14, 10.15 10.13, 10.14, 10.15
    Windows Server 2016, 2019 2016, 2019
    Windows 10 10

    MongoDB Server 4.2.x on x86_64

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the x86_64 architectures:

    Operating System MongoDB 4.2.x Community MongoDB 4.2.x Enterprise
    Amazon Linux 1, 2 LTS 1, 2 LTS
    Debian 9, 10 9, 10
    Red Hat Enterprise Linux / CentOS 6.x, 7.x, 8.x 6.x. 7.x, 8.x
    SUSE Linux Enterprise Server 12, 15 12, 15
    Ubuntu 16.x, 18.x 16.x, 18.x
    MacOS 10.12, 10.13, 10.14, 10.15 10.12, 10.13, 10.14, 10.15
    Windows Server 2012, 2016, 2019, 2008R2, 2012R2 2012, 2016, 2019, 2008R2, 2012R2
    Windows 7, 8, 8.1, 10 7, 8, 8.1, 10

    MongoDB Server 4.0.x on x86_64

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the x86_64 architectures:

    Operating System MongoDB 4.0.x Community MongoDB 4.0.x Enterprise
    Amazon Linux 1, 2 LTS 1, 2 LTS
    Debian 8, 9 8, 9
    Red Hat Enterprise Linux / CentOS 6.x, 7.x 6.x, 7.x
    SUSE Linux Enterprise Server 12 12
    Ubuntu 14.x, 16.x, 18.x 14.x, 16.x, 18.x
    Windows Server 2008R2, 2012, 2012R2, 2016 2008R2, 2012, 2012R2, 2016

    PowerPC (ppc64le) Hardware Architectures

    MongoDB Server 5.0.x on PowerPC

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the ppc64le architectures:

    Operating System MongoDB 5.0.x Community MongoDB 5.0.x Enterprise
    Red Hat Enterprise Linux / CentOS   7.x, 8.x

    MongoDB Server 4.4.x on PowerPC

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the ppc64le architectures:

    Operating System MongoDB 4.4.x Community MongoDB 4.4.x Enterprise
    Red Hat Enterprise Linux / CentOS 7.x 7.x, 8.x
    Ubuntu 18.04 18.04

    MongoDB Server 4.2.x on PowerPC

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the ppc64le architectures:

    Operating System MongoDB 4.2.x Community MongoDB 4.2.x Enterprise
    Red Hat Enterprise Linux / CentOS   7.x, 8.x
    Ubuntu   16.x, 18.x

    On Ubuntu 18.x, MongoDB Server 4.2.17 is the last release that MongoDB Agent supports.

    IBM zSeries (s390x) Hardware Architectures

    MongoDB Server 5.0.x on zSeries

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the s390x architectures:

    Operating System MongoDB 5.0 Community MongoDB 5.0 Enterprise
    Red Hat Enterprise Linux / CentOS 7.x 7.x, 8.x

    MongoDB Server 4.4.x on zSeries

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the s390x architectures:

    Operating System MongoDB 4.4.x Community MongoDB 4.4.x Enterprise
    Red Hat Enterprise Linux / CentOS 7.x 7.x
    SUSE Linux Enterprise Server (SLES) 12 12
    • On RHEL/CentOS 7.x, MongoDB Server 4.4.10 is the last release that MongoDB Agent supports.
    • On SLES 12, MongoDB Server 4.4.6 is the last release that MongoDB Agent supports.

    MongoDB Server 4.2.x on zSeries

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the s390x architectures:

    Operating System MongoDB 4.2.x Community MongoDB 4.2.x Enterprise
    Red Hat Enterprise Linux / CentOS 7.x 7.x
    Ubuntu 18.x 18.x
    SUSE Linux Enterprise Server (SLES) 12 12
    • On RHEL/CentOS 7.x, the last releases that MongoDB Agent supports are MongoDB Server 4.2.17 Community and MongoDB Server 4.2.9 Enterprise.
    • On Ubuntu 18.x and SLES 12, the last releases that MongoDB Agent supports are MongoDB Server 4.2.9 Community and MongoDB Server 4.2.14 Enterprise.

    ARM64 Hardware Architectures

    MongoDB Server 5.0.x on ARM64

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the ARM64 architectures:

    Operating System MongoDB 5.0.x Community MongoDB 5.0.x Enterprise
    Red Hat Enterprise Linux 8.x 8.x
    Amazon Linux 2 LTS 2 LTS

    MongoDB Server 4.4.x on ARM64

    Hosts that run MongoDB Agents must run on a 64-bit version of one of the following operating systems on the ARM64 architectures:

    Operating System MongoDB 4.4.x Community MongoDB 4.4.x Enterprise
    Red Hat Enterprise Linux 8.x 8.x
    Amazon Linux 2 LTS 2 LTS

    Hardware Requirements

    Use 64-bit Chip Architectures

    The MongoDB Agent must run on 64-bit architectures.

    Provide Sufficient CPU and RAM for the Backup Host

    If you activate backup, all MongoDB Agent hosts require at least 2 CPU cores and 3 GB of RAM beyond basic platform requirements. Each backup job that the MongoDB Agent runs further impacts host performance.

    Set Host Network Access

    The hosts that serve the MongoDB deployments must:

    • Have full network access to each other through their Fully Qualified Domain Names (FQDNs). Each host must reach each other host through the FQDN.
    • Permit Automation to start mongod on a random ephemeral port and connect to that port when restoring your deployment from a backup.
    • Find the FQDN for each host. Run the following command in Powershell:

      net config workstation | findstr /C:"Full Computer name"
      
    • Download and install the Windows BIND tools.

    • Find the FQDN for each host. Run the following command in the shell:

      hostname -f
      
    • Find the FQDN for each host. Run the following command in the shell:

      hostname -f
      
    • Find the FQDN for each host. Run the following command in the shell:

      hostname -f
      
    • Resolve each FQDN to a unique IP address. Run the following command in the shell to resolve the FQDN:

      dig +short myip.opendns.com @resolver1.opendns.com
      
    • Set the Common Name or Subject Alternative Name value of any SSL certificates to the MongoDB host’s FQDN.

    The network configuration must allow each MongoDB Agent to make a direct connection to each MongoDB deployment listed on the Deployment page. Cloud Manager does not support port forwarding.

    Disable Windows Firewall Stealth Mode

    For best performance, Disable Windows Firewall stealth mode on the MongoDB hosts on which you installed the MongoDB Agent.

    Set Host Permissions

    On a Host that Already Runs MongoDB

    If you install the MongoDB Agent on a host that is running a MongoDB process, the agent must have:

    • Permission to stop any MongoDB processes. The MongoDB Agent restarts the process using the Agent’s own set of MongoDB binaries. If you installed MongoDB with a package manager, use the same package manager to install the MongoDB Agent. This gives the MongoDB Agent the same owner as MongoDB.
    • Read and Write permissions on the MongoDB data directory and log directory.

    On a Host Before Installing MongoDB

    If you deploy the MongoDB Agent to a host that doesn’t have MongoDB installed, ensure the user that owns the MongoDB Agent has Read and Write permissions on the MongoDB data and log directories you plan to use.

    Root Access

    To install the MongoDB Agent using a deb package, log in as root or a user with sudo privileges.

    To install the MongoDB Agent using a .rpm package, log in as root or a user with sudo privileges.

    To install the MongoDB Agent using a .tar package, log in as root or a user with sudo privileges.

    Acquire an Agent API Key

    The MongoDB Agent requires one Agent API Key per project to communicate with the Cloud Manager.

    If you do not have an existing Agent API Key for your Cloud Manager project, create one:

    1. Click Deployment.

    2. Navigate to Agents.

    3. Click Agent API Keys.

    4. Click plus icon Generate.

      Note

      This button appears if:

      1. The current user is the Project Owner and
      2. The project has no Agent API Keys other than the Original Group API Key with an exclamation exclamation circle icon next to it. This type of key exists in projects created before the new Agent API Key model. In the new model, you can create multiple Agent API Keys in a project, and any the project’s MongoDB Agents can use any of the keys.
    5. In the Generate Key modal, provide a description of the new Agent API Key in the Description box.

    6. Click Generate.

      Important

      When you generate an Agent API Key, Cloud Manager displays it one time only. You must copy this key. Treat it like a password; store it in a secure place. Cloud Manager never displays the full key again.