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/about-iot-edge.md
+3-3Lines changed: 3 additions & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ author: PatAltimore
5
5
ms.service: iot-edge
6
6
services: iot-edge
7
7
ms.topic: overview
8
-
ms.date: 06/05/2024
8
+
ms.date: 06/12/2024
9
9
ms.author: patricka
10
10
ms.custom: mvc
11
11
---
@@ -18,7 +18,7 @@ Azure IoT Edge is a device-focused runtime that enables you to deploy, run, and
18
18
19
19
Analytics drives business value in IoT solutions, but not all analytics need to be in the cloud. Azure IoT Edge helps you bring the analytical power of the cloud closer to your devices to drive better business insights and enable offline decision making. For example, you can run anomaly detection workloads at the edge to respond as quickly as possible to emergencies happening on a production line. If you want to reduce bandwidth costs and avoid transferring terabytes of raw data, you can clean and aggregate the data locally then only send the insights to the cloud for analysis.
20
20
21
-
Azure IoT Edge is a feature of [Azure IoT Hub](../iot-hub/iot-concepts-and-iot-hub.md) and enables you to scale out and manage an IoT solution from the cloud. By packaging your business logic into standard containers and using optional pre-built [IoT Edge modules from the Azure Marketplace](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules) you can easily compose, deploy, and maintain your solution.
21
+
Azure IoT Edge is a feature of [Azure IoT Hub](../iot-hub/iot-concepts-and-iot-hub.md) and enables you to scale out and manage an IoT solution from the cloud. By packaging your business logic into standard containers and using optional pre-built IoT Edge module images from partners or the [Microsoft Artifact Registry](https://mcr.microsoft.com/catalog?cat=IoT%20Edge%20Modules&alphaSort=asc&alphaSortKey=Name), you can easily compose, deploy, and maintain your solution.
22
22
23
23
Azure IoT Edge is made up of three components:
24
24
@@ -35,7 +35,7 @@ IoT Edge modules are units of execution, implemented as Docker-compatible contai
35
35
36
36
### Artificial intelligence at the edge
37
37
38
-
Azure IoT Edge allows you to deploy complex event processing, machine learning, image recognition, and other high value AI without writing it in-house. Azure services like Azure Stream Analytics and Azure Machine Learning can all be run on-premises via Azure IoT Edge. You're not limited to Azure services, though. Anyone is able to create AI modules for your own use or optionally make them available to the community through the Azure Marketplace.
38
+
Azure IoT Edge allows you to deploy complex event processing, machine learning, image recognition, and other high value AI without writing it in-house. Azure services like Azure Stream Analytics and Azure Machine Learning can all be run on-premises via Azure IoT Edge. You're not limited to Azure services, though. Anyone is able to create AI modules for your own use.
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-collect-and-transport-metrics.md
+1-3Lines changed: 1 addition & 3 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -58,9 +58,7 @@ To configure monitoring on your IoT Edge device, follow the [Tutorial: Monitor I
58
58
59
59
A Microsoft-supplied metrics-collector module can be added to an IoT Edge deployment to collect module metrics and send them to Azure Monitor. The module code is open-source and available in the [IoT Edge GitHub repo](https://github.com/Azure/iotedge/tree/main/edge-modules/metrics-collector).
60
60
61
-
The metrics-collector module is provided as a multi-arch Docker container image that supports Linux X64, ARM32, ARM64, and Windows X64 (version 1809). It's publicly available at **[`mcr.microsoft.com/azureiotedge-metrics-collector`](https://aka.ms/edgemon-metrics-collector)**.
62
-
63
-
It also available in the [IoT Edge Module Marketplace](https://aka.ms/edgemon-module-marketplace).
61
+
The metrics-collector module is provided as a multi-arch Docker container image that supports Linux X64, ARM32, ARM64, and Windows X64 (version 1809). It's publicly available at [`mcr.microsoft.com/azureiotedge-metrics-collector`](https://mcr.microsoft.com/product/azureiotedge-metrics-collector/tags).
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-configure-api-proxy-module.md
+2-4Lines changed: 2 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -5,7 +5,7 @@ description: Learn how to customize the API proxy module for IoT Edge gateway hi
5
5
author: PatAltimore
6
6
7
7
ms.author: patricka
8
-
ms.date: 07/06/2023
8
+
ms.date: 06/12/2024
9
9
ms.topic: conceptual
10
10
ms.service: iot-edge
11
11
services: iot-edge
@@ -29,9 +29,7 @@ Without the API proxy, each service module would have to bind to a separate port
29
29
30
30
## Deploy the proxy module
31
31
32
-
The API proxy module is available from the Microsoft Container Registry (MCR): `mcr.microsoft.com/azureiotedge-api-proxy:1.1`.
33
-
34
-
You can also deploy the API proxy module directly from the Azure Marketplace: [IoT Edge API Proxy](https://azuremarketplace.microsoft.com/marketplace/apps/azure-iot.azureiotedge-api-proxy?tab=Overview).
32
+
The API proxy module is available from the [Microsoft Container Registry (MCR)](https://mcr.microsoft.com/product/azureiotedge-api-proxy/tags) and the image URI is `mcr.microsoft.com/azureiotedge-api-proxy:latest`. You can deploy the module using the [Azure portal](how-to-deploy-modules-portal.md) or [Azure CLI](how-to-deploy-modules-cli.md).
| Image URI | `mcr.microsoft.com/azureiotedge-api-proxy:latest` |
617
+
| Restart policy | always |
618
+
| Desired status | running |
619
+
620
+
If you want to use a different version or architecture of the API proxy module, find the available images in the [Microsoft Artifact Registry](https://mcr.microsoft.com/product/azureiotedge-api-proxy).
621
+
622
+
1. In the **Environment variables** tab, add a variable named `NGINX_DEFAULT_PORT` of type *Text* with a value of `443`.
614
623
1. In the **Container create options** tab, update the port bindings to reference port 443.
615
624
616
625
```json
@@ -628,8 +637,8 @@ The API proxy module was designed to be customized to handle most common gateway
628
637
```
629
638
630
639
These changes configure the API proxy module to listen on port 443. To prevent port binding collisions, you need to configure the edgeHub module to not listen on port 443. Instead, the API proxy module will route any edgeHub traffic on port 443.
631
-
632
-
1. Select **Runtime Settings** and find the edgeHub module create options. Delete the port binding for port 443, leaving the bindings for ports 5671 and 8883.
640
+
1. Select **Add** to add the module to the deployment.
641
+
1. Select **Runtime Settings** and find the edgeHub module *Container Create Options*. Delete the port binding for port 443, leaving the bindings for ports 5671 and 8883.
633
642
634
643
```json
635
644
{
@@ -650,34 +659,39 @@ The API proxy module was designed to be customized to handle most common gateway
650
659
}
651
660
```
652
661
653
-
1. Select **Save** to save your changes to the runtime settings.
654
-
1. Select **Add** again, then choose **IoT Edge module**.
655
-
1. Provide the following values to add the Docker registry module to your deployment:
656
-
1. **IoT Edge module name**: `registry`
657
-
1. On the **Module settings** tab, **Image URI**: `registry:latest`
658
-
1. On the **Environment variables** tab, add the following environment variables:
662
+
1. Select **Apply** to save your changes to the runtime settings.
663
+
1. Provide the following values to add the Docker registry module to your deployment.
659
664
660
-
* **Name**: `REGISTRY_PROXY_REMOTEURL` **Value**: The URL for the container registry you want this registry module to map to. For example, `https://myregistry.azurecr`.
665
+
1. In the **IoT Edge modules** section, select **Add** then choose **IoT Edge Module**.
661
666
662
-
The registry module can only map to one container registry, so we recommend having all container images in a single private container registry.
| `REGISTRY_PROXY_REMOTEURL` | Text | The URL for the container registry you want this registry module to map to. For example, `https://myregistry.azurecr`. The registry module can only map to one container registry, so we recommend having all container images in a single private container registry.|
679
+
| `REGISTRY_PROXY_USERNAME` | Text | Username to authenticate to the container registry. |
680
+
| `REGISTRY_PROXY_PASSWORD` | Text | Password to authenticate to the container registry. |
667
681
668
-
1. On the **Container create options** tab, paste:
682
+
1. In the **Container create options** tab, update the port bindings to reference port 5000.
669
683
670
684
```json
671
685
{
672
-
"HostConfig": {
673
-
"PortBindings": {
674
-
"5000/tcp": [
675
-
{
676
-
"HostPort": "5000"
677
-
}
678
-
]
686
+
"HostConfig": {
687
+
"PortBindings": {
688
+
"5000/tcp": [
689
+
{
690
+
"HostPort": "5000"
679
691
}
692
+
]
680
693
}
694
+
}
681
695
}
682
696
```
683
697
@@ -839,11 +853,19 @@ The API proxy module was designed to be customized to handle most common gateway
839
853
1. Select **Devices** under the **Device management** menu.
840
854
1. Select the lower layer IoT Edge device that you're configuring from the list.
841
855
1. Select **Set modules**.
842
-
1. In the **IoT Edge modules** section, select **Add** then choose **Marketplace module**.
843
-
1. Search for and select the **IoT Edge API Proxy** module.
844
-
1. Select the name of the API proxy module from the list of deployed modules and update the following module settings:
845
-
1. In the **Module settings** tab, update the value of **Image URI**. Replace `mcr.microsoft.com` with `$upstream:443`.
846
-
1. In the **Environment variables** tab, update the value of **NGINX_DEFAULT_PORT** to `443`.
856
+
1. In the **IoT Edge modules** section, select **Add** then choose **IoT Edge Module**.
| Image URI | `mcr.microsoft.com/azureiotedge-api-proxy:latest` |
863
+
| Restart policy | `always` |
864
+
| Desired status | `running` |
865
+
866
+
If you want to use a different version or architecture of the API proxy module, find the available images in the [Microsoft Artifact Registry](https://mcr.microsoft.com/product/azureiotedge-api-proxy).
867
+
868
+
1. In the **Environment variables** tab, add a variable named `NGINX_DEFAULT_PORT` of type *Text* with a value of `443`.
847
869
1. In the **Container create options** tab, update the port bindings to reference port 443.
848
870
849
871
```json
@@ -890,7 +912,7 @@ The API proxy module was designed to be customized to handle most common gateway
890
912
1. Update the edgeAgent module settings:
891
913
1. In the **Image** field, replace `mcr.microsoft.com` with `$upstream:443`.
892
914
893
-
1. Select **Save** to save your changes to the runtime settings.
915
+
1. Select **Apply** to save your changes to the runtime settings.
894
916
1. Select **Next: Routes** to go to the next step.
895
917
1. To enable device-to-cloud messages from downstream devices to reach IoT Hub, include a route that passes all messages to `$upstream`. The upstream parameter points to the parent device in the case of lower layer devices. For example:
Copy file name to clipboardExpand all lines: articles/iot-edge/how-to-deploy-at-scale.md
+3-4Lines changed: 3 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,7 +3,7 @@ title: Deploy modules at scale in Azure portal - Azure IoT Edge
3
3
description: Use the Azure portal to create automatic deployments for groups of IoT Edge devices
4
4
author: PatAltimore
5
5
ms.author: patricka
6
-
ms.date: 06/03/2024
6
+
ms.date: 06/12/2024
7
7
ms.topic: conceptual
8
8
ms.service: iot-edge
9
9
services: iot-edge
@@ -68,10 +68,9 @@ To add custom code as a module, or to manually add an Azure service module, foll
68
68
69
69
1. In the **Container Registry Settings** section of the page, provide the credentials to access any private container registries that contain your module images.
70
70
1. In the **IoT Edge Modules** section of the page, select **Add**.
71
-
1. Choose one of the three types of modules from the drop-down menu:
71
+
1. Choose one of the types of modules from the drop-down menu:
72
72
73
-
***IoT Edge Module** - You provide the module name and container image URI. For example, the image URI for the sample SimulatedTemperatureSensor module is `mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0`. If the module image is stored in a private container registry, add the credentials on this page to access the image.
74
-
***Marketplace Module** - Modules hosted in the Azure Marketplace. Some marketplace modules require additional configuration, so review the module details in the [Azure Marketplace IoT Edge Modules](https://azuremarketplace.microsoft.com/marketplace/apps/category/internet-of-things?page=1&subcategories=iot-edge-modules) list.
73
+
***IoT Edge Module** - You provide the module name and container image URI. For example, the image URI for the sample SimulatedTemperatureSensor module is `mcr.microsoft.com/azureiotedge-simulated-temperature-sensor:1.0`. For a list of Microsoft IoT Edge module images, see the [Microsoft Artifact Registry](https://mcr.microsoft.com/catalog?cat=IoT%20Edge%20Modules&alphaSort=asc&alphaSortKey=Name).
75
74
***Azure Stream Analytics Module** - Modules generated from an Azure Stream Analytics workload.
76
75
77
76
1. If needed, repeat steps 2 and 3 to add additional modules to your deployment.
@@ -58,7 +56,7 @@ A deployment manifest is a JSON document that describes which modules to deploy,
58
56
Don't select **Add** until you've specified values on the **Module Settings**, **Container Create Options**, and **Module Twin Settings** tabs as described in this procedure.
59
57
60
58
> [!IMPORTANT]
61
-
> Azure IoT Edge is case-sensitive when you make calls to modules, and the Storage SDK also defaults to lowercase. Although the name of the module in the [Azure Marketplace](how-to-deploy-modules-portal.md#deploy-modules-from-azure-marketplace) is **AzureBlobStorageonIoTEdge**, changing the name to lowercase helps to ensure that your connections to the Azure Blob Storage on IoT Edge module aren't interrupted.
59
+
> Azure IoT Edge is case-sensitive when you make calls to modules, and the Storage SDK also defaults to lowercase. Changing the name to lowercase helps to ensure that your connections to the Azure Blob Storage on IoT Edge module aren't interrupted.
0 commit comments