|
| 1 | +--- |
| 2 | +title: Rolling upgrades with MaxSurge for Virtual Machine Scale Sets (preview) |
| 3 | +description: Learn about how to utilize rolling upgrades with MaxSurge on Virtual Machine Scale Sets. |
| 4 | +author: mimckitt |
| 5 | +ms.author: mimckitt |
| 6 | +ms.topic: overview |
| 7 | +ms.service: virtual-machine-scale-sets |
| 8 | +ms.date: 7/23/2024 |
| 9 | +ms.reviewer: ju-shim |
| 10 | +ms.custom: upgradepolicy. maxsurge |
| 11 | +--- |
| 12 | +# Rolling upgrades with MaxSurge on Virtual Machine Scale Sets (Preview) |
| 13 | + |
| 14 | +> [!NOTE] |
| 15 | +> **Rolling upgrades with MaxSurge for Virtual Machine Scale Sets is currently in preview.** |
| 16 | +> |
| 17 | +> Previews are made available to you on the condition that you agree to the [supplemental terms of use](https://azure.microsoft.com/support/legal/preview-supplemental-terms/). Some aspects of these features may change prior to general availability (GA). |
| 18 | +
|
| 19 | +Rolling upgrades with MaxSurge can help improve service uptime during upgrade events. With MaxSurge enabled, new instances are created in batches using the latest scale model. When the new instances are fully created and healthy, they begin taking traffic. The scale set then deletes instances in batches matching the old scale set model. The process continues until all instances are brought up-to-date. |
| 20 | + |
| 21 | +## Prerequisites |
| 22 | + |
| 23 | +Before configuring a rolling upgrade policy on a Virtual Machine Scale Set with Flexible Orchestration or enabling MaxSurge on either Flexible or Uniform Orchestration deployments, register the feature providers to your subscription. |
| 24 | + |
| 25 | +## Feature Registration |
| 26 | + |
| 27 | +```azurepowershell-interactive |
| 28 | +Register-AzProviderFeature -FeatureName VMSSFlexRollingUpgrade -ProviderNameSpace Microsoft.Compute |
| 29 | +
|
| 30 | +Register-AzProviderFeature -FeatureName MaxSurgeRollingUpgrade -ProviderNamespace Microsoft.Compute |
| 31 | +``` |
| 32 | + |
| 33 | + |
| 34 | +## Concepts |
| 35 | + |
| 36 | +> [!NOTE] |
| 37 | +> [Automatic OS image upgrades](virtual-machine-scale-sets-automatic-upgrade.md) and [automatic extension upgrades](../virtual-machines/automatic-extension-upgrade.md) automatically inherit the rolling upgrade policy and use it to perform upgrades. If MaxSurge is enabled in your rolling upgrade policy, automatic OS image upgrades and automatic extension upgrades will also be applied using the MaxSurge upgrade method. |
| 38 | +
|
| 39 | +|Setting | Description | |
| 40 | +|---|---| |
| 41 | +|**Rolling upgrade batch size %** | Specifies how many of the instances in your scale set you want to be upgraded at one time. <br><br>Example: A batch size of 20% when you have 10 instances in your scale set results in upgrade batches with two instances each. When using MaxSurge, this results in two instances being created in each batch. | |
| 42 | +|**Pause time between batches (sec)** | Specifies how long you want your scale set to wait between upgrading batches.<br><br> Example: With MaxSurge enabled, a pause time of 10 seconds means that once the new instances are successfully provisioned and are reporting as healthy, the scale set will wait 10 seconds before moving onto the next batch. | |
| 43 | +|**Max unhealthy instance %** | Specifies the total number of instances allowed to be marked as unhealthy before and during the MaxSurge upgrade. <br><br>Example: A max unhealthy instance % of 20 means if you have a scale set of 10 instances and more than two of your instances in the entire scale set report back as unhealthy, the rolling upgrade stops. | |
| 44 | +|**Max unhealthy upgrade %**| Specifies the total number of new instances allowed to be marked as unhealthy after being upgraded. <br><br>Example: A max unhealthy upgrade % of 20 means if you have a scale set of 10 instances and more than two of the newly created instances report back as unhealthy after being upgraded, the rolling upgrade is canceled. <br><br>Max unhealthy upgrade % is an important setting because it allows the scale set to catch unstable or poor updates before they roll out to the entire scale set. | |
| 45 | +|**Prioritize unhealthy instances** | Tells the scale set to upgrade instances marked as unhealthy before upgrading instances marked as healthy. <br><br>Example: If some instances in your scale set are failed or unhealthy when a MaxSurge upgrade begins, the scale set replaces those instances first. | |
| 46 | +|**Enable cross-zone upgrade** | Allows the scale set to ignore Availability Zone boundaries when determining batches. This means a batch may contain instances in multiple availability zones at the same time depending on the batch size and the size of your scale set. | |
| 47 | + |
| 48 | +## Considerations |
| 49 | + |
| 50 | +When using rolling upgrades with MaxSurge, new virtual machines are created using the latest scale set model to replace virtual machines using the old scale set model. These newly created virtual machines counts towards your overall core quota. Additionally, these new virtual machines have new IP addresses and are placed into an existing subnet. You also need to have enough IP address quota and subnet space available to deploy these newly created virtual machines. |
| 51 | + |
| 52 | +During the rolling upgrade processes, Azure performs a quota check before each new batch. If that quota check fails, the rolling upgrade will be canceled. You can restart a rolling upgrade by making a new change to the scale set model or triggering a generic model update. For more information, see [restart a rolling upgrade](virtual-machine-scale-sets-configure-rolling-upgrades.md#restart-a-rolling-upgrade). |
| 53 | + |
| 54 | +## MaxSurge vs in place upgrades |
| 55 | + |
| 56 | +### MaxSurge upgrades |
| 57 | + |
| 58 | +Rolling upgrades with MaxSurge creates new instances with the latest scale set model to replace instances running with the old model. By creating new instances, you can ensure that your scale set capacity doesn't drop below the set instance count during the duration of the upgrade process. |
| 59 | + |
| 60 | +:::image type="content" source="./media/upgrade-policy/maxsurge-upgrade.png" alt-text="Diagram that shows the process of performing a rolling upgrade with MaxSurge."::: |
| 61 | + |
| 62 | +### In place upgrades |
| 63 | + |
| 64 | +Rolling upgrades with MaxSurge disabled performs upgrades in place. Depending on the type of upgrade, the virtual machines may not be available for traffic during the upgrade process. This may reduce your scale set capacity during the upgrade process but doesn't consume any extra quota. |
| 65 | + |
| 66 | +:::image type="content" source="./media/upgrade-policy/in-place-upgrade.png" alt-text="Diagram that shows the process of performing a rolling upgrade without MaxSurge."::: |
| 67 | + |
| 68 | + |
| 69 | +## Configure rolling upgrades with MaxSurge |
| 70 | +Enabling or disabling MaxSurge can be done during or after scale set provisioning. When using a rolling upgrade policy, the scale set must also use an [Application Health Extension](virtual-machine-scale-sets-health-extension.md) or a [health probe](../load-balancer/load-balancer-custom-probe-overview.md). It's suggested to create the scale set with a manual upgrade policy and update the policy to rolling after successfully confirming the application health is being properly reported. |
| 71 | + |
| 72 | + |
| 73 | + |
| 74 | + |
| 75 | +### [Portal](#tab/portal) |
| 76 | + |
| 77 | +Select the Virtual Machine Scale Set you want to change the upgrade policy for. In the menu under **Settings**, select **Upgrade Policy** and from the drop-down menu, select **Rolling - Upgrades roll out in batches with optional pause**. |
| 78 | + |
| 79 | +:::image type="content" source="../virtual-machine-scale-sets/media/upgrade-policy/rolling-upgrade-policy-portal.png" alt-text="Screenshot showing updating the upgrade policy and enabling MaxSurge in the Azure portal."::: |
| 80 | + |
| 81 | +### [CLI](#tab/cli) |
| 82 | +Update an existing Virtual Machine Scale Set using [az vmss update](/cli/azure/vmss#az-vmss-update). |
| 83 | + |
| 84 | +```azurecli-interactive |
| 85 | +az vmss update \ |
| 86 | + --name myScaleSet \ |
| 87 | + --resource-group myResourceGroup \ |
| 88 | + --set upgradePolicy.mode=Rolling \ |
| 89 | + --max-batch-instance-percent 10 \ |
| 90 | + --max-unhealthy-instance-percent 20 \ |
| 91 | + --max-unhealthy-upgraded-instance-percent 20 \ |
| 92 | + --prioritize-unhealthy-instances true \ |
| 93 | + --pause-time-between-batches PT2S \ |
| 94 | + --max-surge true |
| 95 | +
|
| 96 | +``` |
| 97 | + |
| 98 | +### [PowerShell](#tab/powershell) |
| 99 | +Update an existing Virtual Machine Scale Set using [Update-AzVmss](/powershell/module/az.compute/update-azvmss). |
| 100 | + |
| 101 | +```azurepowershell-interactive |
| 102 | +$vmss = Get-AzVmss -ResourceGroupName "myResourceGroup" -VMScaleSetName "myScaleSet" |
| 103 | +
|
| 104 | +Set-AzVmssRollingUpgradePolicy ` |
| 105 | + -VirtualMachineScaleSet $VMSS ` |
| 106 | + -MaxBatchInstancePercent 20 ` |
| 107 | + -MaxUnhealthyInstancePercent 20 ` |
| 108 | + -MaxUnhealthyUpgradedInstancePercent 20 ` |
| 109 | + -PauseTimeBetweenBatches "PT30S" ` |
| 110 | + -EnableCrossZoneUpgrade True ` |
| 111 | + -PrioritizeUnhealthyInstance True ` |
| 112 | + -MaxSurge True |
| 113 | +
|
| 114 | +Update-Azvmss -ResourceGroupName "myResourceGroup" ` |
| 115 | + -Name "myScaleSet" ` |
| 116 | + -UpgradePolicyMode "Rolling" ` |
| 117 | + -VirtualMachineScaleSet $vmss |
| 118 | +``` |
| 119 | + |
| 120 | +### [ARM Template](#tab/template) |
| 121 | + |
| 122 | +Update the properties section of your ARM template and set the upgrade policy to rolling and various rolling upgrade options. |
| 123 | + |
| 124 | + |
| 125 | +``` ARM Template |
| 126 | +"properties": { |
| 127 | + "singlePlacementGroup": false, |
| 128 | + "upgradePolicy": { |
| 129 | + "mode": "Rolling", |
| 130 | + "rollingUpgradePolicy": { |
| 131 | + "maxBatchInstancePercent": 20, |
| 132 | + "maxUnhealthyInstancePercent": 20, |
| 133 | + "maxUnhealthyUpgradedInstancePercent": 20, |
| 134 | + "pauseTimeBetweenBatches": "PT2S", |
| 135 | + "MaxSurge": "true" |
| 136 | + } |
| 137 | + } |
| 138 | + } |
| 139 | +``` |
| 140 | +--- |
| 141 | +## Next steps |
| 142 | +To learn more about upgrades for Virtual Machine Scale Sets, see [configure rolling upgrade policy](./virtual-machine-scale-sets-configure-rolling-upgrades.md). |
| 143 | + |
0 commit comments