Skip to content

Commit 5c1d153

Browse files
Merge pull request #277214 from kgremban/jun4-aioupdate
Clarify AIO update steps
2 parents b23d819 + 86bbaeb commit 5c1d153

File tree

3 files changed

+40
-14
lines changed

3 files changed

+40
-14
lines changed

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

Lines changed: 35 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -6,7 +6,7 @@ ms.author: kgremban
66
ms.subservice: orchestrator
77
ms.topic: how-to
88
ms.custom: ignite-2023, devx-track-azurecli
9-
ms.date: 05/15/2024
9+
ms.date: 06/06/2024
1010

1111
#CustomerIntent: As an OT professional, I want to deploy Azure IoT Operations to a Kubernetes cluster.
1212
---
@@ -53,7 +53,7 @@ A cluster host:
5353

5454
* An Azure Arc-enabled Kubernetes cluster. If you don't have one, follow the steps in [Prepare your Azure Arc-enabled Kubernetes cluster](./howto-prepare-cluster.md?tabs=wsl-ubuntu).
5555

56-
If you've already deployed Azure IoT Operations to your cluster, uninstall those resources before continuing. For more information, see [Update a deployment](#update-a-deployment).
56+
If you've already deployed Azure IoT Operations to your cluster, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](#update-azure-iot-operations).
5757

5858
Azure IoT Operations should work on any CNCF-conformant kubernetes cluster. Currently, Microsoft only supports K3s on Ubuntu Linux and WSL, or AKS Edge Essentials on Windows. Using Ubuntu in Windows Subsystem for Linux (WSL) is the simplest way to get a Kubernetes cluster for testing.
5959

@@ -131,11 +131,41 @@ To view your cluster on the Azure portal, use the following steps:
131131
> [!TIP]
132132
> You can run `az iot ops check` to assess health and configurations of deployed AIO workloads. By default, MQ including cloud connectors are assessed and you can [specifiy the service](/cli/azure/iot/ops#az-iot-ops-check-examples) with `--ops-service --svc`.
133133
134-
## Update a deployment
134+
## Uninstall Azure IoT Operations
135135

136-
Currently, there's no support for updating an existing Azure IoT Operations deployment. Instead, start with a clean cluster for a new deployment.
136+
Use the [az iot ops delete](/cli/azure/iot/ops#az-iot-ops-delete) command to delete or uninstall Azure IoT Operations from a cluster. The `delete` command evaluates the Azure IoT Operations related resources on the cluster and presents a tree view of the resources to be deleted. The cluster should be online prior to running.
137137

138-
If you want to delete the Azure IoT Operations deployment on your cluster so that you can redeploy to it, navigate to your cluster on the Azure portal. Select the extensions of the type **microsoft.iotoperations.x** and **microsoft.deviceregistry.assets**, then select **Uninstall**. Keep the secrets provider on your cluster, as that is a prerequisite for deployment and not included in a fresh deployment.
138+
The `delete` command removes:
139+
140+
* Azure IoT Operations extensions
141+
* Azure IoT Operations resource sync rules
142+
* Azure IoT Operations resources
143+
* Associated custom location
144+
145+
```azurecli
146+
az iot ops delete --cluster <CLUSTER_NAME> --resource-group <RESOURCE_GROUP>
147+
```
148+
149+
## Update Azure IoT Operations
150+
151+
Currently, there's no support for updating an existing Azure IoT Operations deployment. Instead, uninstall and redeploy a new version of Azure IoT Operations.
152+
153+
1. Use the [az iot ops delete](/cli/azure/iot/ops#az-iot-ops-delete) command to delete the Azure IoT Operations deployment on your cluster.
154+
155+
```azurecli
156+
az iot ops delete --cluster <CLUSTER_NAME> --resource-group <RESOURCE_GROUP>
157+
```
158+
159+
1. Update the CLI extension to get the latest Azure IoT Operations version.
160+
161+
```azurecli
162+
az extension update --name azure-iot-ops
163+
```
164+
165+
1. Follow the steps in this article to deploy the newest version of Azure IoT Operations to your cluster.
166+
167+
>[!TIP]
168+
>Add the `--ensure-latest` flag to the `az iot ops init` command to check that the latest Azure IoT Operations CLI version is installed and raise an error if an upgrade is available.
139169
140170
## Next steps
141171

articles/iot-operations/get-started/overview-iot-operations.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Azure IoT Operations runs on Arc-enabled Kubernetes clusters on the edge. You ca
4444
[Azure IoT Orchestrator Preview](../deploy-custom/overview-orchestrator.md) manages the deployment and configuration of the Azure IoT Operations components that run on your Arc-enabled Kubernetes cluster.
4545

4646
> [!NOTE]
47-
> During public preview, there's no support for upgrading an existing Azure IoT Operations deployment to a newer version. Instead, remove Azure IoT Operations from your cluster and then deploy the latest version.
47+
> During public preview, there's no support for upgrading an existing Azure IoT Operations deployment to a newer version. Instead, remove Azure IoT Operations from your cluster and then deploy the latest version. For more information, see [Update Azure IoT Operations](../deploy-iot-ops/howto-deploy-iot-operations.md#update-azure-iot-operations).
4848
4949
## Manage devices and assets
5050

articles/iot-operations/get-started/quickstart-deploy.md

Lines changed: 4 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -144,15 +144,11 @@ In this quickstart, you configured your Arc-enabled Kubernetes cluster so that i
144144

145145
If you're continuing on to the next quickstart, keep all of your resources.
146146

147-
If you want to delete the Azure IoT Operations deployment but plan on reinstalling it on your cluster, be sure to keep the secrets provider on your cluster.
147+
If you want to delete the Azure IoT Operations deployment but want to keep your cluster, use the [az iot ops delete](/cli/azure/iot/ops#az-iot-ops-delete) command.
148148

149-
1. In your resource group in the Azure portal, select your cluster.
150-
1. On your cluster resource page, select **Extensions**.
151-
1. Select all of the extensions of type **microsoft.iotoperations.x** and **microsoft.deviceregistry.assets**, then select **Uninstall**. Don't uninstall the secrets provider extension.
152-
153-
:::image type="content" source="media/quickstart-deploy/uninstall-extensions.png" alt-text="Screenshot that shows the extensions to uninstall.":::
154-
155-
1. Return to your resource group and select the custom location resource, then select **Delete**.
149+
```azurecli
150+
az iot ops delete --cluster $CLUSTER_NAME --resource-group $RESOURCE_GROUP
151+
```
156152

157153
If you want to delete all of the resources you created for this quickstart, delete the Kubernetes cluster where you deployed Azure IoT Operations and remove the Azure resource group that contained the cluster.
158154

0 commit comments

Comments
 (0)