Skip to content

Commit a0ec6c9

Browse files
authored
Merge pull request #4874 from sushantrane/srane-replicate-data-globally-update
Changes to Replicate data globally panel for azure cosmos db
2 parents b4ff01a + 5e7802c commit a0ec6c9

18 files changed

Lines changed: 34 additions & 37 deletions

articles/cosmos-db/cassandra/support.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -350,7 +350,7 @@ Azure Cosmos DB supports Azure role-based access control (Azure RBAC) for provis
350350

351351
## Keyspace and Table options
352352

353-
The options for region name, class, replication_factor, and datacenter in the `CREATE KEYSPACE` command are ignored currently. The system uses the underlying Azure Cosmos DB's [global distribution](../global-distribution.md) replication method to add the regions. If you need the cross-region presence of data, you can enable it at the account level with PowerShell, CLI, or the Azure portal. For more information, see [Add regions to your database account](../how-to-manage-database-account.yml#add-remove-regions-from-your-database-account).
353+
The options for region name, class, replication_factor, and datacenter in the `CREATE KEYSPACE` command are ignored currently. The system uses the underlying Azure Cosmos DB's [global distribution](../global-distribution.md) replication method to add the regions. If you need the cross-region presence of data, you can enable it at the account level with PowerShell, CLI, or the Azure portal. For more information, see [Add regions to your database account](../how-to-manage-database-account.yml#add-or-remove-regions-from-your-database-account).
354354

355355
Durable_writes can't be disabled because Azure Cosmos DB ensures every write is durable. In every region, Azure Cosmos DB replicates the data across the replica set that is made up of four replicas and this replica set [configuration](../global-distribution.md) can't be modified.
356356

articles/cosmos-db/data-residency.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ In Azure Cosmos DB, you can configure your data and backups to remain in a singl
2020

2121
## Residency requirements for data
2222

23-
In Azure Cosmos DB, you must explicitly configure the cross-region data replication. Learn how to configure geo-replication using [Azure portal](how-to-manage-database-account.yml#add-remove-regions-from-your-database-account), [Azure CLI](scripts/cli/common/regions.md). To meet data residency requirements, you can create an Azure Policy definition that allows certain regions to prevent data replication to unwanted regions.
23+
In Azure Cosmos DB, you must explicitly configure the cross-region data replication. Learn how to configure geo-replication using [Azure portal](how-to-manage-database-account.yml#add-or-remove-regions-from-your-database-account), [Azure CLI](scripts/cli/common/regions.md). To meet data residency requirements, you can create an Azure Policy definition that allows certain regions to prevent data replication to unwanted regions.
2424

2525
## Residency requirements for backups
2626

articles/cosmos-db/distribute-data-globally.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -65,6 +65,6 @@ With Azure Cosmos DB, you can add or remove the regions associated with your acc
6565
* [Global distribution - under the hood](global-distribution.md)
6666
* [How to configure multi-region writes in your applications](how-to-multi-master.md)
6767
* [Configure multiple write-regions](how-to-manage-database-account.yml#configure-multiple-write-regions)
68-
* [Add or remove regions from your Azure Cosmos DB account](how-to-manage-database-account.yml#add-remove-regions-from-your-database-account)
68+
* [Add or remove regions from your Azure Cosmos DB account](how-to-manage-database-account.yml#add-or-remove-regions-from-your-database-account)
6969
* [Create a custom conflict resolution policy for API for NoSQL accounts](how-to-manage-conflicts.md#create-a-custom-conflict-resolution-policy)
7070
* [Programmable consistency models in Azure Cosmos DB](consistency-levels.md)

articles/cosmos-db/global-distribution.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -98,7 +98,7 @@ For complete details on consistency level semantics and guarantees, see [Consist
9898

9999
Next learn how to configure global distribution by using the following articles:
100100

101-
* [Add/remove regions from your database account](how-to-manage-database-account.yml#add-remove-regions-from-your-database-account)
101+
* [Add/remove regions from your database account](how-to-manage-database-account.yml#add-or-remove-regions-from-your-database-account)
102102
* [How to create a custom conflict resolution policy](how-to-manage-conflicts.md#create-a-custom-conflict-resolution-policy)
103103
* Trying to do capacity planning for a migration to Azure Cosmos DB? You can use information about your existing database cluster for capacity planning.
104104
* If all you know is the number of vcores and servers in your existing database cluster, read about [estimating request units using vCores or vCPUs](convert-vcore-to-request-unit.md)

articles/cosmos-db/how-to-manage-conflicts.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -535,7 +535,7 @@ Learn about the following Azure Cosmos DB concepts:
535535
- [Global distribution - under the hood](global-distribution.md)
536536
- [How to configure multi-region writes in your applications](how-to-multi-master.md)
537537
- [Configure clients for multihoming](how-to-manage-database-account.yml#configure-multiple-write-regions)
538-
- [Add or remove regions from your Azure Cosmos DB account](how-to-manage-database-account.yml#add-remove-regions-from-your-database-account)
538+
- [Add or remove regions from your Azure Cosmos DB account](how-to-manage-database-account.yml#add-or-remove-regions-from-your-database-account)
539539
- [How to configuremulti-region writes in your applications](how-to-multi-master.md).
540540
- [Partitioning and data distribution](partitioning.md)
541541
- [Indexing in Azure Cosmos DB](index-policy.md)

articles/cosmos-db/how-to-manage-database-account.yml

Lines changed: 28 additions & 31 deletions
Original file line numberDiff line numberDiff line change
@@ -109,34 +109,39 @@ procedureSection:
109109
110110
:::image type="content" source="~/reusable-content/ce-skilling/azure/media/cosmos-db/azure-cosmos-db-account-created-2.png" alt-text="Screenshot shows the Azure Cosmos DB account page." lightbox="~/reusable-content/ce-skilling/azure/media/cosmos-db/azure-cosmos-db-account-created-2.png":::
111111
- title: |
112-
Add/remove regions from your database account
112+
Add or remove regions from your database account
113113
summary: |
114-
> [!TIP]
115-
> When a new region is added, all data must be fully replicated and committed into the new region before the region is marked as available. The amount of time this operation takes depends upon how much data is stored within the account. If an [asynchronous throughput scaling operation](scaling-provisioned-throughput-best-practices.md#background-on-scaling-rus) is in progress, the throughput scale-up operation is paused and resumes automatically when the add/remove region operation is complete. Additionally, when removing an existing region, all replication across regions (within [partition sets](./global-distribution.md)) must complete before the region is marked as unavailable.
114+
> [!NOTE]
115+
> Adding or removing a region is an asynchronous operation that performs consistency checks and transfers data. This can result in long execution times, possibly many hours, depending on the amount of data. During this time, other operations that need to update the account aren't allowed.
116+
117+
> [!IMPORTANT]
118+
> When you add a region, you're billed for the additional RU/s and storage copied to the region.
116119
steps:
117120
- |
118121
Sign in to [Azure portal](https://portal.azure.com).
119122
- |
120123
Go to your Azure Cosmos DB account and select **Replicate data globally** in the resource menu.
121124
- |
122-
To add regions, select the hexagons on the map with the **+** label that corresponds to your desired regions. Alternatively, to add a region, select the **+ Add region** option and choose a region from the drop-down menu.
123-
- |
124-
To remove regions, clear one or more regions from the map by selecting the blue hexagons with check marks. You can also select the *wastebasket* (🗑) icon next to the region on the right side.
125+
Select **Manage regions** to open the **Manage regions** pane.
125126
127+
:::image type="content" source="./media/how-to-manage-database-account/manage-regions.png" alt-text="Screenshot of the Replicate data globally page with manage regions selected.":::
128+
129+
- |
130+
To add a region, select a region from the **Region** dropdown. If you want to enable availability zone support for the region, select the **Availability zone** checkbox, then select **Add**. To learn more, see [Availability zone support for Azure Cosmos DB](/azure/reliability/reliability-cosmos-db-nosql#availability-zone-support).
126131
- |
127-
To save your changes, select **OK**.
132+
To remove a region, select the delete icon next to the region you want to remove.
128133
129-
:::image type="content" source="./media/how-to-manage-database-account/add-region.png" alt-text="Screenshot of the Replicate data globally menu, highlighting a region.":::
134+
:::image type="content" source="./media/how-to-manage-database-account/manage-regions-pane.png" alt-text="Screenshot of the Replicate data globally page and the Manage regions pane.":::
130135
131-
In a single-region write mode, you can't remove the write region. You must fail over to a different region before you can delete the current write region.
136+
In single-region write mode, you can't remove the write region. You must fail over to a different region before you can delete the current write region.
132137
133-
In a multi-region write mode, you can add or remove any region, if you have at least one region.
138+
In multi-region write mode, you can add or remove any region, as long as at least one region remains.
134139
135140
## <a id="configure-multiple-write-regions"></a>Configure multiple write-regions
136141
137-
Open the **Replicate data globally** tab and select **Enable** to enable multi-region writes. After you enable multi-region writes, all the read regions that you currently have on the account will become read and write regions.
142+
In the **Configuration** section of the **Replicate data globally** page, select the **Multi-region writes** checkbox to enable multi-region writes. It will ask for a confirmation to enable this feature. After you enable multi-region writes, all the read regions that you currently have on the account become read and write regions.
138143
139-
:::image type="content" source="./media/how-to-manage-database-account/single-to-multi-master.png" alt-text="Screenshot of the Replicate data globally menu, highlighting Configure regions and Save.":::
144+
:::image type="content" source="./media/how-to-manage-database-account/configure-multi-region-writes.png" alt-text="Screenshot of the Replicate data globally page, highlighting the Multi-region writes checkbox.":::
140145
- title: |
141146
Enable service-managed failover for your Azure Cosmos DB account
142147
summary: |
@@ -157,20 +162,20 @@ procedureSection:
157162
- title: |
158163
Perform forced failover for your Azure Cosmos DB Account
159164
summary: |
160-
A forced failover (region offline) enables users to promptly address degraded performance, partial outages, or regional disruptions in a Cosmos DB account. A service-managed failover depends on the service's confirmation and which might take time to activate based on the progression of the outage. A forced failover allows administrators to quickly restore availability for the affected region without waiting for the service-managed failover.
165+
A forced failover (Offline region) enables users to promptly address degraded performance, partial outages, or regional disruptions in a Cosmos DB account. A service-managed failover depends on the service's confirmation and which might take time to activate based on the progression of the outage. A forced failover allows administrators to quickly restore availability for the affected region without waiting for the service-managed failover.
161166
steps:
162167
- |
163168
From your Azure Cosmos DB account, open the **Replicate data globally** pane.
164169
- |
165170
At the top of the pane, select **Offline region**.
166171
167-
:::image type="content" source="./media/how-to-manage-database-account/offline-region-failover.png" alt-text="Screenshot that shows the offline region portal menu.":::
172+
:::image type="content" source="./media/how-to-manage-database-account/offline-region.png" alt-text="Screenshot that shows the offline region portal menu.":::
168173
- |
169174
Review the warning message indicating the possibility of data loss due to un-replicated writes not being available in the region that will be promoted to the new write region based on the failover priority.
170175
- |
171176
Select the region to be marked offline, check the box titled **I understand and agree to offline the currently selected region**, and click the **Offline region** button.
172177
173-
:::image type="content" source="./media/how-to-manage-database-account/offline-region-warning.png" alt-text="Screenshot that shows the offline region warning.":::
178+
:::image type="content" source="./media/how-to-manage-database-account/offline-region-pane.png" alt-text="Screenshot that shows the offline region warning.":::
174179
- |
175180
Once completed, the region with the highest failover priority is promoted to the new write region, while the original write region is marked offline.
176181
@@ -184,25 +189,21 @@ procedureSection:
184189
- title: |
185190
Set failover priorities for your Azure Cosmos DB account
186191
summary: |
187-
After an Azure Cosmos DB account is configured for service-managed failover, the failover priority for regions can be changed.
192+
You can configure failover priorities for the regions in your Azure Cosmos DB account to determine the order in which regions are promoted to the write region during a failover.
188193
189-
> [!IMPORTANT]
190-
> You can't modify the write region (failover priority of zero) when the account is configured for service-managed failover. To change the write region, you must disable service-managed failover and do a manual failover.
191194
steps:
192195
- |
193196
From your Azure Cosmos DB account, open the **Replicate data globally** pane.
194197
- |
195-
At the top of the pane, select **Service-Managed Failover**.
198+
At the top of the pane, select **Configure failvoer policy**.
196199
197-
:::image type="content" source="./media/how-to-manage-database-account/replicate-data-globally.png" alt-text="Screenshot showing the Replicate data globally menu.":::
198-
- |
199-
On the **Service-Managed Failover** pane, make sure that **Enable Service-Managed Failover** is set to **ON**.
200+
:::image type="content" source="./media/how-to-manage-database-account/configure-failover-policy.png" alt-text="Screenshot showing the Replicate data globally menu.":::
200201
- |
201-
To modify the failover priority, drag the read regions via the three dots on the left side of the row that appear when you hover over them.
202+
On the **Configure failover policy** pane, drag and drop the priorities of read regions to be failed over to as needed.
202203
- |
203-
Select **Save**.
204+
Select **OK** to save the failover priority configuration.
204205
205-
:::image type="content" source="./media/how-to-manage-database-account/automatic-failover.png" alt-text="Screenshot of the Service-Managed failover portal menu.":::
206+
:::image type="content" source="./media/how-to-manage-database-account/configure-failover-policy-pane.png" alt-text="Screenshot of the Configure failover policy portal menu.":::
206207
- title: |
207208
Change write region for your Azure Cosmos DB Account
208209
summary: |
@@ -222,13 +223,9 @@ procedureSection:
222223
223224
:::image type="content" source="./media/how-to-manage-database-account/change-write-region.png" alt-text="Screenshot of the change write region menu.":::
224225
- |
225-
The **Change write region** panel provides details to ensure that this operation isn't executed during outage scenarios. Select and acknowledge that this operation is not being performed during regional outages.
226-
227-
:::image type="content" source="./media/how-to-manage-database-account/change-write-region-details.png" alt-text="Screenshot of the change write region details.":::
228-
- |
229-
Select a new write region and checkbox to acknowledge the operation confirmation. Click **Ok** to perform the operation.
226+
The **Change write region** panel provides details to ensure that this operation isn't executed during outage scenarios. Select a new write region, acknowledge that this operation isn't being performed during regional outages by selecting the checkboxes, and then select **OK** to perform the operation.
230227
231-
:::image type="content" source="./media/how-to-manage-database-account/change-write-region-confirm.png" alt-text="Screenshot of the change write region confirmation.":::
228+
:::image type="content" source="./media/how-to-manage-database-account/change-write-region-pane.png" alt-text="Screenshot of the change write region confirmation.":::
232229
233230
relatedContent:
234231
- text: Manage Azure Cosmos DB for NoSQL resources using PowerShell
128 KB
Loading
67.7 KB
Loading
-271 KB
Loading
49.3 KB
Loading

0 commit comments

Comments
 (0)