Skip to content

Commit 64b72f9

Browse files
authored
Merge pull request #113988 from kgremban/may5-53279
iotedge check connectivity errors behind proxy
2 parents fc0037d + 7ace0ce commit 64b72f9

File tree

3 files changed

+13
-6
lines changed

3 files changed

+13
-6
lines changed

articles/iot-edge/how-to-install-iot-edge-linux.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -279,7 +279,7 @@ Examine daemon logs:
279279
journalctl -u iotedge --no-pager --no-full
280280
```
281281
282-
Run an automated check for the most common configuration and networking errors:
282+
Run the [troubleshooting tool](troubleshoot.md#run-the-check-command) to check for the most common configuration and networking errors:
283283
284284
```bash
285285
sudo iotedge check

articles/iot-edge/how-to-install-iot-edge-windows.md

Lines changed: 6 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -188,18 +188,22 @@ Examine service logs from the last 5 minutes. If you just finished installing th
188188
. {Invoke-WebRequest -useb https://aka.ms/iotedge-win} | Invoke-Expression; Get-IoTEdgeLog
189189
```
190190

191-
Run an automated check for the most common configuration and networking errors.
191+
Run the [troubleshooting tool](troubleshoot.md#run-the-check-command) to check for the most common configuration and networking errors.
192192

193193
```powershell
194194
iotedge check
195195
```
196196

197-
List running modules. After a new installation, the only module you should see running is **edgeAgent**. After you [deploy IoT Edge modules](how-to-deploy-modules-portal.md) for the first time, the other system module, **edgeHub**, will start on the device too.
197+
Until you deploy your first module to IoT Edge on your device, the **$edgeHub** system module will not be deployed to the device. As a result, the automated check will return an error for the `Edge Hub can bind to ports on host` connectivity check. This error can be ignored unless it occurs after deploying a module to the device.
198+
199+
Finally, list running modules:
198200

199201
```powershell
200202
iotedge list
201203
```
202204

205+
After a new installation, the only module you should see running is **edgeAgent**. After you [deploy IoT Edge modules](how-to-deploy-modules-portal.md) for the first time, the other system module, **edgeHub**, will start on the device too.
206+
203207
## Manage module containers
204208

205209
The IoT Edge service requires a container engine running on your device. When you deploy a module to a device, the IoT Edge runtime uses the container engine to pull the container image from a registry in the cloud. The IoT Edge service enables you to interact with your modules and retrieve logs, but sometimes you may want to use the container engine to interact with the container itself.

articles/iot-edge/troubleshoot.md

Lines changed: 6 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,9 @@ If you experience issues running Azure IoT Edge in your environment, use this ar
1818

1919
Your first step when troubleshooting IoT Edge should be to use the `check` command, which runs a collection of configuration and connectivity tests for common issues. The `check` command is available in [release 1.0.7](https://github.com/Azure/azure-iotedge/releases/tag/1.0.7) and later.
2020

21+
>[!NOTE]
22+
>The troubleshooting tool can't run connectivity checks if the IoT Edge device is behind a proxy server.
23+
2124
You can run the `check` command as follows, or include the `--help` flag to see a complete list of options:
2225

2326
On Linux:
@@ -34,9 +37,9 @@ iotedge check
3437

3538
The troubleshooting tool runs many checks that are sorted into these three categories:
3639

37-
* Configuration checks: Examines details that could prevent IoT Edge devices from connecting to the cloud, including issues with *config.yaml* and the container engine.
38-
* Connection checks: Verifies the IoT Edge runtime can access ports on the host device and all the IoT Edge components can connect to the IoT Hub.
39-
* Production readiness checks: Looks for recommended production best practices, such as the state of device certificate authority (CA) certificates and module log file configuration.
40+
* *Configuration checks* examines details that could prevent IoT Edge devices from connecting to the cloud, including issues with *config.yaml* and the container engine.
41+
* *Connection checks* verify that the IoT Edge runtime can access ports on the host device and that all the IoT Edge components can connect to the IoT Hub. This set of checks returns errors if the IoT Edge device is behind a proxy.
42+
* *Production readiness checks* look for recommended production best practices, such as the state of device certificate authority (CA) certificates and module log file configuration.
4043

4144
For information about each of the diagnostic checks this tool runs, including what to do if you get an error or warning, see [IoT Edge troubleshoot checks](https://github.com/Azure/iotedge/blob/master/doc/troubleshoot-checks.md).
4245

0 commit comments

Comments
 (0)