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-edge/module-deployment-monitoring.md
+10-9Lines changed: 10 additions & 9 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -4,7 +4,7 @@ description: Use automatic deployments in Azure IoT Edge to manage groups of dev
4
4
author: kgremban
5
5
manager: philmea
6
6
ms.author: kgremban
7
-
ms.date: 12/12/2019
7
+
ms.date: 01/30/2020
8
8
ms.topic: conceptual
9
9
ms.service: iot-edge
10
10
services: iot-edge
@@ -56,7 +56,7 @@ The target condition is continuously evaluated throughout the lifetime of the de
56
56
57
57
For example, you have a deployment with a target condition tags.environment = 'prod'. When you kick off the deployment, there are 10 production devices. The modules are successfully installed in these 10 devices. The IoT Edge agent status shows 10 total devices, 10 successful responses, 0 failure responses, and 0 pending responses. Now you add five more devices with tags.environment = 'prod'. The service detects the change and the IoT Edge agent status becomes 15 total devices, 10 successful responses, 0 failure responses, and 5 pending responses while it deploys to the five new devices.
58
58
59
-
Use any Boolean condition on device twins tags or deviceId to select the target devices. If you want to use condition with tags, you need to add "tags":{} section in the device twin under the same level as properties. [Learn more about tags in device twin](../iot-hub/iot-hub-devguide-device-twins.md)
59
+
Use any Boolean condition on device twin tags, device twin reported properties, or deviceId to select the target devices. If you want to use condition with tags, you need to add "tags":{} section in the device twin under the same level as properties. [Learn more about tags in device twin](../iot-hub/iot-hub-devguide-device-twins.md)
60
60
61
61
Examples of target conditions:
62
62
@@ -65,10 +65,11 @@ Examples of target conditions:
65
65
* tags.environment = 'prod' AND tags.location = 'westus'
66
66
* tags.environment = 'prod' OR tags.location = 'westus'
67
67
* tags.operator = 'John' AND tags.environment = 'prod' NOT deviceId = 'linuxprod1'
68
+
* properties.reported.devicemodel = '4000x'
68
69
69
-
Here are some constrains when you construct a target condition:
70
+
Consider these constraints when you construct a target condition:
70
71
71
-
* In device twin, you can only build a target condition using tags or deviceId.
72
+
* In device twin, you can only build a target condition using tags, reported properties, or deviceId.
72
73
* Double quotes aren't allowed in any portion of the target condition. Use single quotes.
73
74
* Single quotes represent the values of the target condition. Therefore, you must escape the single quote with another single quote if it's part of the device name. For example, to target a device called `operator'sDevice`, write `deviceId='operator''sDevice'`.
74
75
* Numbers, letters, and the following characters are allowed in target condition values: `-:.+%_#*?!(),=@;$`.
@@ -87,8 +88,8 @@ By default, all deployments report on four metrics:
87
88
88
89
***Targeted** shows the IoT Edge devices that match the Deployment targeting condition.
89
90
***Applied** shows the targeted IoT Edge devices that are not targeted by another deployment of higher priority.
90
-
***Reporting Success** shows the IoT Edge devices that have reported back to the service that the modules have been deployed successfully.
91
-
***Reporting Failure** shows the IoT Edge devices that have reported back to the service that one or more modules have not been deployed successfully. To further investigate the error, connect remotely to those devices and view the log files.
91
+
***Reporting Success** shows the IoT Edge devices that have reported that the modules have been deployed successfully.
92
+
***Reporting Failure** shows the IoT Edge devices that have reported that one or more modules haven't been deployed successfully. To further investigate the error, connect remotely to those devices and view the log files.
92
93
93
94
Additionally, you can define your own custom metrics to help monitor and manage the deployment.
94
95
@@ -107,7 +108,7 @@ Layered deployments are automatic deployments that can be combined together to r
107
108
108
109
Layered deployments have the same basic components as any automatic deployment. They target devices based on tags in the device twins, and provide the same functionality around labels, metrics, and status reporting. Layered deployments also have priorities assigned to them, but instead of using the priority to determine which deployment is applied to a device, the priority determines how multiple deployments are ranked on a device. For example, if two layered deployments have a module or a route with the same name, the layered deployment with the higher priority will be applied while the lower priority is overwritten.
109
110
110
-
The system runtime modules, edgeAgent and edgeHub, are not configured as part of a layered deployment. Any IoT Edge device targeted by a layered deployment needs a standard automatic deployment applied to it first to provide the base upon which layered deployments can be added.
111
+
The system runtime modules, edgeAgent and edgeHub, are not configured as part of a layered deployment. Any IoT Edge device targeted by a layered deployment needs a standard automatic deployment applied to it first. The automatic deployment provides the base upon which layered deployments can be added.
111
112
112
113
An IoT Edge device can apply one and only one standard automatic deployment, but it can apply multiple layered automatic deployments. Any layered deployments targeting a device must have a higher priority than the automatic deployment for that device.
113
114
@@ -136,7 +137,7 @@ For example, in a standard deployment you might add the simulated temperature se
136
137
}
137
138
```
138
139
139
-
In a layered deployment targeting the same devices, or a subset of the same devices, you may want to add an additional property that tells the simulated sensor to send 1000 messages and then stop. You don't want to overwrite the existing properties, so you create a new section within the desired properties called `layeredProperties`, which contains the new property:
140
+
In a layered deployment that targets some or all of the same devices, you could add a property that tells the simulated sensor to send 1000 messages and then stop. You don't want to overwrite the existing properties, so you create a new section within the desired properties called `layeredProperties`, which contains the new property:
140
141
141
142
```json
142
143
"SimulatedTemperatureSensor": {
@@ -179,7 +180,7 @@ A phased rollout is executed in the following phases and steps:
179
180
180
181
Deployments can be rolled back if you receive errors or misconfigurations. Because a deployment defines the absolute module configuration for an IoT Edge device, an additional deployment must also be targeted to the same device at a lower priority even if the goal is to remove all modules.
181
182
182
-
Deleting a deployment does not remove the modules from targeted devices. There must be another deployment that defines a new configuration for the devices, even if it's an empty deployment.
183
+
Deleting a deployment doesn't remove the modules from targeted devices. There must be another deployment that defines a new configuration for the devices, even if it's an empty deployment.
0 commit comments