Skip to content

Commit a78f88d

Browse files
authored
Documentation enhancements for installation steps
Some suggested clarifications in the documentation after working through these directions myself and running into some confusion. Specifically addressing the following: - Make it clear that the `Install a specific runtime version` step is optional, if your application intentionally is intended to not run on the latest runtime - Make it clear that the `sudo iotedge check` call will return an Error when run at the time suggested in the steps, and that the error can be ignored
1 parent f3db7db commit a78f88d

File tree

1 file changed

+6
-4
lines changed

1 file changed

+6
-4
lines changed

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

Lines changed: 6 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -103,11 +103,11 @@ Install the security daemon. The package is installed at `/etc/iotedge/`.
103103
sudo apt-get install iotedge
104104
```
105105

106-
Once IoT Edge is successfully installed, the output will prompt you to update the configuration file. Follow the steps in the [Configure the Azure IoT Edge security daemon](#configure-the-security-daemon) section to finish provisioning your device.
106+
Once IoT Edge is successfully installed, the output will prompt you to update the configuration file. Follow the steps in the [Configure the security daemon](#configure-the-security-daemon) section to finish provisioning your device.
107107

108108
## Install a specific runtime version
109109

110-
If you want to install a specific version of the Azure IoT Edge runtime, you can target the component files directly from the IoT Edge GitHub repository. Use the following steps to get all of the IoT Edge components onto your device: the Moby engine and CLI, the libiothsm, and finally the IoT Edge security daemon.
110+
If you want to install a specific version of Moby and the Azure IoT Edge runtime instead of using the latest versions, you can target the component files directly from the IoT Edge GitHub repository. Use the following steps to get all of the IoT Edge components onto your device: the Moby engine and CLI, the libiothsm, and finally the IoT Edge security daemon. Skip to the next section, [Configure the security daemon](#configure-the-security-daemon), if you do not want to change to a specifc runtime version.
111111

112112
1. Navigate to the [Azure IoT Edge releases](https://github.com/Azure/azure-iotedge/releases), and find the release version that you want to target.
113113

@@ -260,13 +260,15 @@ Run an automated check for the most common configuration and networking errors:
260260
sudo iotedge check
261261
```
262262
263-
And, list running modules:
263+
>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` connectivty check. This error can be ingored unless it occurs after deploying a module to the device.
264+
265+
Finally, list running modules:
264266
265267
```bash
266268
sudo iotedge list
267269
```
268270
269-
After installing IoT Edge on your device, the only module you should see running is **edgeAgent**. Once you create your first deployment, the other system module **$edgeHub** will start on the device as well. For more information, see [deploy IoT Edge modules](how-to-deploy-modules-portal.md).
271+
>After installing IoT Edge on your device, the only module you should see running is **edgeAgent**. Once you create your first deployment, the other system module **$edgeHub** will start on the device as well. For more information, see [deploy IoT Edge modules](how-to-deploy-modules-portal.md).
270272
271273
## Tips and troubleshooting
272274

0 commit comments

Comments
 (0)