Skip to content

Commit 7084872

Browse files
committed
Reconciled Monitor/Modify procedures in how-to-monitor and how-to-deploy-at-scale. Removed unused screenshots
1 parent dd8d4dd commit 7084872

File tree

6 files changed

+27
-32
lines changed

6 files changed

+27
-32
lines changed

articles/iot-edge/how-to-deploy-at-scale.md

Lines changed: 22 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -148,7 +148,7 @@ Use the tags property from your devices to target the specific devices that shou
148148

149149
Since multiple deployments may target the same device, you should give each deployment a priority number. If there's ever a conflict, the deployment with the highest priority (larger values indicate higher priority) wins. If two deployments have the same priority number, the one that was created most recently wins.
150150

151-
If multiple deployments target the same device then only the one with the higher priority is applied. If multiple layered deployments target the same device then they are all applied. However, if any properties are duplicated, like if there are two routes with the same name, then the one from the higher priority layered deployment overwrites the rest.
151+
If multiple deployments target the same device, then only the one with the higher priority is applied. If multiple layered deployments target the same device then they are all applied. However, if any properties are duplicated, like if there are two routes with the same name, then the one from the higher priority layered deployment overwrites the rest.
152152

153153
Any layered deployment targeting a device must have a higher priority than the base deployment in order to be applied.
154154

@@ -165,50 +165,43 @@ To monitor your deployment, see [Monitor IoT Edge deployments](how-to-monitor-io
165165

166166
## Modify a deployment
167167

168-
When you modify a deployment, the changes immediately replicate to all targeted devices.
168+
When you modify a deployment, the changes immediately replicate to all targeted devices. You can modify the following settings and features for an existing deployment:
169169

170-
If you update the target condition, the following updates occur:
170+
* Target conditions
171+
* Custom metrics
172+
* Labels
173+
* Tags
174+
* Desired properties
171175

172-
* If a device didn't meet the old target condition, but meets the new target condition and this deployment is the highest priority for that device, then this deployment is applied to the device.
173-
* If a device currently running this deployment no longer meets the target condition, it uninstalls this deployment and takes on the next highest priority deployment.
174-
* If a device currently running this deployment no longer meets the target condition and doesn't meet the target condition of any other deployments, then no change occurs on the device. The device continues running its current modules in their current state, but is not managed as part of this deployment anymore. Once it meets the target condition of any other deployment, it uninstalls this deployment and takes on the new one.
176+
### Modify target conditions, custom metrics, and labels
175177

176-
You can also make changes to reported properties and custom metrics in your deployment. Afterwards, follow the guidance in [Monitor IoT Edge deployments](how-to-monitor-iot-edge-deployments.md) to watch the changes roll out.
178+
1. In your IoT hub, select **IoT Edge** from the left pane menu.
179+
1. Select the **IoT Edge deployments** tab and then select the deployment you want to configure.
180+
1. Select the **Target Condition** tab. Change the **Target Condition** to target the intended devices. You can also adjust the **Priority**. Select **Save**.
177181

178-
### Modify targeted devices
182+
If you update the target condition, the following updates occur:
179183

180-
To modify targeted devices for a deployment:
184+
* If a device didn't meet the old target condition, but meets the new target condition and this deployment is the highest priority for that device, then this deployment is applied to the device.
185+
* If a device currently running this deployment no longer meets the target condition, it uninstalls this deployment and takes on the next highest priority deployment.
186+
* If a device currently running this deployment no longer meets the target condition and doesn't meet the target condition of any other deployments, then no change occurs on the device. The device continues running its current modules in their current state, but is not managed as part of this deployment anymore. Once it meets the target condition of any other deployment, it uninstalls this deployment and takes on the new one.
181187

182-
1. In your IoT hub, select **IoT Edge** from the left pane menu.
183-
1. Select the **IoT Edge deployments** tab and select the deployment you want to configure. Select the **Target Condition** tab.
184-
1. If needed, adjust the **Priority** for when deployments target the same device, the deployment with higher priority gets applied. If multiple deployments have the same priority, the deployment with the later creation date gets applied.
185-
1. Define a target condition, using the example syntax as a guide.
188+
1. Select the **Metrics** tab and click the **Edit Metrics** button. Add or modify custom metrics, using the example syntax as a guide. Select **Save**.
186189

187-
![Specify target conditions for a deployment](./media/how-to-deploy-monitor/target-devices.png)
190+
![Edit custom metrics in a deployment](./media/how-to-deploy-monitor/metric-list.png)
188191

189-
### Modify desired properties
192+
1. Select the **Labels** tab and make any desired changes and select **Save**.
190193

191-
If you developed custom code modules, such as described in [Use Visual Studio 2019 to develop and debug modules for Azure IoT Edge](how-to-visual-studio-develop-module.md), you can monitor their values by defining properties. You can also add, delete, and edit properties in the module twin after the module has been deployed to an IoT Edge device. For an overview of the properties, see [Properties of the IoT Edge agent and IoT Edge hub module twins](module-edgeagent-edgehub.md).
194+
### Modify tags and desired properties
192195

193-
To define and edit properties for a deployed module:
196+
If you developed custom code modules to your devices, you can add or modify tags and desired properties in the module twin. For an overview of IoT Edge properties, see [Properties of the IoT Edge agent and IoT Edge hub module twins](module-edgeagent-edgehub.md).
194197

195198
1. In your IoT hub, select **IoT Edge** from the left pane menu.
196199
1. Select the device with the module you want to edit.
197200
1. On the **Modules** tab, select the module.
198-
1. On the module details page, on the upper menu bar select **Module Identity Twin**.
201+
1. On the module details page, on the upper menu bar select **Module Identity Twin**. Edit the JSON as needed and select **Save**.
199202

200203
![Edit properties on the module identity twin](./media/how-to-deploy-monitor/module-twin.png)
201204

202-
### Modify a custom metric
203-
204-
To change or add custom metrics:
205-
206-
1. In your IoT hub, select **IoT Edge** from the left pane menu.
207-
1. Select the **IoT Edge deployments** tab and then select the deployment you want to configure. Select the **Metrics** tab.
208-
1. Define a custom metric, using the example syntax as a guide.
209-
210-
![Create a custom metric in the deployment wizard](./media/how-to-deploy-monitor/create-custom-metric.png)
211-
212205
## Delete a deployment
213206

214207
When you delete a deployment, any deployed devices take on their next highest priority deployment. If your devices don't meet the target condition of any other deployment, then the modules are not removed when the deployment is deleted.
@@ -221,7 +214,7 @@ When you delete a deployment, any deployed devices take on their next highest pr
221214

222215
1. Use the checkbox to select the deployment that you want to delete.
223216
1. Select **Delete**.
224-
1. A prompt will inform you that this action will delete this deployment and revert to the previous state for all devices.  This means that a deployment with a lower priority will apply. If no other deployment is targeted, no modules will be removed. If you want to remove all modules from your device, create a deployment with zero modules and deploy it to the same devices. Select **Yes** to continue.
217+
1. A prompt will inform you that this action will delete this deployment and revert to the previous state for all devices. A deployment with a lower priority will apply. If no other deployment is targeted, no modules will be removed. If you want to remove all modules from your device, create a deployment with zero modules and deploy it to the same devices. Select **Yes** to continue.
225218

226219
## Next steps
227220

articles/iot-edge/how-to-monitor-iot-edge-deployments.md

Lines changed: 5 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,11 +58,13 @@ To view the details of a deployment and monitor the devices running it, use the
5858
| Creation Time | The timestamp from when the deployment was created. This timestamp is used to break ties when two deployments have the same priority. |
5959

6060
1. Select the deployment that you want to monitor.  
61-
1. On the **Deployment Details** page, scroll down to the bottom section and select the **Metrics** tab. When you choose a metric from the **Select Metric** drop-down, a **View** button appears for you to display the results. You can also select **Edit Metics** to adjust the criteria for any custom metrics that you have defined.
61+
1. On the **Deployment Details** page, scroll down to the bottom section and select the **Target Condition** tab. Select **View** to list the devices that match the target condition. You can change the condition and also the **Priority**. Select **Save** if you made changes.
6262

63-
![View metrics for a deployment](./media/how-to-monitor-iot-edge-deployments/deployment-metrics-tab.png)
63+
![View targeted devices for a deployment](./media/how-to-monitor-iot-edge-deployments/target-devices.png)
64+
65+
1. Select the **Metrics** tab. If you choose a metric from the **Select Metric** drop-down, a **View** button appears for you to display the results. You can also select **Edit Metics** to adjust the criteria for any custom metrics that you have defined. Select **Save** if you made changes.
6466

65-
To make changes to your deployment, see [Modify a deployment](how-to-deploy-at-scale.md#modify-a-deployment).
67+
![View metrics for a deployment](./media/how-to-monitor-iot-edge-deployments/deployment-metrics-tab.png)
6668

6769
## Monitor a deployment with Azure CLI
6870

Binary file not shown.
53.4 KB
Loading

0 commit comments

Comments
 (0)