Sitecore XP 8.2 support for MongoDB 3.6 and MongoDB Atlas


Description

MongoDB 3.4, which is used by Sitecore XP 8.2.x, will reach end of life support in January 2020 as has been announced previously here. As Sitecore XP 8.2 has entered the Extended Support phase, we recommend upgrading to the latest Sitecore XP version, which is compatible with MongoDB 4.0.

Customers who want to continue using Sitecore XP 8.2.x with a supported MongoDB version need to upgrade Sitecore XP to version 8.2.7, upgrade the MongoDB server to version 3.6, and update the MongoDB driver as described in the following section.

In addition, mLab is now part of MongoDB, Inc., the company behind the database that powers Managed Cloud and xDB Cloud services. For background please see the announcement. As part of merging the two organizations they will be sun-setting mLab's service and working with users to migrate to MongoDB Atlas.

Solution

Prerequisite: To upgrade successfully, customers who use Sitecore XP versions earlier than 8.2.7 must upgrade to Sitecore XP 8.2.7.

Perform the following steps for MongoDB driver updating:

  1. Download the MongoDriver_AtlasCompatible.zip archive.
  2. Extract the following assemblies from the folder inside the archive:
    • MongoDB.Bson.dll
    • MongoDB.Driver.Core.dll
    • MongoDB.Driver.dll
    • MongoDB.Driver.Legacy.dll
    • System.Buffers.dll
    • System.Runtime.InteropServices.RuntimeInformation.dll
    • DnsClient.dll
  3. Overwrite MongoDB driver assemblies in all your Sitecore XP instances (located in the /bin folder) with the assemblies mentioned in the previous step.

    Important: Use '&' instead of '&' to separate parameters in MongoDB Atlas connection string:
    instead of:
    mongodb+srv://sa:12345@cluster0-paklo.mongodb.net/test?retryWrites=true&w=majority
    use:
    mongodb+srv://sa:12345@cluster0-paklo.mongodb.net/test?retryWrites=true&w=majority

In case of any issues, contact Sitecore Support.