You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: articles/iot-operations/deploy-iot-ops/howto-deploy-iot-operations.md
+39-17Lines changed: 39 additions & 17 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: kgremban
5
5
ms.author: kgremban
6
6
ms.topic: how-to
7
7
ms.custom: ignite-2023, devx-track-azurecli
8
-
ms.date: 07/24/2024
8
+
ms.date: 07/30/2024
9
9
10
10
#CustomerIntent: As an OT professional, I want to deploy Azure IoT Operations to a Kubernetes cluster.
11
11
---
@@ -21,7 +21,7 @@ Deploy Azure IoT Operations Preview to a Kubernetes cluster using the Azure CLI.
21
21
* Arc extensions
22
22
* Custom locations
23
23
* 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.
25
25
26
26
* 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.
27
27
@@ -39,7 +39,7 @@ Cloud resources:
39
39
40
40
* 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`
41
41
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.
43
43
44
44
:::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.":::
45
45
@@ -63,7 +63,7 @@ A cluster host:
63
63
64
64
* 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).
65
65
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 youdeployed Azure IoT Operations to your cluster previously, uninstall those resources before continuing. For more information, see [Update Azure IoT Operations](#update-azure-iot-operations).
67
67
68
68
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.
69
69
@@ -108,13 +108,23 @@ Use the Azure CLI to deploy Azure IoT Operations to your Arc-enabled Kubernetes
108
108
109
109
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).
110
110
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.
112
112
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.":::
116
120
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.
118
128
119
129
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 forhealth, configuration, and usability. The *check* command can help you find problemsin your deployment and configuration.
120
130
@@ -140,7 +150,7 @@ The basic command returns all instances in your subscription.
140
150
az iot ops list
141
151
```
142
152
143
-
Add the `--resource-group` parameter to filter the results.
153
+
To filter the results by resource group, add the `--resource-group` parameter.
144
154
145
155
```azurecli
146
156
az iot ops list --resource-group <RESOURCE_GROUP>
@@ -157,7 +167,13 @@ az iot ops list --resource-group <RESOURCE_GROUP>
157
167
158
168
#### [Azure CLI](#tab/cli)
159
169
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.
161
177
162
178
```azurecli
163
179
az iot ops show --name <INSTANCE_NAME> --resource-group <RESOURCE_GROUP> --tree
@@ -179,7 +195,7 @@ MyCluster
179
195
└── MyCluster-observability
180
196
```
181
197
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.
183
199
184
200
#### [Azure portal](#tab/portal)
185
201
@@ -199,10 +215,16 @@ You can view your Azure IoT Operations instance in the Azure portal.
199
215
200
216
#### [Azure CLI](#tab/cli)
201
217
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
az iot ops update --name <INSTANCE_NAME> --resource-group --tags ""
206
228
```
207
229
208
230
#### [Azure portal](#tab/portal)
@@ -225,15 +247,15 @@ If you want to delete an Azure IoT Operations instance but keep the related reso
225
247
226
248
### [Azure CLI](#tab/cli)
227
249
228
-
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.
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.
229
251
230
252
The `delete`command removes:
231
253
232
254
* The Azure IoT Operations instance
233
255
* Arc extensions
234
256
* Custom locations
235
257
* Resource sync rules
236
-
*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.
237
259
238
260
```azurecli
239
261
az iot ops delete --cluster <CLUSTER_NAME> --resource-group <RESOURCE_GROUP>
1. On the **Overview** page of your instance, select**Delete** your instance.
249
271
250
-
1. Review the list of resources that are and aren't deleted as part of this operations, then type the name of your instance and select **Delete** to confirm.
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.
251
273
252
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.":::
Copy file name to clipboardExpand all lines: articles/iot-operations/process-data/overview-data-processor.md
+6-4Lines changed: 6 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -48,20 +48,22 @@ Key data processor features include:
48
48
49
49
By default, the data processor isn't included in an Azure IoT Operations Preview deployment. If you plan to use the data processor, you must include it when you deploy Azure IoT Operations Preview - you can't add it later.
50
50
51
-
The data processor is available in Azure IoT Operations versions 0.5.1 and earlier.
51
+
The data processor is available in Azure IoT Operations version 0.5.1 and earlier.
52
52
53
-
To deploy the data processor, make sure that you have a supported version of the Azure IoT Operations CLI extension. For example:
53
+
To deploy the data processor, use version 0.5.1b1 of the Azure IoT Operations CLI extension:
54
54
55
55
```azurecli
56
-
az extension add --upgrade --name azure-iot-ops --version 0.5.1
56
+
az extension add --upgrade --name azure-iot-ops --version 0.5.1b1
57
57
```
58
58
59
-
For versions earlier than 0.5.1, data processor is included in Azure IoT Operations deployments. For version 0.5.1, use the `--include-dp` argument when you run the [az iot ops init](/cli/azure/iot/ops#az-iot-ops-init) command. To learn more, see [Deploy Azure IoT Operations Preview to an Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-deploy-iot-operations.md).
59
+
Then, include the `--include-dp` argument when you run the [az iot ops init](/cli/azure/iot/ops#az-iot-ops-init) command. For example:
To learn more about the `init` command parameters, see [Deploy Azure IoT Operations Preview to an Arc-enabled Kubernetes cluster](../deploy-iot-ops/howto-deploy-iot-operations.md).
66
+
65
67
## What is a pipeline?
66
68
67
69
A data processor pipeline has an input source where it reads data from, a destination where it writes processed data to, and a variable number of intermediate stages to process the data.
0 commit comments