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.

Configure Local Mode for Ops Manager Servers without Internet Access

Overview

The Automation Agents require archived MongoDB binaries to install MongoDB on new deployments and to upgrade versions on existing MongoDB deployments. The Backup Daemons require the extracted MongoDB binaries.

In a default configuration, the agents and daemons access the binaries over the internet from MongoDB, Inc. The Version Manifest Source setting determines whether Ops Manager runs in Internet Mode or Local Mode.

If the servers running Automation Agents or Backup Daemons do not have internet access, you must:

  • Download the MongoDB binaries for each version and platform you need to support,
  • Configure Ops Manager to run in Local Mode, and
  • Update the version manifest.

As MongoDB, Inc. releases new versions, you must update both the binaries and the version manifest.

Versions Directory

The versions directory stores all of the archived and extracted MongoDB binaries Automation and Backup need to install and upgrade MongoDB deployments.

If you run in Local Mode, you must:

  • Download the necessary MongoDB archived binaries manually from MongoDB, Inc.
  • Store the archived MongoDB binaries for each version, edition and platform you need to support for Automation in this directory on each of your Ops Manager servers.
  • Extract the MongoDB binaries from these archives for the Backup Daemons. The versions directory must also store the extracted MongoDB binaries for each version, edition and platform you need to support for Backup.
  • Grant the mongodb-mms user permission to read the contents of this directory.
  • Specify this path for this directory in the Versions Directory setting on your Ops Manager application

For a given Ops Manager group, the MongoDB binary for the needed version must also be selected in the group’s Version Manager.

Version Manifest

The version manifest provides Ops Manager with a list of all released MongoDB versions available to your Ops Manager servers.

In Local Mode:
  • The version manifest must be downloaded and its contents copied and pasted into each Ops Manager server.
  • You must update the version manifest as MongoDB, Inc. releases new versions.
In Internet Mode:
Ops Manager automatically updates the version manifest from MongoDB, Inc.

Prerequisites

Required Access

To configure Local Mode, you must have Global Owner access to Ops Manager.

The mongodb-mms user needs permission to read the contents of the versions directory

Before configuring Ops Manager to run in Local Mode, you must meet the prerequisites described here.

Determine which Binaries to Store Locally

For every edition and version of MongoDB you want to install or upgrade, Automation needs an archived MongoDB binary (.tgz for OS X, Linux or Solaris or .zip for Windows) for each operating system. Backup requires an extracted MongoDB binary for each platform.

These binaries and archives must be stored in the Versions Directory.

You need binaries for each MongoDB version that you:

  • Have in each existing deployment to be imported into Ops Manager.

  • May use to create new deployments through Ops Manager Automation.

  • May use during an intermediary step in an upgrade.

    Example

    If you import an existing deployment of MongoDB 2.6 Community and want to upgrade it to MongoDB 3.0 Enterprise, you must download and store all archived binaries for:

    • MongoDB 2.6 Community Edition
    • MongoDB 3.0 Community Edition
    • MongoDB 3.0 Enterprise Edition

Important

Each MongoDB edition supports a range of versions of a given operating system. Ensure the selected binaries support the OS version of the current or future server running MongoDB. You may need to upgrade or downgrade the platform to install a given version of MongoDB.

You do not need to download the archived MongoDB binary for every platform, only the one(s) in your current and planned MongoDB deployments.

To locate the required archived binaries for specific versions, editions and platforms:

  1. Navigate to the Download Center.
  2. Click the appropriate MongoDB edition, platform and MongoDB version:
    • Community
      • Click the tab for Windows, Linux, Mac OS X or Solaris.
      • Select the appropriate platform distribution and version from the Version dropdown menu.
      • For the current released version, highlight the link to the current version.
      • For older versions:
        • Click All Version Binaries.
        • Locate the version you wish to download, click the link to the appropriate archived binary.
    • Enterprise
      • Select the platform from the Platforms dropdown menu.
      • For the current release version, click Download.
        • After the Install MongoDB Enterprise modal displays, click the archive link.
      • For older versions, click the Archived Releases link.
        • After the Archived Downloads page displays, navigate to the appropriate platform and version and then click the link to the right of the Archive.

Warning

Remove Unnecessary Versions

  1. Click Deployment, then Version Manager.

  2. Clear the checkbox for every version you do not plan to deploy before enabling Local Mode.

    If you leave unused versions selected and do not download their associated binaries, Ops Manager fails a pre-flight check when it starts.

If you did not clear unused versions or download the associated binaries, you can take Ops Manager out of Local Mode temporarily to pass the Ops Manager pre-flight check. See Start Ops Manager When All Versions Are Not Downloaded for the procedure.

Install Enterprise Dependencies (MongoDB Enterprise Only)

If you will run MongoDB Enterprise and use Linux servers, then you must manually install a set of dependencies to each server before installing MongoDB. The MongoDB manual provides the appropriate command to install the dependencies. See the link for the server’s platform:

Configure Local Mode

Important

If you have not yet read the Determine which Binaries to Store Locally topic on this page, please do so before continuing with this procedure.

1

Set Ops Manager to Local Mode.

  1. Click Admin in the upper right corner to open system administration.
  2. Click the General tab.
  3. Click Ops Manager Config.
  4. Click the Miscellaneous button at the top of the page.
  5. Select Local as the Version Manifest Source setting.
  6. Note the directory specified in Versions Directory. This is the directory on your Ops Manager servers that stores the MongoDB binaries.
2

Populate all Ops Manager servers with the necessary MongoDB binaries and archives.

On all your Ops Manager servers, including those with enabled Backup Daemons:

  1. Download the MongoDB binaries for the appropriate platforms and versions from MongoDB, Inc. Binaries are stored as compressed archives (.tgz).

    Note

    See Determine which Binaries to Store Locally to review which versions are necessary.

  2. Copy all of the archived binaries to the versions directory.

  3. Navigate to the versions directory.

  4. Extract all of the archived binaries.

    Note

    Automation uses the archived binaries, but Backup uses the extracted binaries. Both must be available.

3

Grant the mongodb-mms user read permissions to the versions directory.

The mongodb-mms user needs the read permissions to the versions directory.

Example

On a Linux platform, you should issue the chown command to change ownership for all files in the directory to mongodb-mms:

sudo chown -R mongodb-mms:mongodb-mms <path-to-the-versions-directory>

Set the permissions to:

  • read and write for the owner
  • read for the group
  • none for all

This enables Ops Manager can correctly read and extract the archived binaries.

sudo chmod -R 640 <path-to-the-versions-directory>

The resulting listing of the versions directory should look like this:

-rw-r----- 1 mongodb-mms mongodb-mms 116513825 Apr 27 15:06 mongodb-linux-x86_64-2.6.9.tgz
-rw-r----- 1 mongodb-mms mongodb-mms  51163601 May 22 10:05 mongodb-linux-x86_64-amazon-3.0.3.tgz
-rw-r----- 1 mongodb-mms mongodb-mms  50972165 May 22 10:06 mongodb-linux-x86_64-suse11-3.0.3.tgz
-rw-r----- 1 mongodb-mms mongodb-mms  95800685 Apr 27 15:05 mongodb-linux-x86_64-enterprise-amzn64-2.6.9.tgz
-rw-r----- 1 mongodb-mms mongodb-mms  50594134 Apr 27 15:04 mongodb-linux-x86_64-enterprise-amzn64-3.0.2.tgz
-rw-r----- 1 mongodb-mms mongodb-mms  50438645 Apr 27 15:04 mongodb-linux-x86_64-enterprise-suse11-3.0.2.tgz
4

Download the version manifest for Ops Manager.

  1. From a computer that can access the Internet and the Ops Manager servers, download the version manifest from https://opsmanager.mongodb.com/static/version_manifest/2.0.json.
  2. Open the manifest JSON file.
  3. Select all of the contents and copy them to the clipboard.
5

Paste the contents the version manifest into the Ops Manager application on each Ops Manager server.

  1. In Ops Manager, click Admin in the upper right corner to open system administration.
  2. Click the General tab.
  3. Click Version Manifest.
  4. Click the Update the MongoDB Version Manifest button.
  5. Paste the version manifest.
6

For each group, specify which versions are available for download by Automation Agents.

  1. In Ops Manager, click Ops Manager in the upper left to exit system administration.
  2. Click the Group link at the top of the page and select the desired group.
  3. Click Deployment and then click Version Manager.
  4. Select the checkboxes for the versions of MongoDB that you have made available on the Ops Manager Application server.
7

Review and approve your changes.

Ops Manager displays your proposed changes.

  1. If you are satisfied, click Confirm & Deploy.
  2. Otherwise, click Cancel and you can make additional changes.

Start Ops Manager When All Versions Are Not Downloaded

Ops Manager sets the default source of MongoDB binaries to be over the Internet from MongoDB. This enables you to install all versions of MongoDB. This allows Ops Manager to deploy any supported version of MongoDB.

When you set Ops Manager to Local Mode, Ops Manager checks to see if the binaries for all of the versions you set in the Version Manager can be found in the Versions Directory on the Ops Manager server. If these binaries are not found, Ops Manager fails this “pre-flight” check and stops.

To allow you to start Ops Manager, you can either install all of the binaries for every version of MongoDB or change the configuration of Ops Manager temporarily to allow it to start and let you change the versions of MongoDB your Ops Manager server supports.

Change Configuration File to Allow Ops Manager to Start

To change the Ops Manager configuration temporarily:

1

Login to the Ops Manager server.

2

Open the Ops Manager configuration properties file in your preferred text editor.

sudo vi /opt/mongodb/mms/conf/conf-mms.properties

Note

This path is for RPM and DEB package installs. The Linux archive and Windows binaries install in different paths.

3

Change the source for MongoDB binaries.

Add this line, which changes the source of MongoDB versions to be MongoDB, Inc. via the Internet.

automation.versions.source=mongodb
4

Save and close the file.

5

Repeat all previous steps on each Ops Manager server. (Optional)

If you run Ops Manager with high availability, you must repeat all previous steps in this procedure on each Ops Manager server.

6

Start the Ops Manager service on each Ops Manager server.

sudo service mongodb-mms start

If you run Ops Manager with high availability, you must repeat this step on each Ops Manager server.

7

Change the versions of MongoDB that Automation Agents can install.

See how to set the MongoDB versions that automation can install for details.

Warning

You need to change the MongoDB version list for every group in Ops Manager.

8

Continue to the next procedure.

Once you have changed which versions you want to support, continue to the next procedure.

Revert the Configuration File to Return to Local Mode

If these steps are not completed, Ops Manager remains in Internet mode and displays a notice in the configuration page notifying you that the Local Mode setting in your conf-mms.properties overrides this setting.

To revert the Ops Manager configuration change:

1

Login to your Ops Manager server.

2

Open the Ops Manager configuration properties file in your preferred text editor.

sudo service mongodb-mms stops
3

Open the Ops Manager configuration properties file.

sudo vi /opt/mongodb/mms/conf/conf-mms.properties
4

Delete the automation.versions.source line.

Removing the following line reverts the change you made in the previous procedure and re-enables Local Mode.

automation.versions.source=mongodb
5

Save and close the Ops Manager configuration properties file.

6

Repeat the previous steps on each Ops Manager server. (Optional)

If you run Ops Manager with high availability, you must repeat the previous steps on each Ops Manager server.

7

Start the Ops Manager service on each Ops Manager server.

sudo service mongodb-mms start

If you run Ops Manager with high availability, you must repeat the last step on each Ops Manager server.