You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/api-management/migrate-stv1-to-stv2-vnet.md
+15-18Lines changed: 15 additions & 18 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -6,7 +6,7 @@ author: dlepow
6
6
ms.service: api-management
7
7
ms.custom:
8
8
ms.topic: how-to
9
-
ms.date: 06/14/2024
9
+
ms.date: 06/18/2024
10
10
ms.author: danlep
11
11
---
12
12
@@ -38,7 +38,7 @@ API Management platform migration from `stv1` to `stv2` involves updating the un
38
38
* For an instance in internal VNet mode, customer manages the DNS, so the DNS entries continue to point to old compute until updated by the customer.
39
39
* It's the DNS that points to either the new or the old compute and hence no downtime to the APIs.
40
40
* Changes are required to your firewall rules, if any, to allow the new compute subnet to reach the backends.
41
-
* After successful migration, the old compute is automatically decommissioned after approximately 15 minutes by default, with an option to delay it for up to 48 hours. *The 48 hour delay option is only available for VNet-injected services.*
41
+
* After successful migration, the old compute is automatically decommissioned after approximately 15 minutes by default. You can enable a migration setting to retain the old gateway for 48 hours. *The 48 hour delay option is only available for VNet-injected services.*
42
42
43
43
## Prerequisites
44
44
@@ -50,12 +50,6 @@ API Management platform migration from `stv1` to `stv2` involves updating the un
* (Optional) Contact Azure support to request that the original service infrastructure is maintained in parallel for up to 48 hours after successful migration. This option extends the period when the old infrastructure is available after migration beyond the default of 15 minutes before it is purged. This option is available only for VNet-injected services to allow service owners to update network settings and test applications to use the new infrastructure. This extension request applies to all API Management instances in a subscription.
54
-
55
-
> [!NOTE]
56
-
> If you plan to migrate your VNet-injected API Management instance back to the original subnet after migration, we recommend that you don't request the 48-hour extension.
57
-
58
-
59
53
## Trigger migration of a network-injected API Management instance
60
54
61
55
Trigger migration of a network-injected API Management instance to the `stv2` platform by updating the existing network configuration to use new network settings in each region where the instance is deployed. After that update completes, as an optional step, you can migrate back to the original VNets and subnets you used.
@@ -76,15 +70,20 @@ You can use the Azure portal to migrate to a new subnet in the same or a differe
76
70
1. In the [Azure portal](https://portal.azure.com), navigate to your API Management instance.
77
71
1. In the left menu, under **Settings**, select **Platform migration**.
78
72
1. On the **Platform migration** page, in **Step 1**, review migration requirements and prerequisites.
79
-
1. In **Step 2**, select a location to migrate. Select the **Virtual network**, **Subnet**, and optional **Public IP address** you want to migrate to.
80
-
:::image type="content" source="media/migrate-stv1-to-stv2-vnet/select-location.png" alt-text="Screenshot of selecting network migration settings in the portal." lightbox="media/migrate-stv1-to-stv2-vnet/select-location.png":::
73
+
1. In **Step 2**, choose migration settings:
74
+
* Select a location to migrate.
75
+
* Select the **Virtual network**, **Subnet**, and optional **Public IP address** you want to migrate to.
76
+
:::image type="content" source="media/migrate-stv1-to-stv2-vnet/select-location.png" alt-text="Screenshot of selecting network migration settings in the portal." lightbox="media/migrate-stv1-to-stv2-vnet/select-location.png":::
77
+
78
+
* Select either **Return to original subnet as soon as possible** or **Stay in the new subnet and keep stv1 compute around for 48 hours** after migration. If you choose the former, the `stv1` compute will be deleted approximately 15 minutes after migration, allowing you to proceed directly with migration back to the original subnet if desired. If you choose the latter, the `stv1` compute is retained for 48 hours. You can use this period to validate your network settings and connectivity.
79
+
:::image type="content" source="media/migrate-stv1-to-stv2-vnet/enable-retain-gateway.png" alt-text="Screenshot of options to retain stv1 compute in the portal." lightbox="media/migrate-stv1-to-stv2-vnet/enable-retain-gateway.png":::
81
80
82
81
1. In **Step 3**, confirm you want to migrate, and select **Migrate**.
83
-
1. If your API Management instance is deployed in multiple regions, continue migrating VNet settings for the remaining locations of your instance.
82
+
The status of your API Management instance changes to **Updating**. The migration process takes approximately 45 minutes to complete. When the status changes to **Online**, migration is complete.
84
83
85
-
---
84
+
If your API Management instance is deployed in multiple regions, repeat the preceding steps to continue migrating VNet settings for the remaining locations of your instance.
86
85
87
-
After you update the VNet configuration, the status of your API Management instance changes to **Updating**. The migration process takes approximately 45 minutes to complete. When the status changes to **Online**, migration is complete.
86
+
---
88
87
89
88
## (Optional) Migrate back to original subnet
90
89
@@ -97,8 +96,6 @@ The following image shows a high level overview of what happens during migration
97
96
> [!IMPORTANT]
98
97
> If the VNet and subnet are locked (because other `stv1` platform-based API Management instances are deployed there) or the resource group where the original VNet is deployed has a [resource lock](../azure-resource-manager/management/lock-resources.md), make sure to remove the lock before migrating back to the original subnet. Wait for lock removal to complete before attempting the migration to the original subnet. [Learn more](api-management-using-with-internal-vnet.md#challenges-encountered-in-reassigning-api-management-instance-to-previous-subnet).
99
98
100
-
> [!NOTE]
101
-
> If you plan to migrate back to the original subnet, we recommend that you don't request the 48-hour extension on your subscription for maintaining the old infrastructure; otherwise, your migration will be delayed. If you need to cancel an extension, contact Azure support.
102
99
103
100
### Additional prerequisites
104
101
@@ -149,7 +146,7 @@ After you update the VNet configuration, the status of your API Management insta
149
146
150
147
-**Will the migration cause a downtime?**
151
148
152
-
Since the old gateway is purged only after the new compute is healthy and online, there shouldn't be any downtime if default hostnames are in use. It's critical that all network dependencies are taken care of upfront, for the impacted APIs to be functional. However, if custom domains are in use, they'll be pointing to the purged compute until they're updated which may cause a downtime. Alternatively, you can request for the old gateway to be retained for up to 48 hours by creating an Azure support ticket in advance. Having the old and the new compute coexist will facilitate validation, and then you can update the custom DNS entries at will.
149
+
Since the old gateway is purged only after the new compute is healthy and online, there shouldn't be any downtime if default hostnames are in use. It's critical that all network dependencies are taken care of upfront, for the impacted APIs to be functional. However, if custom domains are in use, they'll be pointing to the purged compute until they're updated which may cause a downtime. Alternatively, enable a migration setting to retain the old gateway for 48 hours. Having the old and the new compute coexist will facilitate validation, and then you can update the custom DNS entries at will.
153
150
154
151
155
152
-**My traffic is force tunneled through a firewall. What changes are required?**
@@ -215,13 +212,13 @@ After you update the VNet configuration, the status of your API Management insta
215
212
-**Can I upgrade my stv1 instance to the same subnet?**
216
213
217
214
- You can't migrate the `stv1` instance to the same subnet in a single pass without downtime. However, you can optionally move your migrated instance back to the original subnet. More details [here](#optional-migrate-back-to-original-subnet).
218
-
- The old gateway takes between 15 mins to 45 mins to vacate the subnet, so that you can initiate the move. However, you can request to increase this time to up to 48 hours by a support ticket.
215
+
- The old gateway takes between 15 mins to 45 mins to vacate the subnet, so that you can initiate the move. However, you can enable a migration setting to retain the old gateway for 48 hours.
219
216
- Ensure that the old subnet's networking for [NSG](./api-management-using-with-internal-vnet.md?tabs=stv2#configure-nsg-rules) and [firewall](./api-management-using-with-vnet.md?tabs=stv2#force-tunnel-traffic-to-on-premises-firewall-using-expressroute-or-network-virtual-appliance) is updated for `stv2` dependencies.
220
217
- Subnet IP address allocation is nondeterministic, therefore the original ILB (ingress) IP for "internal mode" deployments may change when you move back to the original subnet. This would require a DNS change if you're using A records.
221
218
222
219
-**Can I test the new gateway before switching the live traffic?**
223
220
224
-
- By default, the old and the new managed gateways coexist for 15 mins, which is a small window of time to validate the deployment. You can request to increase this time to up to 48 hours through an Azure support ticket. This change keeps the old and the new managed gateways active to receive traffic and facilitate validation.
221
+
- By default, the old and the new managed gateways coexist for 15 mins, which is a small window of time to validate the deployment. You can enable a migration setting to retain the old gateway for 48 hours. This change keeps the old and the new managed gateways active to receive traffic and facilitate validation.
225
222
- The migration process automatically updates the default domain names, and if being used, the traffic routes to the new gateways immediately.
226
223
- If custom domain names are in use, the corresponding DNS records might need to be updated with the new IP address if not using CNAME. Customers can update their hosts file to the new API Management IP and validate the instance before making the switch. During this validation process, the old gateway continues to serve the live traffic.
0 commit comments