Skip to content

Commit 1077e89

Browse files
committed
New: upgrade/rollback
1 parent 60bd6d2 commit 1077e89

File tree

4 files changed

+60
-37
lines changed

4 files changed

+60
-37
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
@@ -48,7 +48,7 @@ A cluster host:
4848

4949
* Have an Azure Arc-enabled Kubernetes cluster with the custom location and workload identity features enabled. If you don't have one, follow the steps in [Prepare your Azure Arc-enabled Kubernetes cluster](./howto-prepare-cluster.md).
5050

51-
If you deployed Azure IoT Operations to your cluster previously, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](./howto-manage-update-uninstall.md#upgrade).
51+
If you deployed Azure IoT Operations to your cluster previously, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](./howto-manage-update-uninstall.md#uninstall).
5252

5353
* (Optional) Prepare your cluster for observability before deploying Azure IoT Operations: [Configure observability](../configure-observability-monitoring/howto-configure-observability.md).
5454

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

Lines changed: 0 additions & 36 deletions
Original file line numberDiff line numberDiff line change
@@ -186,39 +186,3 @@ az iot ops delete --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --inc
186186
```
187187

188188
---
189-
190-
## Upgrade
191-
192-
Azure IoT Operations supports upgrading instances to new versions as they're released.
193-
194-
You can't upgrade from a preview installation to a GA version.
195-
196-
> [!NOTE]
197-
> There's a known issue with upgrading Azure IoT Operations if the MQTT broker only has one backend replica. Only upgrade Azure IoT Operations if the Broker has more than one backend replica.
198-
199-
### [Azure portal](#tab/portal)
200-
201-
1. In the [Azure portal](https://portal.azure.com), go to the resource group that contains your Azure IoT Operations instance, or search for and select **Azure IoT Operations**.
202-
203-
1. Select the name of your Azure IoT Operations instance.
204-
205-
1. On the **Overview** page of your instance, select **Upgrade**.
206-
207-
1. The **Upgrade Azure IoT Operations** wizard prompts you to make sure you have the latest version for the Azure IoT Operations CLI extension. Copy and run the provided `az extension add` command.
208-
209-
1. Update to the latest version of Azure IoT Operations instance. Copy and run the provided `az iot ops upgrade` command.
210-
211-
1. Once the upgrade command completes successfully, you can exit the wizard and refresh your instance page.
212-
213-
### [Azure CLI](#tab/cli)
214-
215-
Use the `az iot ops upgrade` command to upgrade an Azure IoT Operations deployment. This command:
216-
217-
* Upgrades Azure Arc extensions on your cluster.
218-
* Upgrades the Azure IoT Operations instance.
219-
220-
```azurecli
221-
az iot ops upgrade --resource-group <RESOURCE_GROUP> --name <INSTANCE_NAME>
222-
```
223-
224-
---
Lines changed: 57 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,57 @@
1+
---
2+
title: Upgrade or rollback
3+
description: Upgrade an Azure IoT Operations instance or rollback to a previous version.
4+
author: kgremban
5+
ms.author: kgremban
6+
ms.topic: how-to
7+
ms.custom: devx-track-azurecli
8+
ms.date: 11/11/2024
9+
10+
#CustomerIntent: As an OT professional, I want to manage Azure IoT Operations instances.
11+
---
12+
13+
# Upgrade or rollback between versions
14+
15+
Upgrade an Azure IoT Operations instance 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 version.
16+
17+
>[!NOTE]
18+
>Currently, Azure IoT Operations has only one generally available version. Upgrade and rollback will be available once there are additional versions to upgrade or rollback between.
19+
20+
## Understand upgrade support
21+
22+
Upgrade and rollback are supported between N+2 or N-2 minor versions of Azure IoT Operations. The following table provides examples:
23+
24+
| Current version | Upgrade range | Rollback range |
25+
| --------------- | ------------- | -------------- |
26+
| 1.0.0 | 1.0.1 through 1.2.x | None |
27+
| 1.1.0 | 1.1.1 through 1.3.x | 1.0.x |
28+
29+
Upgrade and rollback are supported between minor versions and patches only.
30+
31+
## Upgrade
32+
33+
Azure IoT Operations supports upgrading instances to new versions as they're released.
34+
35+
You can't upgrade from a preview installation to a GA version. To move to version 1.0.x, [uninstall Azure IoT Operations](howto-manage-update-uninstall.md#uninstall) and reinstall the new version.
36+
37+
> [!NOTE]
38+
> There's a known issue with upgrading Azure IoT Operations if the MQTT broker only has one backend replica. Only upgrade Azure IoT Operations if the Broker has more than one backend replica.
39+
40+
## Upgrade between preview versions
41+
42+
Upgrade is supported between version 0.7.x and 0.8.x. If you have a 0.7.x cluster and want to test the upgrade feature, you can do so using the 0.8.x version of the CLI extension.
43+
44+
1. Set your CLI extension to use the **0.8.0b1** version.
45+
46+
```azurecli
47+
az extension add --upgrade azure-iot-ops --version 0.8.0b1
48+
```
49+
50+
1. Use the `az iot ops upgrade` command to upgrade an Azure IoT Operations deployment. This command:
51+
52+
* Upgrades Azure Arc extensions on your cluster.
53+
* Upgrades the Azure IoT Operations instance.
54+
55+
```azurecli
56+
az iot ops upgrade --resource-group <RESOURCE_GROUP> --name <INSTANCE_NAME>
57+
```

articles/iot-operations/toc.yml

Lines changed: 2 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -23,6 +23,8 @@ items:
2323
href: deploy-iot-ops/howto-deploy-iot-operations.md
2424
- name: Manage, update, or uninstall
2525
href: deploy-iot-ops/howto-manage-update-uninstall.md
26+
- name: Upgrade or rollback versions
27+
href: deploy-iot-ops/howto-upgrade.md
2628
- name: Enable secure settings
2729
href: deploy-iot-ops/howto-enable-secure-settings.md
2830
- name: Secure your deployment

0 commit comments

Comments
 (0)