Skip to content

Commit 23bee26

Browse files
committed
delete overview-process-data
2 parents afdce83 + 22981d3 commit 23bee26

File tree

4 files changed

+60
-16
lines changed

4 files changed

+60
-16
lines changed

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

Lines changed: 60 additions & 16 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: ignite-2023, devx-track-azurecli
8-
ms.date: 07/24/2024
8+
ms.date: 07/30/2024
99

1010
#CustomerIntent: As an OT professional, I want to deploy Azure IoT Operations to a Kubernetes cluster.
1111
---
@@ -21,7 +21,7 @@ Deploy Azure IoT Operations Preview to a Kubernetes cluster using the Azure CLI.
2121
* Arc extensions
2222
* Custom locations
2323
* Resource sync rules
24-
* Additional resources that you can configure in your Azure IoT Operations solution, like assets, MQTT broker, and dataflows.
24+
* Resources that you can configure in your Azure IoT Operations solution, like assets, MQTT broker, and dataflows.
2525

2626
* An Azure IoT Operations *instance* is one part of a deployment. It's the parent resource that bundles the suite of services that are defined in [What is Azure IoT Operations Preview?](../overview-iot-operations.md), like MQ, Akri, and OPC UA connector.
2727

@@ -39,7 +39,7 @@ Cloud resources:
3939

4040
* In the Azure CLI, use the [az role assignment create](/cli/azure/role/assignment#az-role-assignment-create) command to give permissions. For example, `az role assignment create --assignee sp_name --role "Role Based Access Control Administrator" --scope subscriptions/00000000-0000-0000-0000-000000000000/resourceGroups/MyResourceGroup`
4141

42-
* In the Azure portal, when you assign privileged admin roles to a user or principal, you're prompted to restrict access using conditions. For this scenario, select the **Allow user to assign all roles** condition in the **Add role assignment** page.
42+
* In the Azure portal, when you assign privileged admin roles to a user or principal, you can restrict access using conditions. For this scenario, select the **Allow user to assign all roles** condition in the **Add role assignment** page.
4343

4444
:::image type="content" source="./media/howto-deploy-iot-operations/add-role-assignment-conditions.png" alt-text="Screenshot that shows assigning users highly privileged role access in the Azure portal.":::
4545

@@ -63,7 +63,7 @@ A cluster host:
6363

6464
* 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).
6565

66-
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).
66+
If you deployed Azure IoT Operations to your cluster previously, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](#update-azure-iot-operations).
6767

6868
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.
6969

@@ -108,13 +108,23 @@ Use the Azure CLI to deploy Azure IoT Operations to your Arc-enabled Kubernetes
108108

109109
If you want to use an existing service principal and app registration instead of allowing `init` to create new ones, include the `--sp-app-id,` `--sp-object-id`, and `--sp-secret` parameters. For more information, see [Configure service principal and Key Vault manually](howto-manage-secrets.md#configure-service-principal-and-key-vault-manually).
110110

111-
1. While the deployment is in progress, you can watch the resources being applied to your cluster. You can use kubectl commands to observe changes on the cluster. To view the pods on your cluster, run the following command:
111+
1. While the deployment is in progress, you can watch the resources being applied to your cluster.
112112

113-
```bash
114-
kubectl get pods -n azure-iot-operations
115-
```
113+
* If your terminal supports it, `init` displays the deployment progress.
114+
115+
:::image type="content" source="./media/howto-deploy-iot-operations/view-deployment-terminal.png" alt-text="A screenshot that shows the progress of an Azure IoT Operations deployment in a terminal.":::
116+
117+
Once the **Deploy IoT Operations** phase begins, the text in the terminal becomes a link to view the deployment progress in the Azure portal.
118+
119+
:::image type="content" source="./media/howto-deploy-iot-operations/view-deployment-portal.png" alt-text="A screenshot that shows the progress of an Azure IoT Operations deployment in the Azure portal.":::
116120

117-
It can take several minutes for the deployment to complete. Rerun the `get pods` command to refresh your view.
121+
* Otherwise, or if you choose to disable the progress interface with `--no-progress`, you can use kubectl commands to view the pods on your cluster:
122+
123+
```bash
124+
kubectl get pods -n azure-iot-operations
125+
```
126+
127+
It can take several minutes for the deployment to complete. Rerun the `get pods` command to refresh your view.
118128

119129
1. After the deployment is complete, use [az iot ops check](/cli/azure/iot/ops#az-iot-ops-check) to evaluate IoT Operations service deployment for health, configuration, and usability. The *check* command can help you find problems in your deployment and configuration.
120130

@@ -140,7 +150,7 @@ The basic command returns all instances in your subscription.
140150
az iot ops list
141151
```
142152

143-
Add the `--resource-group` parameter to filter the results.
153+
To filter the results by resource group, add the `--resource-group` parameter.
144154

145155
```azurecli
146156
az iot ops list --resource-group <RESOURCE_GROUP>
@@ -157,7 +167,13 @@ az iot ops list --resource-group <RESOURCE_GROUP>
157167

158168
#### [Azure CLI](#tab/cli)
159169

160-
You can view the resources in your Azure IoT Operations deployment in the Azure CLI. Use the `az iot ops show` command to show a tree view of the deployment, which includes the Azure IoT Operations instance.
170+
Use the `az iot ops show` command to view the properties of an instance.
171+
172+
```azurecli
173+
az iot ops show --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --tree
174+
```
175+
176+
You can also use the `az iot ops show` command to view the resources in your Azure IoT Operations deployment in the Azure CLI. Add the `--tree` flag to show a tree view of the deployment that includes the specified Azure IoT Operations instance.
161177

162178
```azurecli
163179
az iot ops show --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --tree
@@ -179,7 +195,7 @@ MyCluster
179195
└── MyCluster-observability
180196
```
181197

182-
You can run `az iot ops check` on your cluster to assess health and configurations of individul Azure IoT Operations components. By default, the command checks MQ but you can [specifiy the service](/cli/azure/iot/ops#az-iot-ops-check-examples) with `--ops-service` parameter.
198+
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.
183199

184200
#### [Azure portal](#tab/portal)
185201

@@ -199,10 +215,16 @@ You can view your Azure IoT Operations instance in the Azure portal.
199215

200216
#### [Azure CLI](#tab/cli)
201217

202-
Use the `az iot ops update` command to edit the tags and description parameters of your Azure IoT Operations instance.
218+
Use the `az iot ops update` command to edit the tags and description parameters of your Azure IoT Operations instance. The values provided in the `update` command replace any existing tags or description
219+
220+
```azurecli
221+
az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --desc "<INSTANCE_DESCRIPTION>" --tags <TAG_NAME>=<TAG-VALUE> <TAG_NAME>=<TAG-VALUE>
222+
```
223+
224+
To delete all tags on an instance, set the tags parameter to a null value. For example:
203225

204226
```azurecli
205-
az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --desc "<INSTANCE_DESCRIPTION>" --tags <TAG_NAME>=<TAG-VALUE>
227+
az iot ops update --name <INSTANCE_NAME> --resource-group --tags ""
206228
```
207229

208230
#### [Azure portal](#tab/portal)
@@ -217,20 +239,42 @@ az iot ops update --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --des
217239

218240
## Uninstall Azure IoT Operations
219241

220-
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 prior to running this command.
242+
The Azure CLI and Azure portal offer different options for uninstalling Azure IoT Operations.
243+
244+
If you want to delete an entire Azure IoT Operations deployment, use the Azure CLI.
245+
246+
If you want to delete an Azure IoT Operations instance but keep the related resources in the deployment, use the Azure portal.
247+
248+
### [Azure CLI](#tab/cli)
249+
250+
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.
221251

222252
The `delete` command removes:
223253

224254
* The Azure IoT Operations instance
225255
* Arc extensions
226256
* Custom locations
227257
* Resource sync rules
228-
* Additional resources that you can configure in your Azure IoT Operations solution, like assets, MQTT broker, and dataflows.
258+
* Resources that you can configure in your Azure IoT Operations solution, like assets, MQTT broker, and dataflows.
229259

230260
```azurecli
231261
az iot ops delete --cluster <CLUSTER_NAME> --resource-group <RESOURCE_GROUP>
232262
```
233263

264+
### [Azure portal](#tab/portal)
265+
266+
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**.
267+
268+
1. Select the name of your Azure IoT Operations instance.
269+
270+
1. On the **Overview** page of your instance, select **Delete** your instance.
271+
272+
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.
273+
274+
:::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.":::
275+
276+
---
277+
234278
## Update Azure IoT Operations
235279
236280
Currently, there's no support for updating an existing Azure IoT Operations deployment. Instead, uninstall and redeploy a new version of Azure IoT Operations.
59.5 KB
Loading
112 KB
Loading
88 KB
Loading

0 commit comments

Comments
 (0)