Navigation

Upgrade to MongoDB Enterprise (Sharded Cluster)

MongoDB Enterprise provides various features not available in the MongoDB Community edition, such as:

The following steps outline the procedure to upgrade a sharded cluster from the MongoDB Community Edition to the MongoDB Enterprise Edition. For example, the steps can be used to upgrade MongoDB 4.0 Community to MongoDB 4.0 Enterprise.

Warning

Do not use these instructions to upgrade to another release version. To upgrade release versions, refer to the appropriate release upgrade instructions, such as Upgrade to MongoDB 4.2.

Depending on your operating system, you can install the MongoDB Enterprise binaries by using a package manager or by downloading the binaries manually.

To minimize downtime, you can upgrade from MongoDB Community to Enterprise Edition using a "rolling" upgrade by upgrading the members individually while the other members are available.

1

Connect a mongo shell to a mongos instance in the sharded cluster, and run sh.stopBalancer() to disable the balancer:

sh.stopBalancer()
Note

If a migration is in progress, the system will complete the in-progress migration before stopping the balancer. You can run sh.isBalancerRunning() to check the balancer's current state.

To verify that the balancer is disabled, run sh.getBalancerState(), which returns false if the balancer is disabled:

sh.getBalancerState()

Starting in MongoDB 4.2, sh.stopBalancer() also disables auto-splitting for the sharded cluster.

For more information on disabling the balancer, see Disable the Balancer.

2
  1. Upgrade the secondary members of the replica set one at a time:

    1. Shut down the secondary mongod instance.
    2. Restart the member with the Enterprise mongod, specifying the same configuration options (e.g. same data directory, configuration file, etc.).
    3. Wait for the member to recover to SECONDARY state before upgrading the next secondary member. To check the member's state, issue rs.status() in the mongo shell.

    Repeat for each remaining secondary member.

  2. Step down the replica set primary.

    Connect a mongo shell to the primary and use rs.stepDown() to step down the primary and force an election of a new primary:

    rs.stepDown()
  3. When rs.status() shows that the primary has stepped down and another member is primary, upgrade the stepped-down primary:

    1. Shut down the stepped-down primary.
    2. Restart with the Enterprise mongod, specifying the same configuration options (e.g. same data directory, configuration file, etc.).
3

Upgrade the shards one at a time.

For each shard replica set:

  1. Upgrade the secondary members of the replica set one at a time:

    1. Shut down the secondary mongod instance.
    2. Restart the member with the Enterprise mongod, specifying the same configuration options (e.g. same data directory, configuration file, etc.).
    3. Wait for the member to recover to SECONDARY state before upgrading the next secondary member. To check the member's state, issue rs.status() in the mongo shell.

    Repeat for each remaining secondary member.

  2. Step down the replica set primary.

    Connect a mongo shell to the primary and use rs.stepDown() to step down the primary and force an election of a new primary:

    rs.stepDown()
  3. When rs.status() shows that the primary has stepped down and another member is primary, upgrade the stepped-down primary:

    1. Shut down the stepped-down primary.
    2. Restart with the Enterprise mongod, specifying the same configuration options (e.g. same data directory, configuration file, etc.).
4

For each mongos instance, shutdown mongos and restart with the Enterprise mongos, specifying the same configuration options.

5

Using a mongo shell, connect to a mongos in the cluster and run sh.startBalancer() to re-enable the balancer:

sh.startBalancer()

Starting in MongoDB 4.2, sh.startBalancer() also enables auto-splitting for the sharded cluster.

For more inforamtion on the balancer, see Enable the Balancer.

Important

Before using any Enterprise features, ensure that all members have been upgraded to Enterprise edition.

Give Feedback

On this page

  • Consideration
  • Download Enterprise Binaries
  • Procedure