Skip to content

Commit 5ff7e42

Browse files
authored
Merge pull request #294655 from kgremban/feb13-aioupgrade
Upgrade update
2 parents ba430a0 + 7ae290c commit 5ff7e42

File tree

7 files changed

+43
-41
lines changed

7 files changed

+43
-41
lines changed

articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ Cloud resources:
3636

3737
Development resources:
3838

39-
* Azure CLI installed on your development machine. This scenario requires Azure CLI version 2.64.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
39+
* Azure CLI installed on your development machine. This scenario requires Azure CLI version 2.53.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
4040

4141
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
4242

articles/iot-operations/deploy-iot-ops/howto-enable-secure-settings.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This article provides instructions for enabling secure settings if you didn't do
1919

2020
* An Azure IoT Operations instance deployed with test settings. For example, you chose **Test Settings** when following the instructions in [Deploy Azure IoT Operations to an Arc-enabled Kubernetes cluster](howto-deploy-iot-operations.md).
2121

22-
* Azure CLI installed on your development machine. This scenario requires Azure CLI version 2.64.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
22+
* Azure CLI installed on your development machine. This scenario requires Azure CLI version 2.53.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
2323

2424
* The latest version of the **connectedk8s** extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
2525

articles/iot-operations/deploy-iot-ops/howto-manage-update-uninstall.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ Use the Azure CLI and Azure portal to manage, uninstall, or update Azure IoT Ope
1818

1919
* An Azure IoT Operations instance deployed to a cluster. For more information, see [Deploy Azure IoT Operations](./howto-deploy-iot-operations.md).
2020

21-
* Azure CLI installed on your development machine. This scenario requires Azure CLI version 2.64.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
21+
* Azure CLI installed on your development machine. This scenario requires Azure CLI version 2.53.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
2222

2323
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
2424

articles/iot-operations/deploy-iot-ops/howto-prepare-cluster.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -32,7 +32,7 @@ To prepare an Azure Arc-enabled Kubernetes cluster, you need:
3232
az group create --location <REGION> --resource-group <RESOURCE_GROUP> --subscription <SUBSCRIPTION_ID>
3333
```
3434

35-
* Azure CLI version 2.64.0 or newer installed on your cluster machine. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
35+
* Azure CLI version 2.53.0 or newer installed on your cluster machine. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [How to install the Azure CLI](/cli/azure/install-azure-cli).
3636

3737
* The latest version of the **connectedk8s** extension for Azure CLI:
3838

Lines changed: 38 additions & 34 deletions
Original file line numberDiff line numberDiff line change
@@ -1,22 +1,22 @@
11
---
2-
title: Upgrade or rollback
3-
description: Upgrade an Azure IoT Operations instance or rollback to a previous version.
2+
title: Upgrade versions
3+
description: Upgrade an Azure IoT Operations instance using the Azure portal or CLI.
44
author: kgremban
55
ms.author: kgremban
66
ms.topic: how-to
77
ms.custom: devx-track-azurecli
8-
ms.date: 01/31/2025
8+
ms.date: 02/14/2025
99

1010
#CustomerIntent: As an OT professional, I want to manage Azure IoT Operations instances.
1111
---
1212

13-
# Upgrade or downgrade between versions
13+
# Upgrade versions
1414

15-
Upgrade an Azure IoT Operations deployment to a newer version or rollback to a previous version. Azure IoT Operations supports upgrade and rollback from version 1.0.x onwards. There is no support for upgrading from any preview version of Azure IoT Operations to any generally available (GA) version.
15+
Upgrade an Azure IoT Operations deployment to a newer version. Azure IoT Operations supports upgrade from version 1.0.x onwards. There is no support for upgrading from any preview version of Azure IoT Operations to any generally available (GA) version.
1616

1717
## Prerequisites
1818

19-
* Azure CLI. This scenario requires Azure CLI version 2.64.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [Get started with Azure CLI](/cli/azure/get-started-with-azure-cli).
19+
* Azure CLI. This scenario requires Azure CLI version 2.53.0 or higher. Use `az --version` to check your version and `az upgrade` to update if necessary. For more information, see [Get started with Azure CLI](/cli/azure/get-started-with-azure-cli).
2020

2121
* The Azure IoT Operations extension for Azure CLI. Use the following command to add the extension or update it to the latest version:
2222

@@ -26,13 +26,9 @@ Upgrade an Azure IoT Operations deployment to a newer version or rollback to a p
2626

2727
## Understand upgrade support
2828

29-
Upgrade and rollback are supported between N+3 or N-3 minor versions of Azure IoT Operations, or between any patch versions of the same minor version. The following table provides examples:
29+
You can upgrade an existing Azure IoT Operations instance to any patch of the same minor version, or to the next minor version.
3030

31-
| Version | Upgrade range | Downgrade range |
32-
| ------- | ------------- | --------------- |
33-
| 1.0.0 | 1.0.1 through 1.3.x | None |
34-
| 1.1.0 | 1.1.1 through 1.4.x | 1.0.x |
35-
| 1.4.4 | 1.4.5 through 1.7.x | 1.1.x through 1.4.3 |
31+
Azure IoT Operations doesn't support downgrading between versions. To move to an older version, uninstall Azure IoT Operations and reinstall the desired version.
3632

3733
## Upgrade
3834

@@ -45,13 +41,26 @@ You can't upgrade from a preview installation to a GA version. To move to versio
4541
If your Azure IoT Operations deployment is eligible for an upgrade, the Azure portal displays an **Upgrade** option. If you don't see the option to upgrade, then your deployment is on the latest version.
4642

4743
1. In the [Azure portal](https://portal.azure.com), navigate to your Azure IoT Operations instance.
44+
4845
1. Select **Upgrade** on the **Overview** page of your instance.
4946

5047
:::image type="content" source="./media/howto-upgrade/instance-upgrade.png" alt-text="Screenshot that shows the upgrade button enabled in the Azure portal.":::
5148

49+
1. You need to use the latest version of the Azure IoT Operations CLI extension to get the latest version of Azure IoT Operations. If you didn't update the extension as part of the prerequisites, do so now.
50+
51+
```azurecli
52+
az extension add --upgrade --name azure-iot-ops
53+
```
54+
55+
Or, if you want to upgrade your deployment to a newer version but not the latest, set the CLI extension version to the one associated with your desired Azure IoT Operations versions in [IoT Operations versions](https://aka.ms/aio-versions).
56+
57+
```azurecli
58+
az extension add --upgrade --name azure-iot-ops --version <VERSION_NUMBER>
59+
```
60+
5261
1. The portal presents the Azure CLI command to upgrade your instance, prepopulated with your subscription, resource group, and instance details. Select the copy icon next to the CLI command.
5362

54-
1. Run the copied `az iot ops upgrade` command in any environment where you have the Azure CLI installed.
63+
1. Run the copied `az iot ops upgrade` command.
5564

5665
1. After the upgrade command completes successfully, refresh your instance to see the changes.
5766

@@ -63,34 +72,29 @@ Use the [az iot ops upgrade](/cli/azure/iot/ops#az-iot-ops-upgrade) command to u
6372

6473
The upgrade command evaluates the entire Azure IoT Operations deployment for available updates, including the arc extensions that are installed in the `az iot ops init` command as well as the Azure IoT Operations instance.
6574

66-
```azurecli
67-
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME>
68-
```
75+
Use the following steps to upgrade your deployment to the latest version:
6976

70-
The CLI outputs a table of the components, if any, that have available upgrades. Enter `Y` to continue with the upgrade.
77+
1. You need to use the latest version of the Azure IoT Operations CLI extension to get the latest version of Azure IoT Operations. If you didn't update the extension as part of the prerequisites, do so now.
7178

72-
To upgrade to a specific version of a component, specify the version number in the parameters. For example:
79+
```azurecli
80+
az extension add --upgrade --name azure-iot-ops
81+
```
7382

74-
```azurecli
75-
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME> --acs-version 2.2.3
76-
```
83+
1. Run `az iot ops upgrade`
7784

78-
You can find the supported component versions and release train information in the **azure-iot-operations-enablement.json** file included in any given [Azure IoT Operations release](https://github.com/Azure/azure-iot-operations/releases).
85+
```azurecli
86+
az iot ops upgrade --resource-group <RESOURCE_GROUP_NAME> --name <INSTANCE_NAME>
87+
```
7988

80-
---
89+
1. The CLI outputs a table of the components that have available upgrades. Enter `Y` to continue with the upgrade.
8190

82-
## Downgrade
91+
If you want to upgrade to a specific version of Azure IoT Operations that isn't the latest, use the related CLI extension version. Each version of Azure IoT Operations maps to a version of the Azure IoT Operations CLI extension.
8392

84-
### [Azure portal](#tab/portal)
93+
Refer to [IoT Operations versions](https://aka.ms/aio-versions) to find the CLI extension version associated with the Azure IoT Operations version that you want. Then, upgrade the CLI extension:
8594

86-
The Azure portal doesn't offer a version downgrade option. Instead, use the Azure CLI.
87-
88-
### [Azure CLI](#tab/cli)
89-
90-
Use the [az iot ops upgrade](/cli/azure/iot/ops#az-iot-ops-upgrade) command to roll back an existing Azure IoT Operations instance to a previous version.
91-
92-
In the upgrade command, you can specify a component version up to three minor versions older that the latest.
93-
94-
You can find the supported component versions and release train information in the **azure-iot-operations-enablement.json** file included in any given [Azure IoT Operations release](https://github.com/Azure/azure-iot-operations/releases).
95+
```azurecli
96+
az extension add --upgrade --name azure-iot-ops --version <VERSION_NUMBER>
97+
```
9598

9699
---
100+

articles/iot-operations/troubleshoot/known-issues.md

Lines changed: 0 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -27,8 +27,6 @@ This article lists the known issues for Azure IoT Operations.
2727

2828
- If you deploy Azure IoT Operations in GitHub Codespaces, shutting down and restarting the Codespace causes a `This codespace is currently running in recovery mode due to a configuration error.` issue. Currently, there's no workaround for the issue. If you need a cluster that supports shutting down and restarting, choose one of the options in [Prepare your Azure Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-prepare-cluster.md).
2929

30-
- Downgrading the Azure Container Storage extension from 2.2.3 to 2.2.2 causes a logging loop that leads to high CPU usage warnings. To resolve, upgrade the extension back to 2.2.3. For more information, see [Upgrade or downgrade between versions](../deploy-iot-ops/howto-upgrade.md).
31-
3230
## MQTT broker
3331

3432
- Sometimes, the MQTT broker's memory usage can become unexpectedly high due to internal certificate rotation retries. This results in errors like 'failed to connect trace upload task to diagnostics service endpoint' in the logs. The issue is expected to be addressed in the next patch update. In the meantime, as a workaround, restart each broker pod one by one (including the diagnostic service, probe, and authentication service), making sure each backend recovers before moving on. Alternatively, [re-deploy Azure IoT Operations with higher internal certificate duration](../manage-mqtt-broker/howto-encrypt-internal-traffic.md#internal-certificates), `1500h` or more.

articles/iot-operations/troubleshoot/troubleshoot.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -17,7 +17,7 @@ This article contains troubleshooting tips for Azure IoT Operations.
1717

1818
For general deployment and configuration troubleshooting, you can use the Azure CLI IoT Operations *check* and *support* commands.
1919

20-
[Azure CLI version 2.52.0 or higher](/cli/azure/install-azure-cli) is required and the [Azure IoT Operations extension](/cli/azure/iot/ops) installed.
20+
[Azure CLI version 2.53.0 or higher](/cli/azure/install-azure-cli) is required and the [Azure IoT Operations extension](/cli/azure/iot/ops) installed.
2121

2222
- Use [az iot ops check](/cli/azure/iot/ops#az-iot-ops-check) to evaluate Azure IoT Operations service deployment for health, configuration, and usability. The *check* command can help you find problems in your deployment and configuration.
2323

0 commit comments

Comments
 (0)