Skip to content

Commit 8f3ca63

Browse files
Merge pull request #289200 from kgremban/m3-upgrade
Upgrade steps for M3
2 parents 553d746 + 0595e12 commit 8f3ca63

File tree

3 files changed

+56
-45
lines changed

3 files changed

+56
-45
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
@@ -51,7 +51,7 @@ A cluster host:
5151

5252
* 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).
5353

54-
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#update).
54+
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).
5555

5656
* Verify that your cluster host is configured correctly for deployment by using the [verify-host](/cli/azure/iot/ops#az-iot-ops-verify-host) command on the cluster host:
5757

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

Lines changed: 54 additions & 42 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: kgremban
55
ms.author: kgremban
66
ms.topic: how-to
77
ms.custom: devx-track-azurecli
8-
ms.date: 09/23/2024
8+
ms.date: 10/24/2024
99

1010
#CustomerIntent: As an OT professional, I want to manage Azure IoT Operations instances.
1111
---
@@ -34,6 +34,11 @@ After deployment, you can use the Azure CLI and Azure portal to view and manage
3434

3535
### List instances
3636

37+
#### [Azure portal](#tab/portal)
38+
39+
1. In the [Azure portal](https://portal.azure.com), search for and select **Azure IoT Operations**.
40+
1. Use the filters to view Azure IoT Operations instances based on subscription, resource group, and more.
41+
3742
#### [Azure CLI](#tab/cli)
3843

3944
Use the `az iot ops list` command to see all of the Azure IoT Operations instances in your subscription or resource group.
@@ -50,14 +55,21 @@ To filter the results by resource group, add the `--resource-group` parameter.
5055
az iot ops list --resource-group <RESOURCE_GROUP>
5156
```
5257

58+
---
59+
60+
### View instance
61+
5362
#### [Azure portal](#tab/portal)
5463

55-
1. In the [Azure portal](https://portal.azure.com), search for and select **Azure IoT Operations**.
56-
1. Use the filters to view Azure IoT Operations instances based on subscription, resource group, and more.
64+
You can view your Azure IoT Operations instance in the Azure portal.
5765

58-
---
66+
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**.
5967

60-
### View instance
68+
1. Select the name of your Azure IoT Operations instance.
69+
70+
1. On the **Overview** page of your instance, the **Arc extensions** table displays the resources that were deployed to your cluster.
71+
72+
:::image type="content" source="../get-started-end-to-end-sample/media/quickstart-deploy/view-instance.png" alt-text="Screenshot that shows the Azure IoT Operations instance on your Arc-enabled cluster." lightbox="../get-started-end-to-end-sample/media/quickstart-deploy/view-instance.png":::
6173

6274
#### [Azure CLI](#tab/cli)
6375

@@ -91,21 +103,17 @@ MyCluster
91103

92104
You can run `az iot ops check` on your cluster to assess health and configurations of individual Azure IoT Operations components. By default, the command checks MQ but you can [specify the service](/cli/azure/iot/ops#az-iot-ops-check-examples) with `--ops-service` parameter.
93105

94-
#### [Azure portal](#tab/portal)
106+
---
95107

96-
You can view your Azure IoT Operations instance in the Azure portal.
108+
### Update instance tags and description
109+
110+
#### [Azure portal](#tab/portal)
97111

98112
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**.
99113

100114
1. Select the name of your Azure IoT Operations instance.
101115

102-
1. On the **Overview** page of your instance, the **Arc extensions** table displays the resources that were deployed to your cluster.
103-
104-
:::image type="content" source="../get-started-end-to-end-sample/media/quickstart-deploy/view-instance.png" alt-text="Screenshot that shows the Azure IoT Operations instance on your Arc-enabled cluster." lightbox="../get-started-end-to-end-sample/media/quickstart-deploy/view-instance.png":::
105-
106-
---
107-
108-
### Update instance tags and description
116+
1. On the **Overview** page of your instance, select **Add tags** or **edit** to modify tags on your instance.
109117

110118
#### [Azure CLI](#tab/cli)
111119

@@ -121,14 +129,6 @@ To delete all tags on an instance, set the tags parameter to a null value. For e
121129
az iot ops update --name <INSTANCE_NAME> --resource-group --tags ""
122130
```
123131

124-
#### [Azure portal](#tab/portal)
125-
126-
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**.
127-
128-
1. Select the name of your Azure IoT Operations instance.
129-
130-
1. On the **Overview** page of your instance, select **Add tags** or **edit** to modify tags on your instance.
131-
132132
---
133133

134134
## Uninstall
@@ -137,6 +137,18 @@ The Azure CLI and Azure portal offer different options for uninstalling Azure Io
137137

138138
The Azure portal steps can delete an Azure IoT Operations instance, but can't affect the related resources in the deployment. If you want to delete the entire deployment, use the Azure CLI.
139139

140+
### [Azure portal](#tab/portal)
141+
142+
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**.
143+
144+
1. Select the name of your Azure IoT Operations instance.
145+
146+
1. On the **Overview** page of your instance, select **Delete**.
147+
148+
1. Review the list of resources that are and aren't deleted as part of this operation, then type the name of your instance and select **Delete** to confirm.
149+
150+
:::image type="content" source="./media/howto-deploy-iot-operations/delete-instance.png" alt-text="A screenshot that shows deleting an Azure IoT Operations instance in the Azure portal.":::
151+
140152
### [Azure CLI](#tab/cli)
141153

142154
Use the [az iot ops delete](/cli/azure/iot/ops#az-iot-ops-delete) command to delete the entire Azure IoT Operations deployment 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 when you run this command.
@@ -161,37 +173,37 @@ To delete the instance and also remove the Azure IoT Operations dependencies (th
161173
az iot ops delete --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --include-deps
162174
```
163175

164-
### [Azure portal](#tab/portal)
176+
---
165177

166-
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**.
178+
## Upgrade
167179

168-
1. Select the name of your Azure IoT Operations instance.
180+
In public preview, Azure IoT Operations supports upgrading instances from version 0.7.x to 0.8.x.
169181

170-
1. On the **Overview** page of your instance, select **Delete** your instance.
182+
When a generally available release is made available, you'll need to deploy a new Azure IoT Operations installation. You won't be able to upgrade from a preview installation.
171183

172-
1. Review the list of resources that are and aren't deleted as part of this operation, then type the name of your instance and select **Delete** to confirm.
184+
### [Azure portal](#tab/portal)
173185

174-
:::image type="content" source="./media/howto-deploy-iot-operations/delete-instance.png" alt-text="A screenshot that shows deleting an Azure IoT Operations instance in the Azure portal.":::
186+
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**.
175187

176-
---
188+
1. Select the name of your Azure IoT Operations instance.
177189

178-
## Update
190+
1. On the **Overview** page of your instance, select **Upgrade**.
179191

180-
Currently, there's no support for updating an existing Azure IoT Operations deployment. Instead, uninstall and redeploy a new version of Azure IoT Operations.
192+
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.
181193

182-
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.
194+
1. Update to the latest version of Azure IoT Operations instance. Copy and run the provided `az iot ops upgrade` command.
183195

184-
```azurecli
185-
az iot ops delete --cluster <CLUSTER_NAME> --resource-group <RESOURCE_GROUP>
186-
```
196+
1. Once the upgrade command completes successfully, you can exit the wizard and refresh your instance page.
187197

188-
1. Update the CLI extension to get the latest Azure IoT Operations version.
198+
### [Azure CLI](#tab/cli)
199+
200+
Use the `az iot ops upgrade` command to upgrade an Azure IoT Operations deployment. This command:
189201

190-
```azurecli
191-
az extension update --name azure-iot-ops
192-
```
202+
* Upgrades Azure Arc extensions on your cluster.
203+
* Upgrades the Azure IoT Operations instance.
193204

194-
1. Follow the steps in this article to deploy the newest version of Azure IoT Operations to your cluster.
205+
```azurecli
206+
az iot ops upgrade --resource-group <RESOURCE_GROUP> --name <INSTANCE_NAME>
207+
```
195208

196-
>[!TIP]
197-
>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.
209+
---

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

Lines changed: 1 addition & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -42,8 +42,7 @@ There are two core elements in the Azure IoT Operations Preview architecture:
4242

4343
Azure IoT Operations runs on Arc-enabled Kubernetes clusters on the edge. You can deploy Azure IoT Operations by using the Azure portal or the Azure CLI.
4444

45-
> [!NOTE]
46-
> 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-manage-update-uninstall.md#update).
45+
During public preview, Azure IoT Operations supports upgrading instances from version 0.7.x to 0.8.x. For more information, see [Manage Azure IoT Operations](./deploy-iot-ops/howto-manage-update-uninstall.md#upgrade).
4746

4847
## Manage devices and assets
4948

0 commit comments

Comments
 (0)