Deploy a highly available MongoDB solution to Azure and Azure Stack Hub

Applies to: Azure Stack Hub integrated systems

This article will step you through an automated deployment of a basic highly available (HA) MongoDB cluster with a disaster recovery (DR) site across two Azure Stack Hub environments. To learn more about MongoDB and high availability, see Replica Set Members.

In this solution, you'll create a sample environment to:

  • Orchestrate a deployment across two Azure Stack Hubs
  • Use Docker to minimize dependency issues with Azure API Profiles
  • Deploy a basic highly available MongoDB cluster with a disaster recovery site


Microsoft Azure Stack Hub is an extension of Azure. Azure Stack Hub brings the agility and innovation of cloud computing to your on-premises environment, enabling the only hybrid cloud that allows you to build and deploy hybrid apps anywhere.

The article Design Considerations for Hybrid Applications reviews pillars of software quality (placement, scalability, availability, resiliency, manageability, and security) for designing, deploying, and operating hybrid applications. The design considerations assist in optimizing hybrid app design, minimizing challenges in production environments.

Architecture for MongoDB with Azure Stack Hub

highly available MongoDB in Azure Stack Hub

Prerequisites for MongoDB with Azure Stack Hub

  • Two connected Azure Stack Hub Integrated Systems (Azure Stack Hub), this deployment does not work on Azure Stack Hub Development Kits (ASDKs). To learn more about Azure Stack Hub, see What is Azure Stack Hub?
    • A tenant subscription on each Azure Stack Hub.
    • Make a note of each subscription ID and the Azure Resource Manager endpoint for each Azure Stack Hub.
  • An Azure Active Directory (Azure AD) service principal that has permissions to the tenant subscription on each Azure Stack Hub. You may need to create two service principals if the Azure Stack Hubs are deployed against different Azure AD tenants. To learn how to create a service principal for Azure Stack Hub, see Create service principals to give applications access to Azure Stack Hub resources.
    • Make a note of each service principal's application ID, client secret, and tenant name (
  • Ubuntu 16.04 syndicated to each Azure Stack Hub's Marketplace. To learn more about marketplace syndication, see Download marketplace items from Azure to Azure Stack Hub.
  • Docker for Windows installed on your local machine.

Get the Docker image

Docker images for each deployment eliminate dependency issues between different versions of Azure PowerShell.

  1. Make sure that Docker for Windows is using Windows containers.
  2. Run the following in an elevated command prompt to get the Docker container with the deployment scripts.
docker pull intelligentedge/mongodb-hadr:1.0.0

Deploy the clusters

  1. Once the container image has been successfully pulled, start the image.\

    docker run -it intelligentedge/mongodb-hadr:1.0.0 powershell
  2. Once the container has started, you will be given an elevated PowerShell terminal in the container. Change directories to get to the deployment script.

    cd .\MongoHADRDemo\
  3. Run the deployment. Provide credentials and resource names where needed. HA refers to the Azure Stack Hub where the HA cluster will be deployed, and DR to the Azure Stack Hub where the DR cluster will be deployed.

    .\Deploy-AzureResourceGroup.ps1 `
    -AzureStackApplicationId_HA "applicationIDforHAServicePrincipal" `
    -AzureStackApplicationSercet_HA "clientSecretforHAServicePrincipal" `
    -AADTenantName_HA "" `
    -AzureStackResourceGroup_HA "haresourcegroupname" `
    -AzureStackArmEndpoint_HA "" `
    -AzureStackSubscriptionId_HA "haSubscriptionId" `
    -AzureStackApplicationId_DR "applicationIDforDRServicePrincipal" `
    -AzureStackApplicationSercet_DR "ClientSecretforDRServicePrincipal" `
    -AADTenantName_DR "" `
    -AzureStackResourceGroup_DR "drresourcegroupname" `
    -AzureStackArmEndpoint_DR "" `
    -AzureStackSubscriptionId_DR "drSubscriptionId"
  4. Type Y to allow the NuGet provider to be installed, which will kick off the API Profile "2018-03-01-hybrid" modules to be installed.

  5. The HA resources will deploy first. Monitor the deployment and wait for it to complete. Once you have the message stating that the HA deployment is complete, you can check the HA Azure Stack Hub's portal to see the resources deployed.

  6. Continue with the deployment of DR resources and decide if you'd like to enable a jump box on the DR Azure Stack Hub to interact with the cluster.

  7. Wait for DR resource deployment to complete.

  8. Once DR resource deployment has completed, exit the container.


Next steps

  • If you enabled the jump box VM on the DR Azure Stack Hub, you can connect via SSH and interact with the MongoDB cluster by installing the mongo CLI. To learn more about interacting with MongoDB, see The mongo Shell.

  • Learn more about hybrid cloud applications, see Hybrid Cloud Solutions.

  • Modify the code to this sample on GitHub.