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/how-to-configure-api-proxy-module.md
+6-7Lines changed: 6 additions & 7 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -1,5 +1,6 @@
1
1
---
2
-
title: Configure API proxy module for Azure IoT Edge
2
+
title: Configure API proxy module
3
+
titlesuffix: Azure IoT Edge
3
4
description: Learn how to customize the API proxy module for IoT Edge gateway hierarchies.
4
5
author: PatAltimore
5
6
@@ -48,8 +49,8 @@ Currently, the default environment variables include:
48
49
49
50
| Environment variable | Description |
50
51
| -------------------- | ----------- |
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'. |
53
54
|`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). |
54
55
|`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. |
55
56
|`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. |
@@ -168,7 +169,7 @@ Configure the following module on any **lower layer** for this scenario:
168
169
169
170
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:
170
171
171
-
```
172
+
```json
172
173
{
173
174
"ExposedPorts": {
174
175
"8001/tcp": {}
@@ -189,9 +190,7 @@ Port 8000 is exposed by default from the docker image. If a different nginx prox
189
190
190
191
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.
191
192
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.
195
194
196
195
Configure the following modules at the **top layer**:
0 commit comments