Skip to content

Commit 25b3731

Browse files
Merge pull request #250537 from PatAltimore/patricka-layered-blob-storage
Clarify blob storage module requirement
2 parents affc1c2 + d6f8acc commit 25b3731

File tree

1 file changed

+7
-8
lines changed

1 file changed

+7
-8
lines changed

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

Lines changed: 7 additions & 8 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,6 @@
11
---
2-
title: Configure API proxy module for Azure IoT Edge
2+
title: Configure API proxy module
3+
titlesuffix: Azure IoT Edge
34
description: Learn how to customize the API proxy module for IoT Edge gateway hierarchies.
45
author: PatAltimore
56

@@ -48,8 +49,8 @@ Currently, the default environment variables include:
4849

4950
| Environment variable | Description |
5051
| -------------------- | ----------- |
51-
| `PROXY_CONFIG_ENV_VAR_LIST` | List all the variables that you intend to update in a comma-separated list. This step prevents accidentally modifying the wrong configuration settings.
52-
| `NGINX_DEFAULT_TLS` | Specifies the list of TLS protocol(s) to be enabled. See NGINX's [ssl_protocols](https://nginx.org/docs/http/ngx_http_ssl_module.html#ssl_protocols).<br><br>Default is 'TLSv1.2'. |
52+
| `PROXY_CONFIG_ENV_VAR_LIST` | List all the variables that you intend to update in a comma-separated list. This step prevents accidentally modifying the wrong configuration settings. |
53+
| `NGINX_DEFAULT_TLS` | Specifies the list of TLS protocols to be enabled. See NGINX's [ssl_protocols](https://nginx.org/docs/http/ngx_http_ssl_module.html#ssl_protocols).<br><br>Default is 'TLSv1.2'. |
5354
| `NGINX_DEFAULT_PORT` | Changes the port that the nginx proxy listens to. If you update this environment variable, you must expose the port in the module dockerfile and declare the port binding in the deployment manifest. For more information, see [Expose proxy port](#expose-proxy-port).<br><br>Default is 443.<br><br>When deployed from the Azure Marketplace, the default port is updated to 8000, to prevent conflicts with the edgeHub module. For more information, see [Minimize open ports](#minimize-open-ports). |
5455
| `DOCKER_REQUEST_ROUTE_ADDRESS` | Address to route docker requests. Modify this variable on the top layer device to point to the registry module.<br><br>Default is the parent hostname. |
5556
| `BLOB_UPLOAD_ROUTE_ADDRESS` | Address to route blob registry requests. Modify this variable on the top layer device to point to the blob storage module.<br><br>Default is the parent hostname. |
@@ -141,7 +142,7 @@ Configure the following modules at the **top layer**:
141142

142143
Configure the following module on any **lower layer** for this scenario:
143144

144-
* An API proxy module
145+
* API proxy module. The API proxy module is required on all lower layer devices except the bottom layer device.
145146
* Configure the following environment variables:
146147

147148
| Name | Value |
@@ -168,7 +169,7 @@ Configure the following module on any **lower layer** for this scenario:
168169

169170
Port 8000 is exposed by default from the docker image. If a different nginx proxy port is used, add the **ExposedPorts** section declaring the port in the deployment manifest. For example, if you change the nginx proxy port to 8001, add the following to the deployment manifest:
170171

171-
```
172+
```json
172173
{
173174
"ExposedPorts": {
174175
"8001/tcp": {}
@@ -189,9 +190,7 @@ Port 8000 is exposed by default from the docker image. If a different nginx prox
189190

190191
Another use case for the API proxy module is to enable IoT Edge devices in lower layers to upload blobs. This use case enables troubleshooting functionality on lower layer devices like uploading module logs or uploading the support bundle.
191192

192-
This scenario uses the [Azure Blob Storage on IoT Edge](https://azuremarketplace.microsoft.com/marketplace/apps/azure-blob-storage.edge-azure-blob-storage) module at the top layer to handle blob creation and upload.
193-
194-
In a nested scenario, up to five layers are supported. Each upstream IoT Edge device in the nested hierarchy requires the *Azure Blob Storage on IoT Edge* module. For a sample multi-layer deployment, see the [Azure IoT Edge for Industrial IoT](https://github.com/Azure-Samples/iot-edge-for-iiot) sample.
193+
This scenario uses the [Azure Blob Storage on IoT Edge](https://azuremarketplace.microsoft.com/marketplace/apps/azure-blob-storage.edge-azure-blob-storage) module at the top layer to handle blob creation and upload. In a nested scenario, up to five layers are supported. The *Azure Blob Storage on IoT Edge* module is required on the top layer device and optional for lower layer devices. For a sample multi-layer deployment, see the [Azure IoT Edge for Industrial IoT](https://github.com/Azure-Samples/iot-edge-for-iiot) sample.
195194

196195
Configure the following modules at the **top layer**:
197196

0 commit comments

Comments
 (0)