Navigation
This version of the documentation is archived and no longer supported. It will be removed on EOL_DATE. 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.
This version of the manual is no longer supported. It will be removed on EOL_DATE.

Install Ops Manager on Microsoft Windows

Overview

This tutorial describes how to install Ops Manager using a Microsoft Windows Installer package (.msi). If you are instead upgrading an existing deployment, please see Upgrade Ops Manager.

Prerequisites

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

Before you install Ops Manager, you must:

  1. Plan your configuration. See Installation Checklist.

     

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

    Warning

    Failure to configure servers according to the Ops Manager System Requirements, including the requirement to read the MongoDB Production Notes, can lead to production failure.

  3. Install the Ops Manager Application Database and optional Backup Database. The databases require dedicated MongoDB instances. Do not use MongoDB installations that store other data. The Backup Database is required only if you will use the Backup feature.

     

    The Ops Manager Application and Backup Daemon must authenticate to the backing databases as a MongoDB user with appropriate access. See mongo.mongoUri for more information.

    Note

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

Single Instance Install Procedure

To install Ops Manager:

1

Download the latest version of the Ops Manager package.

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

    If you start on MongoDB.com instead of following the link above, click Get MongoDB, then select Ops Manager from the Tools menu.

  2. From the Platforms drop-down menu, click Microsoft Windows Server 2008 R2, 2012, 2012 R2 + 2016.

  3. From the Packages drop-down menu, click MSI.

  4. Click Download.

Note

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

2

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

  1. Double click the MSI package.
  2. Follow the instructions in the Setup Wizard.
  3. During setup, the Configuration/Log Folder step prompts you to specify a folder where the configuration and log files will be stored.

The installation restricts access to the folder to users with the Administrator access privileges only.

3

Install the Ops Manager package.

On a server that is to run the Ops Manager, open <configLogPath>\Server\Config\conf-mms.properties with Administrator access privileges.

<configLogPath> is C:\MMSData by default.

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:

4

Start the Ops Manager instances.

  1. To start the service, click the Start button.
  2. Click Administrative Tools.
  3. Click Services.
  4. In the Services list, right-click the MongoDB Ops Manager HTTP Service and select Start.

Important

Back up the gen.key from the <installPath>\MMSData\Secrets directory to a secure location.

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

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. See Ops Manager Users and Teams.

Multiple Instance Install Procedure

To configure a multi-host Ops Manager:

1

Complete Installation Procedures Steps 1 and 2 on each Ops Manager server.

Complete the first two steps under Single Instance Install Procedure on each server that will host Ops Manager.

2

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.

Before starting Ops Manager on any other server, you must copy the gen.key file from the <installPath>\MMSData\Secrets directory on the first Ops Manager server to the same directory on all other Ops Manager servers.

Important

Back up the gen.key to a secure location.

3

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 3 to configure the connection to the Ops Manager Application Database and Step 4 to start the application.

When you run behind a load balancer, do not allow clients to connect directly to any Ops Manager Application server. The load balancer must not return cached content.

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

Backup Configuration Procedure

If you will run Ops Manager Backup, configure your Ops Manager installation to backup your MongoDB deployments:

1

Configure Ops Manager to manage backups.

To enable Ops Manager to configure and manage MongoDB backups:

  1. To start the service, click the Start button.
  2. Click Control Panel.
  3. Click Administrative Tools.
  4. Click Services.
  5. Right-click on the MongoDB Backup Daemon Service and select Start.
2

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 any user with SYSTEM access privileges.
  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.

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

Set up security for your Ops Manager servers, Ops Manager agents and MongoDB deployments.

Note

To set up a deployment for a test environment, see Test Ops Manager Monitoring. The tutorial creates a replica set on Linux servers, populates the replica set with test data, registers a user, and installs the Monitoring and Backup Agents on a client machine to monitor the test replica set.