Navigation
This version of the documentation is archived and no longer supported. To learn how to upgrade your version of MongoDB Ops Manager, refer to the upgrade documentation.
You were redirected from a different version of the documentation. Click here to go back.

Install Ops Manager from a tar.gz or zip Archive

On this page

This tutorial describes how to install Ops Manager to Linux servers from a tar.gz or zip archive. If you are instead upgrading an existing deployment, please see Upgrade Ops Manager.

Prerequisites

You must have administrative access on the hosts to which you install.

Before you install Ops Manager, you must:

  1. Plan your configuration. See Installation Checklist.

  2. Deploy hosts that meet the Ops Manager System Requirements.

    Potential for Production Failure

    Your Ops Manager instance can fail in production if you fail to configure the following:

  3. Install the Ops Manager Application Database and optional Backup Database. The databases require dedicated MongoDB instances. Don’t use MongoDB installations that store other data. Ops Manager requires the Backup Database if you use the Backup feature.

    The Ops Manager Application must authenticate to the backing databases as a MongoDB user with appropriate access.

    See also

    To learn more about connecting to your backing database with authentication, see mongo.mongoUri.

    Note

    Ops Manager cannot deploy its own backing databases. You must deploy those databases manually.

  4. Install and verify an Email Server. Ops Manager needs an email server to send alerts and recover user accounts. You may use an SMTP Server or an AWS SES server. To configure your Email Server, see Email Delivery Method Configuration.

Install Ops Manager

To install Ops Manager:

1

Download the latest version of the Ops Manager archive.

  1. Open your preferred browser to visit the MongoDB Download Center on MongoDB.com.

    If start from MongoDB.com, click Products arrow right icon Ops Manager arrow right icon Try it now.

  2. From the Version dropdown menu, click one of the provided stable versions.

  3. From the Platform dropdown menu, click one of the following options:

    • Red Hat + CentOS 7, 8 / SUSE 12 + 15 / Amazon Linux 2
    • Debian 9, 10, 11 / Ubuntu 18.04

  4. From the Package dropdown menu, click tar.gz.

  5. Click Download.

    The downloaded package is named mongodb-mms-<version>.x86_64.tar.gz, where <version> is the version number.

2

Optional: Verify Ops Manager package integrity.

To verify the integrity of the Ops Manager download, see Verify Integrity of Ops Manager Packages.

3

Install the Ops Manager package on each server being used for Ops Manager.

Navigate to the directory to which to install Ops Manager. Extract the archive to that directory:

copy 
tar -zxf mongodb-mms-<version>.x86_64.tar.gz

When complete, Ops Manager is installed.

4

Configure the Ops Manager connection to the Ops Manager Application Database.

On a server that is to run Ops Manager, open <install_directory>/conf/conf-mms.properties with root privileges and configure the settings described here, as appropriate.

Configure the following setting to provide the connection string Ops Manager uses to connect to the database:

To configure Ops Manager to use the Ops Manager Application Database over TLS, configure the following TLS settings.

Ops Manager also uses these settings for TLS connections to Backup Databases

To configure Ops Manager to use Kerberos to manage access to the Ops Manager Application Database, configure the following Kerberos settings:

5

Start Ops Manager.

Issue the following command:

copy 
<install_directory>/bin/mongodb-mms start
6

Open the Ops Manager home page and register the first user.

  1. Enter the following URL in a browser, where <host> is the fully qualified domain name of the server:

    copy 
    http://<OpsManagerHost>:8080

  2. Click the Sign Up link and follow the prompts to register the first user and create the first project. The first user is automatically assigned the Global Owner role.

7

Configure Ops Manager.

Ops Manager walks you through several configuration pages. Required settings are marked with an asterisk. Enter information as appropriate. When configuration is complete, Ops Manager opens the Deployment page.

In addition to the common required settings, the following are required for particular deployment configurations. For more information on a setting, see Ops Manager Configuration Settings.

Configuration Required Settings
If you are running multiple Ops Manager instances behind a load balancer Set Load Balancer Remote IP Header to the name of the header the load balancer will use when forwarding the client’s IP address to the application server. If you set this, do not allow clients to connect directly to any of the application servers. The load balancer must not return cached content. You will set up the additional servers as part of the next steps in this procedure.
If you are using Automation or Backup without an internet connection Set the MongoDB Version Management settings. You will need to put the tarballs for every MongoDB release used in your deployment in the configured Versions Directory on every Ops Manager host. To learn more, see Configure Deployment to Have Limited Internet Access.
8

Copy the gen.key file from the current server to the other servers.

Ops Manager requires an identical gen.key file be stored on both servers running Ops Manager and uses the file to encrypt data at rest in the Ops Manager Application Database and Backup Database.

You must copy the gen.key file from the current server, on which you just installed Ops Manager, to every server that will run Ops Manager. You must copy the gen.key to the other servers before starting Ops Manager on them.

Use scp to copy the gen.key file from the ${HOME}/.mongodb-mms/ directory on the current server to the same directory on the other servers.

Important

Back up the gen.key file to a secure location.

9

If you will run multiple Ops Manager Applications behind a load balancer, configure and start the applications.

For each Ops Manager instance, repeat the step to configure the connection to the Ops Manager Application Database and the step to start the application.

For more information on running multiple applications behind a load balancer, see Configure a Highly Available Ops Manager Application.

10

If you will run Ops Manager Backup, configure the Backup Daemon and Backup Storage.

  1. On each Ops Manager server that you activate as a Backup Daemon, create the directory in which to store the head databases. The directory must be:

    • dedicated for this purpose on a local disk partition.
    • sized appropriately according to the Ops Manager System Requirements.
    • writable by the mongodb-mms user.

  2. Configure the Backup Storage you want to use for your snapshots.

  3. Open Ops Manager and verify that you are logged in as the user you registered when installing Ops Manager. This user is the global owner.

  4. Click the Admin link at the top right of the page.

  5. Click the Backup tab.

  6. Follow the prompts to configure the Backup Daemon and Backup Storage. Ops Manager walks you through configuration of the daemon and snapshot storage.

    After you select how to store snapshots, you are prompted to configure the connection string to the Backup Database. If you use filesystem storage for your snapshots, the Backup Database is used only for the oplog store.

    Warning

    Once the connection string is saved, any change to the string requires you to restart all the Ops Manager instances, including those running activated Backup Daemons. Making the change and clicking Save is not sufficient. Ops Manager will continue to use the previous string until you restart the instances.

    <hostname>:<port> Enter a comma-separated list of the fully qualified domain names and port numbers for all replica set members for the Backup Database.

    MongoDB Auth Username and

    MongoDB Auth Password

    Enter the user credentials if the database uses authentication.

    Warning

    If you did not use the credentialstool to encrypt this password, it is stored as plaintext in the database.
    Encrypted Credentials Check this if the user credentials use the Ops Manager credentialstool.
    Use SSL Check this if the database uses SSL. If you select this, you must configure SSL settings Ops Manager. See Ops Manager Configuration Settings.
    Connection Options To add additional connection options, enter them using the MongoDB Connection String URI Format. This field supports un-escaped values only.

Next Steps

After you install the Ops Manager Application to your Ops Manager hosts, you must install MongoDB Agents on the hosts that will run your MongoDB deployments.

You can install the MongoDB Agent on hosts running existing MongoDB deployments or on hosts on which you will create new MongoDB deployments. Hosts that serve your MongoDB deployments must meet the minimum MongoDB production requirements.

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