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.

Upgrade Ops Manager from a tar.gz or zip Archive

This tutorial describes how to upgrade an existing Ops Manager installation using a tar.gz or zip file.

Upgrade Path

The version of your existing Ops Manager installation determines your upgrade path. The following table lists upgrade paths per version:

Existing Version Upgrade Path
2.0 or later Ops Manager supports direct upgrades from version 2.0.x. Use this tutorial to upgrade directly to 3.4.0.
1.8 or earlier
  1. Follow the appropriate upgrade path to upgrade your version to 2.0. For the specific upgrade path for your version, refer to :v2.0:`v2.0 upgrade documentation </tutorial/nav/upgrade-application-daemon>`.
  2. Once upgraded to 2.0.x, use this tutorial to upgrade to 3.4.0.

There are no supported downgrade paths for Ops Manager.

Important

It is crucial that you back up the existing conf-mms.properties and gen.key files because the upgrade process will delete existing data.

Release Advisories for Ops Manager 3.4

Before upgrading Ops Manager from 2.0.x to 3.4, complete the following actions:

  • Upgrade backing databases to at least MongoDB 3.0.8. MongoDB 2.6 is no longer allowed as a backing store.

  • Ensure the data partitions for the Ops Manager Application Database have at least 50% free disk space.

    Once the Ops Manager upgrade to 3.4 completes, Ops Manager begins migrating of all monitoring data to a new schema in the background. This migration requires significant free disk space.

  • Add necessary IP addresses or CIDR blocks for to the whitelists for any API clients connecting to the Automation configuration endpoints.

  • Back up the mms.conf file in your current installation if you have modified it.

    This is not a regular practice as mms.conf contains platform and network administration settings for Java VM and Ops Manager network port settings. You must use the new mms.conf file the upgrade installs. Reapply any modifications from your backed up copy to the new mms.conf after completing the upgrade.

Prerequisites

Hardware and Software Requirements

Your servers must 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.

Administrator Privileges
You must have administrator privileges on the servers on which you perform the upgrade.
Download Link
You must have the download link available on the customer downloads page provided to you by MongoDB. If you do not have this link, you can access the download page for evaluation at http://www.mongodb.com/download.

Procedure

Important

Before you perform the upgrade procedure, ensure that you have a current backup of the Ops Manager backing databases. To perform a full backup, see Shut Down and Back Up Ops Manager.

To upgrade Ops Manager:

Important

If you are running OpsManager 1.8 or earlier, upgrade first to Ops Manager 2.0.x.

1

Stop all existing Ops Manager services.

Shut down the Ops Manager Application.

<install_dir>/bin/mongodb-mms stop
2

On each Ops Manager server, back up your existing configuration files and logs to a directory other than the install directory.

Important

You need the backed-up <install_dir>/conf/conf-mms.properties file for later in this procedure.

Example

The following commands back up the configuration files and logs to your home directory:

cp -a <install_dir>/conf ~/mms_conf.backup
cp -a <install_dir>/logs ~/mms_logs.backup
3

Download the latest version of the Ops Manager archive.

  1. In a browser, go to http://www.mongodb.com and click on the Download button.
  2. Complete the form.
  3. On the MongoDB Download Center page, click on the Ops Manager tab.
  4. Select RedHat 5+ / CentOS 5+ / SUSE 11+ / Amazon Linux or Ubuntu 12.04+ from the Platforms drop-down menu.
  5. Select TAR.GZ from the Packages drop-down menu.
  6. Click Download.

Note

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

4

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:

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

On each Ops Manager server, restore the backed up logs and configuration files into the Ops Manager installation directory.

All log files should be restored. Most, but not all, configuration file should be restored. Restore:

conf-mms.properties
The settings for this Ops Manager deployment.
gen.key
The encryption key for the backing databases of this Ops Manager deployment.

Example

These commands restore the configuration files and logs from your home directory:

cp -a ~/mms_logs.backup <install_dir>/logs
cp -a ~/mms_conf.backup/conf-mms.properties <install_dir>/conf/conf-mms.properties
cp -a ~/mms_conf.backup/gen.key <install_dir>/conf/gen.key
6

Optional. On each Ops Manager server, merge any needed changes into the mms.conf file from your backup.

The mms.conf file is rarely customized, as it contains port and Java configuration settings. If you customized these settings, copy those changes from your backup copy to the newly installed copy of mms.conf using your preferred text editor.

7

Start Ops Manager on every server.

Issue the following command:

<install_dir>/bin/mongodb-mms start