|
1 | 1 | ---
|
2 |
| -title: "Upgrading Azure Arc-enabled Kubernetes agents" |
| 2 | +title: "Upgrade Azure Arc-enabled Kubernetes agents" |
3 | 3 | services: azure-arc
|
4 | 4 | ms.service: azure-arc
|
5 |
| -ms.date: 03/03/2021 |
| 5 | +ms.date: 08/02/2022 |
6 | 6 | ms.topic: how-to
|
7 | 7 | description: "Control agent upgrades for Azure Arc-enabled Kubernetes"
|
8 |
| -keywords: "Kubernetes, Arc, Azure, K8s, containers, agent, upgrade" |
| 8 | +keywords: "Kubernetes, Arc, Azure, K8s, containers, agent, update, auto upgrade" |
9 | 9 | ---
|
10 | 10 |
|
11 |
| -# Upgrading Azure Arc-enabled Kubernetes agents |
| 11 | +# Upgrade Azure Arc-enabled Kubernetes agents |
12 | 12 |
|
13 |
| -Azure Arc-enabled Kubernetes provides auto-upgrade and manual-upgrade capabilities for its agents. If use disable auto-upgrade and instead rely on manual-upgrade, version support policy is applicable for Arc agents and the underlying Kubernetes cluster. |
| 13 | +Azure Arc-enabled Kubernetes provides both automatic and manual upgrade capabilities for its agents. If you disable automatic upgrade and instead rely on manual upgrade, a [version support policy](#version-support-policy) applies for Arc agents and the underlying Kubernetes clusters. |
14 | 14 |
|
15 |
| -## Toggle auto-upgrade on or off when connecting cluster to Azure Arc |
| 15 | +## Toggle automatic upgrade on or off when connecting cluster to Azure Arc |
16 | 16 |
|
17 |
| -Azure Arc-enabled Kubernetes provides its agents with out- of-the-box auto-upgrade capabilities. |
| 17 | +By default, Azure Arc-enabled Kubernetes provides its agents with out-of-the-box automatic upgrade capabilities. |
18 | 18 |
|
19 |
| -The following command connects a cluster to Azure Arc with auto-upgrade **enabled**: |
| 19 | +The following command connects a cluster to Azure Arc with automatic upgrade enabled: |
20 | 20 |
|
21 | 21 | ```azurecli
|
22 | 22 | az connectedk8s connect --name AzureArcTest1 --resource-group AzureArcTest
|
23 | 23 | ```
|
24 | 24 |
|
25 |
| -With auto-upgrade enabled, the agent polls Azure hourly for availability of a newer version of agents. If the agent finds an available newer version, it triggers a Helm chart upgrade for the Azure Arc agents. |
| 25 | +With automatic upgrade enabled, the agent polls Azure hourly to check for a newer version. When a newer version becomes available, it triggers a Helm chart upgrade for the Azure Arc agents. |
26 | 26 |
|
27 |
| -To opt-out of auto-upgrade, specify the `--disable-auto-upgrade` parameter while connecting the cluster to Azure Arc. The following command connects a cluster to Azure Arc with auto-upgrade **disabled**: |
| 27 | +To opt out of automatic upgrade, specify the `--disable-auto-upgrade` parameter while connecting the cluster to Azure Arc. |
| 28 | + |
| 29 | +The following command connects a cluster to Azure Arc with auto-upgrade disabled: |
28 | 30 |
|
29 | 31 | ```azurecli
|
30 | 32 | az connectedk8s connect --name AzureArcTest1 --resource-group AzureArcTest --disable-auto-upgrade
|
31 | 33 | ```
|
32 | 34 |
|
33 | 35 | > [!TIP]
|
34 |
| -> If you plan to disable auto-upgrade, please refer to the [version support policy](#version-support-policy) for Azure Arc-enabled Kubernetes. |
| 36 | +> If you plan to disable automatic upgrade, be aware of the [version support policy](#version-support-policy) for Azure Arc-enabled Kubernetes. |
| 37 | +
|
| 38 | +## Toggle automatic upgrade on or off after connecting cluster to Azure Arc |
35 | 39 |
|
36 |
| -## Toggle auto-upgrade on/off after connecting cluster to Azure Arc |
| 40 | +After you connect a cluster to Azure Arc, you can change the automatic upgrade selection by using the `az connectedk8s update` command and setting `--auto-upgrade` to either true or false. |
37 | 41 |
|
38 |
| -After you connect a cluster to Azure Arc, you can toggle the auto-upgrade capability with the `az connectedk8s update` command, as shown below: |
| 42 | +The following command turns automatic upgrade off for a connected cluster: |
39 | 43 |
|
40 | 44 | ```azurecli
|
41 | 45 | az connectedk8s update --name AzureArcTest1 --resource-group AzureArcTest --auto-upgrade false
|
42 | 46 | ```
|
43 | 47 |
|
44 | 48 | ## Manually upgrade agents
|
45 | 49 |
|
46 |
| -If you have disabled auto-upgrade for agents, you can manually initiate upgrades for these agents using the `az connectedk8s upgrade` command as shown below: |
47 |
| - |
48 |
| -```azurecli |
49 |
| -az connectedk8s upgrade -g AzureArcTest1 -n AzureArcTest --agent-version 1.1.0 |
50 |
| -``` |
51 |
| - |
52 |
| -Azure Arc-enabled Kubernetes follows the standard [semantic versioning scheme](https://semver.org/) of `MAJOR.MINOR.PATCH` for versioning its agents. |
| 50 | +If you've disabled automatic upgrade, you can manually initiate upgrades for the agents by using the `az connectedk8s upgrade` command. When doing so, you must specify the version to which you want to upgrade. |
53 | 51 |
|
54 |
| -Each number in the version indicates general compatibility with the previous version: |
| 52 | +Azure Arc-enabled Kubernetes follows the standard [semantic versioning scheme](https://semver.org/) of `MAJOR.MINOR.PATCH` for versioning its agents. Each number in the version indicates general compatibility with the previous version: |
55 | 53 |
|
56 | 54 | * **Major versions** change when there are incompatible API updates or backwards-compatibility may be broken.
|
57 | 55 | * **Minor versions** change when functionality changes are backwards-compatible to other minor releases.
|
58 | 56 | * **Patch versions** change when backwards-compatible bug fixes are made.
|
59 | 57 |
|
60 |
| -## Version support policy |
| 58 | +While the schedule may vary, a new minor version of Azure Arc-enabled Kubernetes agents is released approximately once per month. |
61 | 59 |
|
62 |
| -When you create support issues, Azure Arc-enabled Kubernetes practices the following version support policy: |
| 60 | +The following command upgrades the agent to version 1.1.0: |
63 | 61 |
|
64 |
| -* Azure Arc-enabled Kubernetes agents have a support window of "N-2" where 'N' is the latest minor release of agents. |
65 |
| - * For example, if Azure Arc-enabled Kubernetes introduces 0.28.a today, versions 0.28.a, 0.28.b, 0.27.c, 0.27.d, 0.26.e, and 0.26.f are supported by Azure Arc. |
| 62 | +```azurecli |
| 63 | +az connectedk8s upgrade -g AzureArcTest1 -n AzureArcTest --agent-version 1.1.0 |
| 64 | +``` |
66 | 65 |
|
67 |
| -* Kubernetes clusters connecting to Azure Arc have a support window of "N-2", where 'N' is the latest stable minor release of [upstream Kubernetes](https://github.com/kubernetes/kubernetes/releases). |
68 |
| - * For example, if Kubernetes introduces 1.20.a today, versions 1.20.a, 1.20.b, 1.19.c, 1.19.d, 1.18.e, and 1.18.f are supported. |
| 66 | +## Version support policy |
69 | 67 |
|
70 |
| -### How often are minor version releases of Azure Arc-enabled Kubernetes available? |
| 68 | +When you [create support requests](/azure/azure-portal/supportability/how-to-create-azure-support-request) for Azure Arc-enabled Kubernetes, the following version support policy applies: |
71 | 69 |
|
72 |
| -One minor version of Azure Arc-enabled Kubernetes agents is released approximately once a month. |
| 70 | +* Azure Arc-enabled Kubernetes agents have a support window of "N-2", where 'N' is the latest minor release of agents. |
| 71 | + * For example, if Azure Arc-enabled Kubernetes introduces 0.28.a today, versions 0.28.a, 0.28.b, 0.27.c, 0.27.d, 0.26.e, and 0.26.f are supported. |
73 | 72 |
|
74 |
| -### What happens if I'm using an agent version or a Kubernetes version outside the official support window? |
| 73 | +* Kubernetes clusters connecting to Azure Arc have a support window of "N-2", where 'N' is the latest stable minor release of [upstream Kubernetes](https://github.com/kubernetes/kubernetes/releases). |
| 74 | + * For example, if Kubernetes introduces 1.20.a today, versions 1.20.a, 1.20.b, 1.19.c, 1.19.d, 1.18.e, and 1.18.f are supported. |
75 | 75 |
|
76 |
| -'Outside of Support' means that the versions you're running are outside the "N-2" supported versions of agents and upstream Kubernetes clusters. To proceed with the support issue, you'll be asked to upgrade the cluster and the agents to a supported version. |
| 76 | +If you create a support request and are using a version that is outside of the support policy (older than the "N-2" supported versions of agents and upstream Kubernetes clusters), you'll be asked to upgrade the clusters and agents to a supported version. |
77 | 77 |
|
78 | 78 | ## Next steps
|
79 | 79 |
|
|
0 commit comments