Skip to content

Commit 2372331

Browse files
Merge pull request #271486 from PatAltimore/patricka-marketplace
Remove add marketplace module
2 parents 868b4c2 + 43a4499 commit 2372331

18 files changed

+184
-126
lines changed

articles/iot-edge/about-iot-edge.md

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ author: PatAltimore
55
ms.service: iot-edge
66
services: iot-edge
77
ms.topic: overview
8-
ms.date: 06/05/2024
8+
ms.date: 06/12/2024
99
ms.author: patricka
1010
ms.custom: mvc
1111
---
@@ -18,7 +18,7 @@ Azure IoT Edge is a device-focused runtime that enables you to deploy, run, and
1818

1919
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.
2020

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.
2222

2323
Azure IoT Edge is made up of three components:
2424

@@ -35,7 +35,7 @@ IoT Edge modules are units of execution, implemented as Docker-compatible contai
3535

3636
### Artificial intelligence at the edge
3737

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.
3939

4040
### Bring your own code
4141

articles/iot-edge/how-to-collect-and-transport-metrics.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -58,9 +58,7 @@ To configure monitoring on your IoT Edge device, follow the [Tutorial: Monitor I
5858

5959
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).
6060

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).
6462

6563
## Metrics collector configuration
6664

articles/iot-edge/how-to-configure-api-proxy-module.md

Lines changed: 2 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -5,7 +5,7 @@ description: Learn how to customize the API proxy module for IoT Edge gateway hi
55
author: PatAltimore
66

77
ms.author: patricka
8-
ms.date: 07/06/2023
8+
ms.date: 06/12/2024
99
ms.topic: conceptual
1010
ms.service: iot-edge
1111
services: iot-edge
@@ -29,9 +29,7 @@ Without the API proxy, each service module would have to bind to a separate port
2929
3030
## Deploy the proxy module
3131

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).
3533

3634
## Understand the proxy module
3735

articles/iot-edge/how-to-connect-downstream-iot-edge-device.md

Lines changed: 52 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -607,10 +607,19 @@ The API proxy module was designed to be customized to handle most common gateway
607607
1. Select **Devices** under the **Device management** menu.
608608
1. Select the top layer IoT Edge device that you're configuring from the list.
609609
1. Select **Set modules**.
610-
1. In the **IoT Edge modules** section, select **Add** then choose **Marketplace module**.
611-
1. Search for and select the **IoT Edge API Proxy** module.
612-
1. Select the name of the API proxy module from the list of deployed modules and update the following module settings:
613-
1. In the **Environment variables** tab, update the value of **NGINX_DEFAULT_PORT** to `443`.
610+
1. In the **IoT Edge modules** section, select **Add** then choose **IoT Edge Module**.
611+
1. Update the following module settings:
612+
613+
| Setting | Value |
614+
|--------------------|---------------------------------------------------|
615+
| IoT Module name | `IoTEdgeAPIProxy` |
616+
| 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`.
614623
1. In the **Container create options** tab, update the port bindings to reference port 443.
615624
616625
```json
@@ -628,8 +637,8 @@ The API proxy module was designed to be customized to handle most common gateway
628637
```
629638
630639
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.
633642
634643
```json
635644
{
@@ -650,34 +659,39 @@ The API proxy module was designed to be customized to handle most common gateway
650659
}
651660
```
652661
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.
659664
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**.
661666
662-
The registry module can only map to one container registry, so we recommend having all container images in a single private container registry.
667+
| Setting | Value |
668+
|--------------------|---------------------------------------------------|
669+
| IoT Module name | `registry` |
670+
| Image URI | `registry:latest` |
671+
| Restart policy | `always` |
672+
| Desired status | `running` |
663673
664-
* **Name**: `REGISTRY_PROXY_USERNAME` **Value**: Username to authenticate to the container registry.
674+
1. In the **Environment variables** tab, add the following variables:
665675
666-
* **Name**: `REGISTRY_PROXY_PASSWORD` **Value**: Password to authenticate to the container registry.
676+
| Name | Type | Value |
677+
|------------------------|-------|---------------------------------------------------------|
678+
| `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. |
667681
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.
669683
670684
```json
671685
{
672-
"HostConfig": {
673-
"PortBindings": {
674-
"5000/tcp": [
675-
{
676-
"HostPort": "5000"
677-
}
678-
]
686+
"HostConfig": {
687+
"PortBindings": {
688+
"5000/tcp": [
689+
{
690+
"HostPort": "5000"
679691
}
692+
]
680693
}
694+
}
681695
}
682696
```
683697
@@ -839,11 +853,19 @@ The API proxy module was designed to be customized to handle most common gateway
839853
1. Select **Devices** under the **Device management** menu.
840854
1. Select the lower layer IoT Edge device that you're configuring from the list.
841855
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**.
857+
1. Update the following module settings:
858+
859+
| Setting | Value |
860+
|--------------------|---------------------------------------------------|
861+
| IoT Module name | `IoTEdgeAPIProxy` |
862+
| 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`.
847869
1. In the **Container create options** tab, update the port bindings to reference port 443.
848870
849871
```json
@@ -890,7 +912,7 @@ The API proxy module was designed to be customized to handle most common gateway
890912
1. Update the edgeAgent module settings:
891913
1. In the **Image** field, replace `mcr.microsoft.com` with `$upstream:443`.
892914
893-
1. Select **Save** to save your changes to the runtime settings.
915+
1. Select **Apply** to save your changes to the runtime settings.
894916
1. Select **Next: Routes** to go to the next step.
895917
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:
896918
1. **Name**: `Route`

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

Lines changed: 3 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -3,7 +3,7 @@ title: Deploy modules at scale in Azure portal - Azure IoT Edge
33
description: Use the Azure portal to create automatic deployments for groups of IoT Edge devices
44
author: PatAltimore
55
ms.author: patricka
6-
ms.date: 06/03/2024
6+
ms.date: 06/12/2024
77
ms.topic: conceptual
88
ms.service: iot-edge
99
services: iot-edge
@@ -68,10 +68,9 @@ To add custom code as a module, or to manually add an Azure service module, foll
6868

6969
1. In the **Container Registry Settings** section of the page, provide the credentials to access any private container registries that contain your module images.
7070
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:
7272

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).
7574
* **Azure Stream Analytics Module** - Modules generated from an Azure Stream Analytics workload.
7675

7776
1. If needed, repeat steps 2 and 3 to add additional modules to your deployment.

articles/iot-edge/how-to-deploy-blob.md

Lines changed: 1 addition & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -48,8 +48,6 @@ A deployment manifest is a JSON document that describes which modules to deploy,
4848

4949
2. On the **Settings** tab, provide a name for the module and then specify the container image URI:
5050

51-
Examples:
52-
5351
- **IoT Edge Module Name**: `azureblobstorageoniotedge`
5452
- **Image URI**: `mcr.microsoft.com/azure-blob-storage:latest`
5553

@@ -58,7 +56,7 @@ A deployment manifest is a JSON document that describes which modules to deploy,
5856
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.
5957

6058
> [!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.
6260
6361
3. Open the **Container Create Options** tab.
6462

0 commit comments

Comments
 (0)