Install On Prem MMS >
Install the On Prem MMS Application >
Install or Upgrade the On Prem MMS Service: tar.gz and zip

Install or Upgrade the On Prem MMS Service: tar.gz and zip¶

On this page

Overview
Prerequisites
Procedures
Additional Information

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.

Configure an MMS Application Server that meets the hardware requirements.
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.
Install an SMTP email server as appropriate for your environment.
Install the MMS Application Package.
Configure the MMS server’s URL, email addresses, and Mongo URI connection strings. See Configuration for more information.
Start up the MMS Application. See Start and Stop MMS Application for more information.
Optionally install the 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.¶

You can install On Prem MMS Monitoring from the provided tar.gz or zip archive without making any changes to the underlying system (i.e. without creating users). To install, extract the package, as in the following command:

copy

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

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

3

Create a symlink (optional).¶

Optionally create a symlink in /etc/init.d to the included control script for convenience, as in the following:

copy

sudo ln -s <install_dir>/bin/mongodb-mms /etc/init.d/

Note, when the app is first started, it will create and store an encryption key in $HOME/.mongodb-mms for the app user.

4

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.

5

Start On Prem MMS Monitoring.¶

To start MMS, issue the following command:

copy

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

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.

To upgrade a tarball installation, backup the configuration file and logs, and then re-install the On Prem MMS server.

Important

It is crucial that you back up the existing configuration because the upgrade process will delete existing data.

In more detail:

1

Shutdown the MMS server and take a backup of your existing configuration and logs.¶

For example:

copy

sudo /etc/init.d/mongodb-mms stop
sudo cp -a <install_dir>/conf ~/mms_conf.backup
sudo cp -a <install_dir>/logs ~/mms_logs.backup

2

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 /etc/init.d/mongodb-mms-backup-daemon stop

3

Remove your existing MMS server installation entirely and extract latest release in its place.¶

For example:

copy

cd <install_dir>/../
sudo rm -rf <install_dir>
sudo tar -zxf -C . /path/to/mongodb-mms-<version>.x86_64.tar.gz

4

Compare and reconcile any changes in configuration between versions.¶

For example:

copy

diff -u ~/mms_conf.backup/conf-mms.properties <install_dir>/conf/conf-mms.properties
diff -u ~/mms_conf.backup/mms.conf <install_dir>/conf/mms.conf

5

Edit your configuration to resolve any conflicts between the old and new versions.¶

Make any changes as appropriate. Changes to mms.centralUri, email addresses, and MongoDB are the most common configuration changes.

6

Restart the On Prem MMS server.¶

For example:

copy

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

7

Update all Monitoring Agents and Backup Agents.¶

See Install Monitoring Agent for more information.

8

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:

Recommended. Take a full backup of the MMS database before beginning the upgrade procedure.
Shut down MMS, using the following command:
copy
```
/etc/init.d/10gen-mms stop
```
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. See Install On Prem MMS for more information.

When complete, On-Prem MongoDB Management Service is installed in the /opt/mongodb/mms directory.
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.
Start MMS using the new package name:
copy
```
sudo /etc/init.d/mongodb-mms start
```
Update any Monitoring Agent. See Install Monitoring Agent for more information.

Additional Information¶

See Configuration for documentation of all configuration options for the MMS application.
For complete instructions on managing the MMS application process, see Start and Stop MMS Application.
To configure the MMS application for high availability, see Configure a Highly Available MMS Application Server.

← Install or Upgrade the On Prem MMS Monitoring with rpm Packages Global Application Configuration →