Skip to content

Commit 52f65d0

Browse files
committed
Fixed things based on review
1 parent ef385aa commit 52f65d0

File tree

3 files changed

+38
-31
lines changed

3 files changed

+38
-31
lines changed

articles/iot-edge/how-to-provision-single-device-linux-symmetric.md

Lines changed: 29 additions & 22 deletions
Original file line numberDiff line numberDiff line change
@@ -15,7 +15,7 @@ ms.author: patricka
1515

1616
This article provides end-to-end instructions for registering and provisioning a Linux IoT Edge device, which includes installing IoT Edge.
1717

18-
Each device that connects to an [IoT hub](/azure/iot-hub/) has a device ID that's used to track [cloud-to-device](/azure/iot-hub/iot-hub-devguide-c2d-guidance) or [device-to-cloud](/azure/iot-hub/iot-hub-devguide-d2c-guidance) communications. You configure a device with its connection information, which includes:
18+
Each device that connects to an [IoT hub](../iot-hub/index.yml) has a device ID that's used to track [cloud-to-device](..iot-hub/iot-hub-devguide-c2d-guidance.md) or [device-to-cloud](../iot-hub/iot-hub-devguide-d2c-guidance.md) communications. You configure a device with its connection information, which includes:
1919

2020
* IoT hub hostname
2121
* Device ID
@@ -130,10 +130,26 @@ After entering the provisioning information in the configuration file, restart t
130130
```bash
131131
sudo nano /etc/aziot/config.toml
132132
```
133-
133+
Verify successful configuration
134134
<!-- end iotedge-2020-11 -->
135135
::: moniker-end
136136

137+
## Deploy modules
138+
139+
To deploy your IoT Edge modules, go to your IoT hub in the Azure portal, then:
140+
141+
1. Select **Devices** from the IoT Hub menu.
142+
143+
1. Select your device to open its page.
144+
145+
1. Select the **Set Modules** tab.
146+
147+
1. Since we want to deploy the IoT Edge default modules (edgeAgent and edgeHub), we don't need to add any modules to this pane, so select **Review + create** at the bottom.
148+
149+
1. You see the JSON confirmation of your modules. Select **Create** to deploy the modules.<br>
150+
151+
For more information, see [Deploy a module](/quickstart-linux#deploy-a-module.md).
152+
137153
## Verify successful configuration
138154

139155
Verify that the runtime was successfully installed and configured on your IoT Edge device.
@@ -143,25 +159,25 @@ Verify that the runtime was successfully installed and configured on your IoT Ed
143159
144160
1. Check to see that the IoT Edge system service is running.
145161

146-
<!-- 1.1 -->
147-
::: moniker range="iotedge-2018-06"
162+
<!-- 1.1 -->
163+
::: moniker range="iotedge-2018-06"
148164

149165
```bash
150166
sudo systemctl status iotedge
151167
```
152168

153-
::: moniker-end
169+
::: moniker-end
154170

155-
<!-- iotedge-2020-11 -->
156-
::: moniker range=">=iotedge-2020-11"
171+
<!-- iotedge-2020-11 -->
172+
::: moniker range=">=iotedge-2020-11"
157173

158174
```bash
159175
sudo iotedge system status
160176
```
161177

162-
A successful status response is `Ok`.
178+
A successful status response shows the `aziot` services as running or ready.
163179

164-
::: moniker-end
180+
::: moniker-end
165181

166182
1. To troubleshoot the service, retrieve the service logs.
167183

@@ -198,20 +214,14 @@ Verify that the runtime was successfully installed and configured on your IoT Ed
198214
199215
>[!NOTE]
200216
>On a newly provisioned device, you may see an error related to IoT Edge Hub:
217+
>
201218
>**× production readiness: Edge Hub's storage directory is persisted on the host filesystem - Error**
202219
>**Could not check current state of edgeHub container**
203220
>
204-
>This error is expected on a newly provisioned device because the IoT Edge Hub module is not yet running. You need to deploy your device and then deploy the IoT Edge modules.
221+
>This error is expected on a newly provisioned device because the IoT Edge Hub module is not yet running. Be sure your IoT Edge modules were deployed in the previous steps. Deployment resolves this error.
205222
>
206-
>Use the `az deployment group create` command to deploy your device. For more information, see [Deploy the IoT Edge device](quickstart-linux.md#deploy-the-iot-edge-device).
223+
>Alternatively, you may see a status code as `417 -- The device's deployment configuration is not set`. Once your modules are deployed, this status will change.
207224
>
208-
>To deploy your IoT Edge modules, go to your IoT hub in the Azure portal, then:
209-
>1. Select **Devices** from the IoT Hub menu.
210-
>1. Select your device to open its page.
211-
>1. Select the **Set Modules** tab.
212-
>1. Since we want to deploy the IoT Edge default modules (edgeAgent and edgeHub), we don't need to add any modules to this pane, so select **Review + create** at the bottom.
213-
>1. You see the JSON confirmation of your modules. Select **Create** to deploy the modules.
214-
>For more information, see [Deploy a module](/quickstart-linux#deploy-a-module.md).
215225
216226
1. When the service starts for the first time, you should only see the **edgeAgent** module running. The edgeAgent module runs by default and helps to install and start any additional modules that you deploy to your device.
217227

@@ -225,17 +235,14 @@ Verify that the runtime was successfully installed and configured on your IoT Ed
225235
sudo iotedge list
226236
```
227237

228-
>[!NOTE]
229-
>When you create a new IoT Edge device, it will display the status code `417 -- The device's deployment configuration is not set` in the Azure portal. This status is normal, and means that the device is ready to receive a module deployment.
230-
231238
## Offline or specific version installation (optional)
232239

233240
The steps in this section are for scenarios not covered by the standard installation steps. This may include:
234241

235242
* Installing IoT Edge while offline
236243
* Installing a release candidate version
237244

238-
Use the steps in this section if you want to install a specific version of the Azure IoT Edge runtime that isn't available through your package manager. The Microsoft package list only contains a limited set of recent versions and their sub-versions, so these steps are for anyone who wants to install an older version or a release candidate version.
245+
Use the steps in this section if you want to install a [specific version of the Azure IoT Edge runtime](version-history.md) that isn't available through your package manager. The Microsoft package list only contains a limited set of recent versions and their sub-versions, so these steps are for anyone who wants to install an older version or a release candidate version.
239246

240247
Using curl commands, you can target the component files directly from the IoT Edge GitHub repository.
241248

articles/iot-edge/includes/iot-edge-install-linux.md

Lines changed: 5 additions & 5 deletions
Original file line numberDiff line numberDiff line change
@@ -64,7 +64,7 @@ Installing can be done with a few commands. Open a terminal and run the followin
6464

6565
---
6666

67-
For more information about operating system versions, see [Azure IoT Edge supported platforms](/support?#linux-containers).
67+
For more information about operating system versions, see [Azure IoT Edge supported platforms](../support.md?#linux-containers).
6868

6969
> [!NOTE]
7070
> Azure IoT Edge software packages are subject to the license terms located in each package (`usr/share/doc/{package-name}` or the `LICENSE` directory). Read the license terms prior to using a package. Your installation and use of a package constitutes your acceptance of these terms. If you don't agree with the license terms, don't use that package.
@@ -137,7 +137,7 @@ The following steps show you how to configure your container to use [`local` log
137137

138138
The IoT Edge security daemon provides and maintains security standards on the IoT Edge device. The daemon starts on every boot and bootstraps the device by starting the rest of the IoT Edge runtime.
139139

140-
The steps in this section represent the typical process to install the latest version on a device that has internet connection. If you need to install a specific version, like a pre-release version, or need to install while offline, follow the [Offline or specific version installation](/how-to-provision-single-device-linux-symmetric#offline-or-specific-version-installation-optional) steps later in this article.
140+
The steps in this section represent the typical process to install the latest version on a device that has internet connection. If you need to install a specific version, like a pre-release version, or need to install while offline, follow the **Offline or specific version installation** steps later in this article.
141141

142142
Install IoT Edge version 1.1.* along with the **libiothsm-std** package:
143143

@@ -175,10 +175,10 @@ The IoT Edge service provides and maintains security standards on the IoT Edge d
175175
> [!NOTE]
176176
> Beginning with version 1.2, the [IoT identity service](https://azure.github.io/iot-identity-service/) handles identity provisioning and management for IoT Edge and for other device components that need to communicate with IoT Hub.
177177
178-
The steps in this section represent the typical process to install the latest IoT Edge version on a device that has internet connection. If you need to install a specific version, like a pre-release version, or need to install while offline, follow the [Offline or specific version installation](/how-to-provision-single-device-linux-symmetric#offline-or-specific-version-installation-optional) steps later in this article.
178+
The steps in this section represent the typical process to install the latest IoT Edge version on a device that has internet connection. If you need to install a specific version, like a pre-release version, or need to install while offline, follow the **Offline or specific version installation** steps later in this article.
179179
180180
> [!TIP]
181-
> If you already have an IoT Edge device running an older version and want to upgrade to the latest release, use the steps in [Update the IoT Edge security daemon and runtime](/articles/iot-edge/how-to-update-iot-edge.md). Later versions are sufficiently different from previous versions of IoT Edge that specific steps are necessary to upgrade.
181+
> If you already have an IoT Edge device running an older version and want to upgrade to the latest release, use the steps in [Update the IoT Edge security daemon and runtime](../how-to-update-iot-edge.md). Later versions are sufficiently different from previous versions of IoT Edge that specific steps are necessary to upgrade.
182182
183183
# [Ubuntu](#tab/ubuntu)
184184
@@ -204,7 +204,7 @@ The defender-iot-micro-agent-edge package includes the Microsoft Defender for Io
204204
205205
# [Red Hat Enterprise Linux](#tab/rhel)
206206
207-
Install the latest version of IoT Edge and the IoT identity service package (if you're not already [up-to-date](/version-history.md)):
207+
Install the latest version of IoT Edge and the IoT identity service package (if you're not already [up-to-date](../version-history.md)):
208208

209209
```bash
210210
sudo yum install aziot-edge

articles/iot-edge/includes/iot-edge-register-device-symmetric.md

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -89,7 +89,7 @@ Now that you have a device registered in IoT Hub, you can retrieve provisioning
8989

9090
## View registered devices and retrieve provisioning information
9191

92-
Devices that use symmetric key authentication need their connection strings to complete installation and provisioning of the IoT Edge runtime. The connection string was generated for your IoT Edge device when you created it. For Visual Studio Code and Azure CLI, the connection string is in the JSON printout. If you used the Azure portal to create your device, you can find the connection string from the device itself. When you select your device in your IoT hub, it's listed as `Primary connection string` on the device page.
92+
Devices that use symmetric key authentication need their connection strings to complete installation and provisioning of the IoT Edge runtime. The connection string gets generated for your IoT Edge device when you create the device. For Visual Studio Code and Azure CLI, the connection string is in the JSON output. If you use the Azure portal to create your device, you can find the connection string from the device itself. When you select your device in your IoT hub, it's listed as `Primary connection string` on the device page.
9393

9494
# [Portal](#tab/azure-portal)
9595

@@ -125,19 +125,19 @@ To see all devices in your IoT hub, use the [az iot hub device-identity list](/c
125125
az iot hub device-identity list --hub-name hub_name_here
126126
```
127127

128-
Any device that is registered as an IoT Edge device will have the property **capabilities.iotEdge** set to **true**. You will see a lot of other metadata as a JSON printout, including your device IDs.
128+
Any device that is registered as an IoT Edge device will have the property **capabilities.iotEdge** set to **true**. You see a lot of other metadata as JSON output as well, including your device IDs.
129129

130130
When you're ready to set up your device, you need its connection string that links your physical device with its identity in the IoT hub. Use the following [az iot hub device-identity connection-string show](/cli/azure/iot/hub/device-identity/connection-string) command to return the connection string for a single device. Replace `[device_id]` and `[hub_name]` with your own values. The value for the `device-identity` parameter is case-sensitive.
131131

132132
```azurecli
133133
az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]
134134
```
135135

136-
You should see a JSON printout in the console, similar to the following:
136+
You should see JSON output in the console, similar to the following:
137137

138138
```json
139139
{
140-
"connectionString": "HostName=my-iot-hub.azure-devices.net;DeviceId=my-edge-device-1;SharedAccessKey=saQ02bt6BBUlRcdsqWuxPMAx4ysQwWEb5+1eidwzHPY="
140+
"connectionString": "HostName=my-iot-hub.azure-devices.net;DeviceId=my-edge-device-1;SharedAccessKey=saQ52bt6BBUlRfusqWuxPMAx4ysQwWEb5+1eidwzHPY="
141141
}
142142
```
143143

0 commit comments

Comments
 (0)