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 or Upgrade the On-Prem MMS Monitoring with deb Packages

On this page

Overview

On-Prem MongoDB Management Service is a service to monitor and back up a MongoDB infrastructure. This tutorial describes the basic process to install or upgrade the MMS Application Package.

At a high level, a basic installation will look like the following. The estimated setup time is less than an hour.

  1. Configure an MMS Application Server that meets the hardware requirements.
  2. Install a single MongoDB replica set to be used for the MMS Application database, as described in Preparing Backing MongoDB Instances. You cannot use a replica set that is being used to store other data.
  3. Install an SMTP email server as appropriate for your environment.
  4. Install the MMS Application Package.
  5. Configure the MMS server’s URL, email addresses, and Mongo URI connection strings. See Configuration for more information.
  6. Start up the MMS Application. See Start and Stop MMS Application for more information.
  7. Optionally install the MMS Backup Service.

Prerequisites

Deploy Servers

Prior to installation, you must set up servers for the entire On Prem MMS deployment, including the MMS Application, the optional Backup Daemon, and the backing replica sets. For deployment diagrams, see On Prem MMS Example Deployments.

Deploy servers that meet the hardware requirements described in On Prem MMS 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 MMS Application Database and MMS 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.

For more information, see Preparing Backing MongoDB Instances.

Procedures

Install and Start the On Prem MMS Service

1

Download On Prem MMS Monitoring.

Download the latest On Prem Monitoring releases from the downloads page.

2

Install On Prem MMS Monitoring.

Install the .deb package by issuing the following command, where <version> is the version of the .deb package:

copy 
sudo dpkg --install mongodb-mms_<version>_x86_64.deb

When installed, the base directory for the MMS software is /opt/mongodb/mms/. The .deb package creates a new system user mongodb-mms under which the server will run.

3

Configure On Prem MMS Monitoring.

In the conf-mms.properties file, ensure that the following required settings are correct:

Consider the following example configuration:

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

mms.fromEmailAddr=mms-admin@example.net
mms.replyToEmailAddr=mms-admin@example.net
mms.adminFromEmailAddr=mms-admin@example.net
mms.adminEmailAddr=mms-admin@example.net
mms.bounceEmailAddr=mms-admin@example.net

mongo.mongoUri=mongodb://<mms_mongod_ip>:27017/
mongo.replicaSet=rs0

At this point, you can also configure authentication, email, and optional Kerberos integration, as described in the Configuration.

If you would like to run the MMS application in a highly available configuration, please consider Configure a Highly Available MMS Application Server.

4

Start On Prem MMS Monitoring.

To start MMS, issue the following command:

copy 
sudo service mongodb-mms start

Optional: Install Backup Component

1

Stop any currently running instance.

If you are upgrading an existing installation, please stop the currently running instance:

copy 
sudo service mongodb-mms-backup-daemon stop
2

Download the Backup Daemon Package software.

To download the Backup Daemon Package for use on Ubuntu, run the following, replacing <version> with the software version number:

copy 
sudo dpkg -i mongodb-mms-backup-daemon_<version>_x86_64.deb

The software is installed to /opt/mongodb/mms-backup-daemon.

3

Configure the back-end software package.

Configure the Backup Daemon, by editing the /opt/mongodb/mms-backup-daemon/conf/conf-daemon.properties file. Specify the required configuration options, . See Configuration for information about each value.

The following values of the following settings must correspond to the values set in the monitoring application:

Consider the following example configuration:

copy 
mongo.mongoUri=mongodb://<mms_mongod_ip>:27017/
mongo.replicaSet=rs0

mongo.backupdb.mongoUri=mongodb://<backup_mongod_ip>:27017/
mongo.backupdb.replicaSet=rs1

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 gen.key file

Synchronize the /etc/mongodb-mms/gen.key file from a MMS Application Server. This is only required if the Backup Daemon Package was installed on a different server then the MMS Application Package.

5

Start the back-end software package.

To start the Backup Daemon Package run:

copy 
sudo service mongodb-mms-backup-daemon start

If everything worked the following displays:

copy 
Start Backup Daemon                                        [  OK  ]

If you run into any problems, the log files are at /opt/mongodb/mms-backup-daemon/logs.

Upgrade On-Prem MongoDB Management Service from 1.3 and Later

If you have an existing On Prem MMS deployment, use the following procedure to upgrade to the latest release. There are no supported downgrade paths for On Prem MMS.

1
2

Shut down MMS.

For example:

copy 
sudo service mongodb-mms stop
3

If you are running MMS Backup, shutdown the MMS Backup Daemon.

The daemon may be installed on a different server. It is critical that this is also shut down. To shut down, issue a command similar to the following:

copy 
sudo service mongodb-mms-backup-daemon stop
4

Save a copy of your previous configuration file.

For example:

copy 
sudo cp /opt/mongodb/mms/conf/conf-mms.properties ~/.
5

Upgrade the package.

For example:

copy 
sudo dpkg -i mongodb-mms_<version>_x86_64.deb
6

Edit the new configuration file.

Fill in the new configuration file at /opt/mongodb/mms/conf/conf-mms.properties using your old file as a reference point.

7

Start MMS.

For example:

copy 
sudo service mongodb-mms start
8

Update all Monitoring Agents and Backup Agents.

See Install Monitoring Agent for more information.

9

Update the Backup Daemon Package and any Backup Agent, as appropriate.

If you are running MMS Backup, update the Backup Daemon Package and any Backup Agent.

See Install Backup Agent for more information.

Upgrade On-Prem MongoDB Management Service from 1.2 and Earlier

Due to the company name change, the name of the MMS package changed between versions 1.2 and 1.3. Therefore, to upgrade the On-Prem MongoDB Management Service server from any version before 1.3, use the following procedure:

  1. Recommended. Take a full backup of the MMS database before beginning the upgrade procedure.

  2. Shut down MMS, using the following command:

    copy 
    /etc/init.d/10gen-mms stop

  3. Download the latest package from the downloads page and proceed with the instructions for a fresh install. Do not attempt to use your package manager to do an upgrade.

    When complete, On-Prem MongoDB Management Service is installed in the /opt/mongodb/mms directory.

  4. Follow all procedures for a new install, including configuring the options in /opt/mongodb/mms/conf/conf-mms.properties. If you used encrypted authentication credentials you will need to regenerate these manually. Do not copy the credentials from your old properties file. Old credentials will not work.

  5. Start MMS using the new package name:

    copy 
    sudo /etc/init.d/mongodb-mms start

  6. Update any Monitoring Agent. See Install Monitoring Agent for more information.

Additional Information

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