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-provision-single-device-linux-symmetric.md
+29-22Lines changed: 29 additions & 22 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -15,7 +15,7 @@ ms.author: patricka
15
15
16
16
This article provides end-to-end instructions for registering and provisioning a Linux IoT Edge device, which includes installing IoT Edge.
17
17
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:
19
19
20
20
* IoT hub hostname
21
21
* Device ID
@@ -130,10 +130,26 @@ After entering the provisioning information in the configuration file, restart t
130
130
```bash
131
131
sudo nano /etc/aziot/config.toml
132
132
```
133
-
133
+
Verify successful configuration
134
134
<!-- end iotedge-2020-11 -->
135
135
::: moniker-end
136
136
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
+
137
153
## Verify successful configuration
138
154
139
155
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
143
159
144
160
1. Check to see that the IoT Edge system service is running.
145
161
146
-
<!-- 1.1 -->
147
-
::: moniker range="iotedge-2018-06"
162
+
<!-- 1.1 -->
163
+
::: moniker range="iotedge-2018-06"
148
164
149
165
```bash
150
166
sudo systemctl status iotedge
151
167
```
152
168
153
-
::: moniker-end
169
+
::: moniker-end
154
170
155
-
<!-- iotedge-2020-11 -->
156
-
::: moniker range=">=iotedge-2020-11"
171
+
<!-- iotedge-2020-11 -->
172
+
::: moniker range=">=iotedge-2020-11"
157
173
158
174
```bash
159
175
sudo iotedge system status
160
176
```
161
177
162
-
A successful status response is `Ok`.
178
+
A successful status response shows the `aziot` services as running or ready.
163
179
164
-
::: moniker-end
180
+
::: moniker-end
165
181
166
182
1. To troubleshoot the service, retrieve the service logs.
167
183
@@ -198,20 +214,14 @@ Verify that the runtime was successfully installed and configured on your IoT Ed
198
214
199
215
>[!NOTE]
200
216
>On a newly provisioned device, you may see an error related to IoT Edge Hub:
217
+
>
201
218
>**× production readiness: Edge Hub's storage directory is persisted on the host filesystem - Error**
202
219
>**Could not check current state of edgeHub container**
203
220
>
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.
205
222
>
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.
207
224
>
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).
215
225
216
226
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.
217
227
@@ -225,17 +235,14 @@ Verify that the runtime was successfully installed and configured on your IoT Ed
225
235
sudo iotedge list
226
236
```
227
237
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
-
231
238
## Offline or specific version installation (optional)
232
239
233
240
The steps in this section are for scenarios not covered by the standard installation steps. This may include:
234
241
235
242
* Installing IoT Edge while offline
236
243
* Installing a release candidate version
237
244
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.
239
246
240
247
Using curl commands, you can target the component files directly from the IoT Edge GitHub repository.
Copy file name to clipboardExpand all lines: articles/iot-edge/includes/iot-edge-install-linux.md
+5-5Lines changed: 5 additions & 5 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -64,7 +64,7 @@ Installing can be done with a few commands. Open a terminal and run the followin
64
64
65
65
---
66
66
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).
68
68
69
69
> [!NOTE]
70
70
> 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
137
137
138
138
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.
139
139
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.
141
141
142
142
Install IoT Edge version 1.1.* along with the **libiothsm-std** package:
143
143
@@ -175,10 +175,10 @@ The IoT Edge service provides and maintains security standards on the IoT Edge d
175
175
> [!NOTE]
176
176
> 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.
177
177
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.
179
179
180
180
> [!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.
182
182
183
183
# [Ubuntu](#tab/ubuntu)
184
184
@@ -204,7 +204,7 @@ The defender-iot-micro-agent-edge package includes the Microsoft Defender for Io
204
204
205
205
# [Red Hat Enterprise Linux](#tab/rhel)
206
206
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)):
Copy file name to clipboardExpand all lines: articles/iot-edge/includes/iot-edge-register-device-symmetric.md
+4-4Lines changed: 4 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -89,7 +89,7 @@ Now that you have a device registered in IoT Hub, you can retrieve provisioning
89
89
90
90
## View registered devices and retrieve provisioning information
91
91
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.
93
93
94
94
# [Portal](#tab/azure-portal)
95
95
@@ -125,19 +125,19 @@ To see all devices in your IoT hub, use the [az iot hub device-identity list](/c
125
125
az iot hub device-identity list --hub-name hub_name_here
126
126
```
127
127
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.
129
129
130
130
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.
131
131
132
132
```azurecli
133
133
az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]
134
134
```
135
135
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:
0 commit comments