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

MongoDB Agent Prerequisites

On this page

    Host Machine Hardware

    Use 64-bit Chip Architectures

    The MongoDB Agent must run on 64-bit architectures.

    Provide Backup Host with Sufficient Resources

    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 networking access to each other through their fully qualified domain names (FQDNs). Each host must be able to reach every other host through the FQDN.
    • Permit Automation to start mongod on a random ephemeral port and connect to that port when restoring a backup.

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

      copy 
      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:

      copy 
      hostname -f

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

      copy 
      hostname -f

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

      copy 
      hostname -f

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

      copy 
      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 every 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 to 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 had installed MongoDB with a package manager, use the same package manager to install the MongoDB Agent. This gives the 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, you need to be logged in as root or a user with sudo privileges to install packages.

    To install the MongoDB Agent using a .rpm package, you need to be logged in as root or a user with sudo privileges to install packages.

    To install the MongoDB Agent using a .tar package, you need to be logged in as root or a user with sudo privileges to install packages.

    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, you need to 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.

    © MongoDB, Inc 2008-present. MongoDB, Mongo, and the leaf logo are registered trademarks of MongoDB, Inc.