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/aks/auto-upgrade-node-os-image.md
+60-13Lines changed: 60 additions & 13 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -33,17 +33,63 @@ The following upgrade channels are available. You're allowed to choose one of th
33
33
|`SecurityPatch`|This channel is in preview and requires enabling the feature flag `NodeOsUpgradeChannelPreview`. Refer to the prerequisites section for details. AKS regularly updates the node's virtual hard disk (VHD) with patches from the image maintainer labeled "security only." There might be disruptions when the security patches are applied to the nodes. When the patches are applied, the VHD is updated and existing machines are upgraded to that VHD, honoring maintenance windows and surge settings. This option incurs the extra cost of hosting the VHDs in your node resource group. If you use this channel, Linux [unattended upgrades][unattended-upgrades] are disabled by default.|Azure Linux doesn't support this channel on GPU-enabled VMs. `SecurityPatch` works on patch versions that are deprecated, so long as the minor Kubernetes version is still supported.|
34
34
|`NodeImage`|AKS updates the nodes with a newly patched VHD containing security fixes and bug fixes on a weekly cadence. The update to the new VHD is disruptive, following maintenance windows and surge settings. No extra VHD cost is incurred when choosing this option. If you use this channel, Linux [unattended upgrades][unattended-upgrades] are disabled by default. Node image upgrades support patch versions that are deprecated, so long as the minor Kubernetes version is still supported.|
35
35
36
-
To set the node OS auto-upgrade channel when creating a cluster, use the *node-os-upgrade-channel* parameter, similar to the following example.
36
+
## Set the node OS auto-upgrade channel on a new cluster
37
37
38
-
```azurecli-interactive
39
-
az aks create --resource-group myResourceGroup --name myAKSCluster --node-os-upgrade-channel SecurityPatch
40
-
```
38
+
### [Azure CLI](#tab/azure-cli)
41
39
42
-
To set the node os auto-upgrade channel on existing cluster, update the *node-os-upgrade-channel* parameter, similar to the following example.
40
+
* Set the node OS auto-upgrade channel on a new cluster using the [`az aks create`][az-aks-create] command with the `--node-os-upgrade-channel` parameter. The following example sets the node OS auto-upgrade channel to `SecurityPatch`.
43
41
44
-
```azurecli-interactive
45
-
az aks update --resource-group myResourceGroup --name myAKSCluster --node-os-upgrade-channel SecurityPatch
46
-
```
42
+
```azurecli-interactive
43
+
az aks create --resource-group myResourceGroup --name myAKSCluster --node-os-upgrade-channel SecurityPatch
44
+
```
45
+
46
+
### [Azure portal](#tab/azure-portal)
47
+
48
+
1. In the Azure portal, select **Create a resource** > **Containers** > **Azure Kubernetes Service (AKS)**.
49
+
2. In the **Basics** tab, under **Cluster details**, select the desired channel type from the **Node security channel type** dropdown.
50
+
51
+
:::image type="content" source="./media/auto-upgrade-node-os-image/set-nodeimage-channel-portal.png" alt-text="A screenshot of the Azure portal showing the node security channel type option in the Basics tab of the AKS cluster creation page.":::
52
+
53
+
3. Select **Security channel scheduler** and choose the desired maintenance window using the [Planned Maintenance feature](./planned-maintenance.md). We recommend selecting the default option **Every week on Sunday (recommended)**.
54
+
55
+
:::image type="content" source="./media/auto-upgrade-node-os-image/set-nodeimage-maintenance-window-portal.png" alt-text="A screenshot of the Azure portal showing the security channel scheduler option in the Basics tab of the AKS cluster creation page.":::
56
+
57
+
4. Complete the remaining steps to create the cluster.
58
+
59
+
---
60
+
61
+
## Set the node OS auto-upgrade channel on an existing cluster
62
+
63
+
### [Azure CLI](#tab/azure-cli)
64
+
65
+
* Set the node os auto-upgrade channel on an existing cluster using the [`az aks update`][az-aks-update] command with the `--node-os-upgrade-channel` parameter. The following example sets the node OS auto-upgrade channel to `SecurityPatch`.
66
+
67
+
```azurecli-interactive
68
+
az aks update --resource-group myResourceGroup --name myAKSCluster --node-os-upgrade-channel SecurityPatch
69
+
```
70
+
71
+
### [Azure portal](#tab/azure-portal)
72
+
73
+
1. In the Azure portal, navigate to your AKS cluster.
74
+
2. In the **Settings** section, select **Cluster configuration**.
75
+
3. Under **Security updates**, select the desired channel type from the **Node security channel type** dropdown.
76
+
77
+
:::image type="content" source="./media/auto-upgrade-node-os-image/set-nodeimage-channel-portal-existing.png" alt-text="A screenshot of the Azure portal showing the node security channel type option in the Cluster configuration page of an existing AKS cluster.":::
78
+
79
+
4. For **Security channel scheduler**, select **Add schedule**.
80
+
5. On the **Add maintenance schedule** page, configure the following maintenance window settings using the [Planned Maintenance feature](./planned-maintenance.md):
81
+
82
+
* **Repeats**: Select the desired frequency for the maintenance window. We recommend selecting **Weekly**.
83
+
* **Frequency**: Select the desired day of the week for the maintenance window. We recommend selecting **Sunday**.
84
+
* **Maintenance start date**: Select the desired start date for the maintenance window.
85
+
* **Maintenance start time**: Select the desired start time for the maintenance window.
86
+
* **UTC offset**: Select the desired UTC offset for the maintenance window. If not set, the default is **+00:00**.
87
+
88
+
:::image type="content" source="./media/auto-upgrade-node-os-image/set-nodeimage-maintenance-window-portal-existing.png" alt-text="A screenshot of the Azure portal showing the maintenance schedule configuration options in the Add maintenance schedule page of an existing AKS cluster.":::
89
+
90
+
6. Select **Save** > **Apply**.
91
+
92
+
---
47
93
48
94
## Update ownership and schedule
49
95
@@ -60,12 +106,11 @@ The default cadence means there's no planned maintenance window applied.
60
106
61
107
## SecurityPatch channel requirements
62
108
63
-
To use the `SecurityPatch` channel, your cluster must support these requirements.
64
-
- Must be using API version `11-02-preview` or later
65
-
66
-
- If using Azure CLI, the `aks-preview` CLI extension version `0.5.166` or later must be installed
109
+
To use the `SecurityPatch` channel, your cluster must support these requirements:
67
110
68
-
- The `NodeOsUpgradeChannelPreview` feature flag must be enabled on your subscription
111
+
* Must be using API version `11-02-preview` or later
112
+
* If using Azure CLI, the `aks-preview` CLI extension version `0.5.166` or later must be installed
113
+
* The `NodeOsUpgradeChannelPreview` feature flag must be enabled on your subscription
69
114
70
115
### Register NodeOsUpgradeChannelPreview
71
116
@@ -168,6 +213,8 @@ For a detailed discussion of upgrade best practices and other considerations, se
0 commit comments