Fix This Page
Navigation
You were redirected from a different version of the documentation. Click here to go back.

Update the MongoDB Version of a Deployment

Overview

This tutorial describes how to use the API to migrate a MongoDB deployment to a new version of MongoDB. These steps assume you have an existing deployment that uses a 2.4.x version of MongoDB, as would be the case if you used the tutorial to Deploy a Cluster through the API, that you will migrate to a 2.6 or later deployment.

Beginning with version 2.6, MongoDB implemented a new format for MongoDB configuration options. These steps describe how to modify an existing 2.4 sharded cluster to conform to the 2.6 configuration format.

Consideration

The API supports the MongoDB options listed on the Supported MongoDB Options for Automation page.

Prerequisite

You must have credentials to access Ops Manager as a user with the Global Owner role.

Procedure

1

Retrieve the automation configuration from Ops Manager.

Use the automationConfig resource to retrieve the configuration. Issue the following command, replacing <username> and <apiKey> with your API credentials, <url> with the URL of Ops Manager, and <group_id> with the group ID from your Group Settings:

curl -u "<username>:<apiKey>" "http://<url>/api/public/v1.0/groups/<group_id>/automationConfig" --digest -i

Confirm that the version field of the retrieved automation configuration matches the version field in the mms-cluster-config-backup.json file, which is found on any server running the Automation Agent.

2

Open the configuration document for editing.

As you edit the configuration document in the next steps, reference the description of an automation configuration for detailed descriptions of settings.

3

Add the new MongoDB version number to the configuration document.

Update the mongoDbVersions array to include {"name": "2.6.7"}:

"mongoDbVersions": [
    {"name": "2.4.12"},
    {"name": "2.6.7"}
]
4

Update the MongoDB configuration options to the 2.6 syntax.

Update each document in the processes array as follows.

Update the processes.version field to specify 2.6.7:

"version": "2.6.7"

Change the processes.args2_4 field to processes.args2_6:

"args2_6": {

Edit the options in the processes.args2_6 field to conform with the MongoDB 2.6 structure described in Configuration File Options in the MongoDB manual. For example:

"args2_6": {
    "net": {
        "port": 27017
    },
    "storage": {
        "dbPath": "/data/"
    },
    "systemLog": {
        "path": "/data/mongodb.log",
        "destination": "file"
    },
    "replication": {
        "replSetName": "rs1"
    },
    "operationProfiling": {}
}
5

Send the updated automation configuration.

Use the automationConfig resource to send the updated automation configuration.

Issue the following command, replacing <configuration> with path to the updated configuration document. Replace the username, API key, URL, and group ID as in previous steps.

curl -u "<username>:<apiKey>" -H "Content-Type: application/json" "http://<url>/api/public/v1.0/groups/<group_id>/automationConfig" --digest -i -X PUT --data @<configuration>

Upon successful update of the configuration, the API returns the HTTP 200 OK status code to indicate the request has succeeded.

6

Confirm successful update of the automation configuration.

Retrieve the automation configuration from Ops Manager and confirm it contains the changes. To retrieve the configuration, issue the following command, replacing username, API key, URL, and group ID as in previous steps.

curl -u "<username>:<apiKey>" "http://<url>/api/public/v1.0/groups/<group_id>/automationConfig" --digest -i
7

Check the deployment status to ensure goal state is reached.

Use the automationStatus resource to retrieve the deployment status. Issue the following command, replacing username, API key, URL, and group ID as in previous steps.

curl -u "<username>:<apiKey>" "http://<url>/api/public/v1.0/groups/<group_id>/automationStatus" --digest -i

Confirm that the values of all the lastGoalVersionAchieved fields in the processes array match the goalVersion field. For more information on deployment status, see Automation Status.