Skip to content

Commit 3e23b47

Browse files
Merge pull request #260516 from khelanmodi/node-to-shard
Updated docs to say Shards instead of Nodes
2 parents 7e0c874 + 08310a6 commit 3e23b47

File tree

10 files changed

+20
-18
lines changed

10 files changed

+20
-18
lines changed

articles/cosmos-db/mongodb/migrate-databricks.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ ms.date: 08/26/2021
1212
# Migrate data from MongoDB to an Azure Cosmos DB for MongoDB account by using Azure Databricks
1313
[!INCLUDE[MongoDB](../includes/appliesto-mongodb.md)]
1414

15-
This migration guide is part of series on migrating databases from MongoDB to Azure CosmosDB API for MongoDB. The critical migration steps are [pre-migration](pre-migration-steps.md), migration, and [post-migration](post-migration-optimization.md), as shown below.
15+
This migration guide is part of series on migrating databases from MongoDB to Azure Cosmos DB API for MongoDB. The critical migration steps are [pre-migration](pre-migration-steps.md), migration, and [post-migration](post-migration-optimization.md), as shown below.
1616

1717
:::image type="content" source="./media/pre-migration-steps/overall-migration-steps.png" alt-text="Diagram of migration steps":::
1818

@@ -132,7 +132,7 @@ df.write.format("mongo").mode("append").option("uri", targetConnectionString).op
132132

133133
The migration performance can be adjusted through these configurations:
134134

135-
- **Number of workers and cores in the Spark cluster**: More workers mean more compute nodes to execute tasks.
135+
- **Number of workers and cores in the Spark cluster**: More workers mean more compute shards to execute tasks.
136136

137137
- **maxBatchSize**: The `maxBatchSize` value controls the rate at which data is saved to the target Azure Cosmos DB collection. However, if the maxBatchSize is too high for the collection throughput, it can cause [rate limiting](prevent-rate-limiting-errors.md) errors.
138138

articles/cosmos-db/mongodb/quickstart-dotnet.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ dotnet add package MongoDb.Driver
105105
Before you start building the application, let's look into the hierarchy of resources in Azure Cosmos DB. Azure Cosmos DB has a specific object model used to create and access resources. The Azure Cosmos DB creates resources in a hierarchy that consists of accounts, databases, collections, and docs.
106106

107107
:::image type="complex" source="media/quickstart-dotnet/resource-hierarchy.png" alt-text="Diagram of the Azure Cosmos DB hierarchy including accounts, databases, collections, and docs.":::
108-
Hierarchical diagram showing an Azure Cosmos DB account at the top. The account has two child database nodes. One of the database nodes includes two child collection nodes. The other database node includes a single child collection node. That single collection node has three child doc nodes.
108+
Hierarchical diagram showing an Azure Cosmos DB account at the top. The account has two child database shards. One of the database shards includes two child collection shards. The other database shard includes a single child collection shard. That single collection shard has three child doc shards.
109109
:::image-end:::
110110

111111
You'll use the following MongoDB classes to interact with these resources:

articles/cosmos-db/mongodb/quickstart-nodejs.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -105,7 +105,7 @@ npm install mongodb dotenv
105105
Before you start building the application, let's look into the hierarchy of resources in Azure Cosmos DB. Azure Cosmos DB has a specific object model used to create and access resources. The Azure Cosmos DB creates resources in a hierarchy that consists of accounts, databases, collections, and docs.
106106

107107
:::image type="complex" source="media/quickstart-nodejs/resource-hierarchy.png" alt-text="Diagram of the Azure Cosmos DB hierarchy including accounts, databases, collections, and docs.":::
108-
Hierarchical diagram showing an Azure Cosmos DB account at the top. The account has two child database nodes. One of the database nodes includes two child collection nodes. The other database node includes a single child collection node. That single collection node has three child doc nodes.
108+
Hierarchical diagram showing an Azure Cosmos DB account at the top. The account has two child database shards. One of the database shards includes two child collection shards. The other database shard includes a single child collection node. That single collection shard has three child doc shards.
109109
:::image-end:::
110110

111111
You'll use the following MongoDB classes to interact with these resources:

articles/cosmos-db/mongodb/quickstart-python.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -126,7 +126,7 @@ This quickstart will create a single Azure Cosmos DB account using the API for M
126126
Let's look at the hierarchy of resources in the API for MongoDB and the object model that's used to create and access these resources. The Azure Cosmos DB creates resources in a hierarchy that consists of accounts, databases, collections, and documents.
127127
128128
:::image type="complex" source="media/quickstart-nodejs/resource-hierarchy.png" alt-text="Diagram of the Azure Cosmos DB hierarchy including accounts, databases, collections, and docs.":::
129-
Hierarchical diagram showing an Azure Cosmos DB account at the top. The account has two child database nodes. One of the database nodes includes two child collection nodes. The other database node includes a single child collection node. That single collection node has three child doc nodes.
129+
Hierarchical diagram showing an Azure Cosmos DB account at the top. The account has two child database shards. One of the database shards includes two child collection shards. The other database shard includes a single child collection shard. That single collection shard has three child doc shards.
130130
:::image-end:::
131131
132132
Each type of resource is represented by a Python class. Here are the most common classes:

articles/cosmos-db/mongodb/vcore/failover-disaster-recovery.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -39,13 +39,13 @@ Automatic backups are retained in various intervals based on whether the cluster
3939

4040
## Design for high availability
4141

42-
High availability (HA) should be enabled for critical Azure Cosmos DB for MongoDB vCore clusters running production workloads. In an HA-enabled cluster, each node serves as a primary along with a hot-standby node provisioned in another availability zone. Replication between the primary and the secondary node is synchronous by default. Any modification to the database is persisted on both the primary and the secondary (hot-standby) nodes before a response from the database is received.
42+
High availability (HA) should be enabled for critical Azure Cosmos DB for MongoDB vCore clusters running production workloads. In an HA-enabled cluster, each shard serves as a primary along with a hot-standby shard provisioned in another availability zone. Replication between the primary and the secondary shard is synchronous by default. Any modification to the database is persisted on both the primary and the secondary (hot-standby) shards before a response from the database is received.
4343

44-
The service maintains health checks and heartbeats to each primary and secondary node of the cluster. If a primary node becomes unavailable due to a zone or regional outage, the secondary node is automatically promoted to become the new primary and a subsequent secondary node is built for the new primary. In addition, if a secondary node becomes unavailable, the service auto creates a new secondary node with a full copy of data from the primary.
44+
The service maintains health checks and heartbeats to each primary and secondary shard of the cluster. If a primary shard becomes unavailable due to a zone or regional outage, the secondary shard is automatically promoted to become the new primary and a subsequent secondary shard is built for the new primary. In addition, if a secondary shard becomes unavailable, the service auto creates a new secondary shard with a full copy of data from the primary.
4545

46-
If the service triggers a failover from the primary to the secondary node, connections are seamlessly routed under the covers to the new primary node.
46+
If the service triggers a failover from the primary to the secondary shard, connections are seamlessly routed under the covers to the new primary shard.
4747

48-
Synchronous replication between the primary and secondary nodes guarantees no data loss if there's a failover.
48+
Synchronous replication between the primary and secondary shards guarantees no data loss if there's a failover.
4949

5050
### Configure high availability
5151

articles/cosmos-db/mongodb/vcore/high-availability.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -15,15 +15,15 @@ ms.date: 08/28/2023
1515

1616
[!INCLUDE[MongoDB vCore](../../includes/appliesto-mongodb-vcore.md)]
1717

18-
High availability (HA) avoids database downtime by maintaining standby replicas of every node in a cluster. If a node goes down, Azure Cosmos DB for MongoDB vCore switches incoming connections from the failed node to its standby replica.
18+
High availability (HA) avoids database downtime by maintaining standby replicas of every shard in a cluster. If a shard goes down, Azure Cosmos DB for MongoDB vCore switches incoming connections from the failed shard to its standby replica.
1919

2020
## How it works
2121

22-
When HA is enabled, Azure Cosmos DB for MongoDB vCore runs one replica node for each primary node in the cluster. The primary and its replica use synchronous replication. The service detects failures on primary nodes and fails over to the replica nodes with zero data loss. The MongoDB connection string remains the same.
22+
When HA is enabled, Azure Cosmos DB for MongoDB vCore runs one replica shard for each primary shard in the cluster. The primary and its replica use synchronous replication. The service detects failures on primary shards and fails over to the replica shards with zero data loss. The MongoDB connection string remains the same.
2323

24-
When HA is enabled, HA replica nodes are provisioned in a different availability zone from their primary nodes, if the region supports multiple zones and has available capacity. HA replicas don't receive requests from clients unless their primary node fails.
24+
When HA is enabled, HA replica shards are provisioned in a different availability zone from their primary shards, if the region supports multiple zones and has available capacity. HA replicas don't receive requests from clients unless their primary shard fails.
2525

26-
Even without HA enabled, each node has its own locally redundant storage (LRS) with three synchronous replicas maintained by Azure Storage service. If there's a single replica failure, the Azure Storage service detects the failure, and transparently re-creates the relevant data. For LRS storage durability, see metrics on [this page](../../../storage/common/storage-redundancy.md#summary-of-redundancy-options).
26+
Even without HA enabled, each shard has its own locally redundant storage (LRS) with three synchronous replicas maintained by Azure Storage service. If there's a single replica failure, the Azure Storage service detects the failure, and transparently re-creates the relevant data. For LRS storage durability, see metrics on [this page](../../../storage/common/storage-redundancy.md#summary-of-redundancy-options).
2727

2828
## Configure high availability
2929

articles/cosmos-db/mongodb/vcore/how-to-scale-cluster.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -57,7 +57,7 @@ You can increase the storage size to give your database more room to grow. For e
5757

5858
1. To increase the storage size, select the new size from the drop-down menu.
5959

60-
:::image type="content" source="media/how-to-scale-cluster/configure-storage.png" alt-text="Screenshot of the storage per node option in the Scale page of a cluster.":::
60+
:::image type="content" source="media/how-to-scale-cluster/configure-storage.png" alt-text="Screenshot of the storage per shard option in the Scale page of a cluster.":::
6161

6262
> [!NOTE]
6363
> This change is performed live to the cluster without downtime. Also, storage size can only be increased, not decreased.
@@ -66,7 +66,7 @@ You can increase the storage size to give your database more room to grow. For e
6666

6767
## Enable or disable high availability
6868

69-
You can enable or disable high availability (HA) to suit your needs. HA avoids database downtime by maintaining replica nodes of every primary node in a cluster. If a primary node goes down, incoming connections are automatically redirected to its replica node, ensuring that there's minimal downtime.
69+
You can enable or disable high availability (HA) to suit your needs. HA avoids database downtime by maintaining replica shards of every primary shard in a cluster. If a primary shard goes down, incoming connections are automatically redirected to its replica shard, ensuring that there's minimal downtime.
7070

7171
1. To enable or disable HA, toggle the checkbox option.
7272

-177 KB
Loading

articles/cosmos-db/mongodb/vcore/quickstart-bicep.md

Lines changed: 3 additions & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -53,7 +53,7 @@ resource cluster 'Microsoft.DocumentDB/mongoClusters@2022-10-15-preview' = {
5353
nodeGroupSpecs: [
5454
{
5555
kind: 'Shard'
56-
nodeCount: 1
56+
shardCount: 1
5757
sku: 'M40'
5858
diskSizeGB: 128
5959
enableHa: false
@@ -71,6 +71,8 @@ resource firewallRules 'Microsoft.DocumentDB/mongoClusters/firewallRules@2022-10
7171
}
7272
}
7373
```
74+
> [!NOTE]
75+
> Kindly note that in the above code, shardGroupSpecs is called nodeGroupSpecs.
7476
7577
Two Azure resources are defined in the Bicep file:
7678

articles/cosmos-db/mongodb/vcore/quickstart-portal.md

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -51,9 +51,9 @@ Create a MongoDB cluster by using Azure Cosmos DB for MongoDB vCore.
5151

5252
| Setting | Value |
5353
| --- | --- |
54-
| **Node count** | Single node |
54+
| **Shard count** | Single shard |
5555
| **Cluster tier** | M30 Tier, 2 vCores, 8-GiB RAM |
56-
| **Storage per node** | 128 GiB |
56+
| **Storage per shard** | 128 GiB |
5757

5858
1. Leave the **High availability** option unselected. In the high availability (HA) acknowledgment section, select **I understand**. Finally, select **Save** to persist your changes to the cluster tier.
5959

0 commit comments

Comments
 (0)