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 tar.gz or zip Archives

Overview

To install Ops Manager you install the Ops Manager Application and the optional Backup Daemon. This tutorial describes how to install both using tar.gz or zip packages. The tutorial installs to a Linux OS. The Ops Manager Application monitors MongoDB deployments, and the Backup Daemon creates and stores deployment snapshots.

If you are instead upgrading an existing deployment, please see Upgrade Ops Manager.

Warning

To use Ops Manager 1.6 Automation to manage MongoDB Enterprise deployments, you must first install the MongoDB Enterprise dependencies to each server that runs MongoDB Enterprise. You must install the dependencies to the servers before using Automation.

Note that Automation does not yet support use of the MongoDB Enterprise advanced security features (SSL, LDAP, Kerberos, and auditing). Automation will support these features in the next major Ops Manager release.

To run MongoDB Enterprise with advanced security now, deploy MongoDB Enterprise manually (not through Automation) and use Ops Manager only for Monitoring and Backup.

Prerequisites

Deploy Servers

Prior to installation, you must set up servers for the entire Ops Manager deployment, including the Ops Manager Application, the optional Backup Daemon, and the backing replica sets. For deployment diagrams, see Example Installation Diagrams.

Deploy servers that meet the hardware requirements described in Ops Manager Hardware and Software Requirements. Servers for the Backup Daemon and the backing replica sets must also comply with the Production Notes in the MongoDB manual. Configure as many servers as needed for your deployment.

Warning

Failure to configure servers according to the MongoDB Production Notes can lead to production failure.

Deploy MongoDB

Install MongoDB on the servers that will store the Ops Manager Application Database and Backup Blockstore Database. The Backup Blockstore database is required only if you run the Backup Daemon. The databases require dedicated MongoDB instances. Do not use MongoDB installations that store other data.

Install separate MongoDB instances for the two databases and install the instances as replica sets. Ensure that firewall rules on the servers allow access to the ports that the instances runs on.

The Ops Manager Application and Backup Daemon must authenticate to their databases as a MongoDB user with appropriate access. The user must have the following roles:

Install Procedures

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

Install and Start the Ops Manager Application

1

Download the Ops Manager Application package.

  1. In a browser, go to http://www.mongodb.com/download.

  2. Submit the subscription form.

  3. On the MongoDB Enterprise Downloads page, go to the MongoDB Ops Manager section and click the here link.

  4. On the Ops Manager Download page, acknowledge the recommendation to contact MongoDB for production installs.

  5. On the MongoDB Ops Manager Downloads page, copy the link address of the “Monitoring, Automation and Core” TAR.GZ link.

  6. Open a system prompt.

  7. Download the Ops Manager Application package by issuing a curl command that uses the copied link address:

    curl -OL <link-address-for-monitoring-automation-core-tar.gz>
    

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

2

Extract the Ops Manager Application package.

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

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

When complete, Ops Manager is installed.

3

Configure Monitoring.

Open <install-directory>/conf/conf-mms.properties with root privileges and set values for the settings described in this step. For detailed information on each setting, see the Ops Manager Configuration Files page.

Set mms.centralUrl and mms.backupCentralUrl as follows, where <host> is the fully qualified domain name of the server running the Ops Manager Application.

mms.centralUrl=http://<host>:8080
mms.backupCentralUrl=http://<host>:8081

Set the following Email Address Settings as appropriate. Each may be the same or different.

mms.fromEmailAddr=<email_address>
mms.replyToEmailAddr=<email_address>
mms.adminFromEmailAddr=<email_address>
mms.adminEmailAddr=<email_address>
mms.bounceEmailAddr=<email_address>

Set mongo.mongoUri to the servers and ports hosting the Ops Manager Application database. For example:

mongo.mongoUri=mongodb://mongodb1.example.net:27017,mongodb2.example.net:27017,mongodb3.example.net:27017

If you use HTTPS to encrypt user connections to Ops Manager, set mms.https.PEMKeyFile to a PEM file containing an X509 certificate and private key, and set mms.https.PEMKeyFilePassword to the password for the certificate. For example:

mms.https.PEMKeyFile=<path_and_name_of_pem_file>
mms.https.PEMKeyFilePassword=<password_for_pem_file>

To configure authentication, email, and other optional settings, see Ops Manager Configuration Files. To run the Ops Manager application in a highly available configuration, see Configure a Highly Available Ops Manager Application.

4

Start the Ops Manager Application.

To start Ops Manager, issue the following command:

<install_dir>/bin/mongodb-mms start
5

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

To open the home page, enter the following URL in a browser, where <host> is the fully qualified domain name of the server:

http://<host>:8080

Click the Register link and follow the prompts to register the first user and create the first group. The first user is automatically assigned the Global Owner role. When you finish, you are logged into the Ops Manager Application as the new user. For more information on creating and managing users, see Manage Ops Manager Users.

6

At the Welcome page, follow the prompts to set up Automation (which includes Monitoring) or just Monitoring alone.

Automation lets you deploy and configure MongoDB processes from Ops Manager as well as monitor and manage them. If you select Automation, Ops Manager prompts you to download the Automation Agent and Monitoring Agent.

Monitoring lets you manage a MongoDB deployment from Ops Manager. If you select Monitoring, Ops Manager prompts you to download only the Monitoring Agent.

Install the Backup Daemon (Optional)

If you use Backup, install the Backup Daemon.

1

Download the Backup Daemon package.

  1. In a browser, go to http://www.mongodb.com/download.

  2. Submit the subscription form.

  3. On the MongoDB Enterprise Downloads page, go to the MongoDB Ops Manager section and click the here link.

  4. On the Ops Manager Download page, acknowledge the recommendation to contact MongoDB for production installs.

  5. On the MongoDB Ops Manager Downloads page, copy the link address of the “Backup” TAR.GZ link.

  6. Open a system prompt.

  7. Download the Backup Daemon package by issuing a curl command that uses the copied link address:

    curl -OL <link-address-for-backup-tar.gz>
    

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

2

To install the Backup Daemon, extract the downloaded archive file.

tar -zxf <downloaded-archive-file>
3

Point the Backup Daemon to the Ops Manager Application database.

Open the <install-dir>/conf/conf-daemon.properties file and set the mongo.mongoUri value to the servers and ports hosting the Ops Manager Application database. For example:

mongo.mongoUri=mongodb://mongodb1.example.net:27017,mongodb2.example.net:27017,mongodb3.example.net:27017

Additionally, ensure that the file system that holds the rootDirectory has sufficient space to accommodate the current snapshots of all backed up instances.

4

Synchronize the mms-gen-key file.

Synchronize the <install-dir>/bin/mms-gen-key file from the Ops Manager Application server. This is required only if the Backup Daemon is installed on a different server than the Ops Manager Application.

5

Start the Backup Daemon.

To start the Backup Daemon run:

<install_dir>/bin/mongodb-mms-backup-daemon start

If you run into any problems, the log files are at <install_dir>/logs.

6

Open Ops Manager and access the Backup configuration page.

Open the Ops Manager home page and log in as the user you first registered when installing the Ops Manager Application. (This user is the global owner.) Then click the Admin link at the top right of the page. Then click the Backup tab.

7

Enter configuration information for the Backup database.

Enter the configuration information described below, and then click Save. Ops Manager uses this information to create the connection string URI used to connect to the database.

<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.

MongoDD Auth Username and MongoDB Auth Password: Enter the user credentials if the database uses authentication.

Encrypted Credentials: Check this if the user credentials use the Ops Manager credentialstool. For more information, see Encrypt MongoDB User Credentials.

Use SSL: Check this if the MongoDB database uses SSL. If you select this, you must configure SSL settings for both the Ops Manager Application and Backup Daemon. See Ops Manager Configuration Files.

Connection Options: To add additional connection options, enter them using the MongoDB Connection String URI Format.