Skip to content

Commit 3eef3eb

Browse files
committed
reorg install-configure
1 parent 582a990 commit 3eef3eb

File tree

2 files changed

+47
-30
lines changed

2 files changed

+47
-30
lines changed

articles/iot-hub-device-update/device-update-agent-overview.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -36,7 +36,7 @@ The [Device Update core interface](https://github.com/Azure/iot-plugandplay-mode
3636

3737
### Device information interface
3838

39-
The [device information interface](https://github.com/Azure/iot-plugandplay-models/blob/main/dtmi/azure/devicemanagement/deviceinformation-1.json) implements the Azure IoT `DeviceInformation` interface.
39+
The [device information interface](https://github.com/Azure/iot-plugandplay-models/blob/main/dtmi/azure/devicemanagement/deviceinformation-1.json) implements the Azure IoT Plug and Play (PnP) `DeviceInformation` interface.
4040

4141
### Diagnostic information interface
4242

articles/iot-hub-device-update/device-update-agent-provisioning.md

Lines changed: 46 additions & 29 deletions
Original file line numberDiff line numberDiff line change
@@ -20,7 +20,7 @@ The Device Update module agent can run along with other system processes and [Io
2020

2121
You can create up to 50 module identities under each Azure IoT Hub device identity. Each module identity implicitly generates a module identity twin. On the device side, you can use the IoT Hub device SDKs to create modules that each open an independent connection to IoT Hub.
2222

23-
module identity and module identity twin provide similar capabilities to device identity and device twin, but at a finer granularity. For more information, see [Understand and use module twins in IoT Hub](../iot-hub/iot-hub-devguide-module-twins.md).
23+
Module identity and module identity twin provide similar capabilities to device identity and device twin, but at a finer granularity. For more information, see [Understand and use module twins in IoT Hub](../iot-hub/iot-hub-devguide-module-twins.md).
2424

2525
When you provision the Device Update agent as a module identity, all [communications](device-update-plug-and-play.md) between the device and the Device Update service must happen over the Module Twin. Remember to tag the Module Twin of the device when you create [device groups](device-update-groups.md). If you migrate from a device-level agent to adding the agent as a module identity, remove the older agent that communicated over the device twin.
2626

@@ -37,9 +37,11 @@ Device Update supports the following IoT device over the air update types:
3737

3838
## Prepare for package updates
3939

40-
To prepare an IoT device or IoT Edge device to install [package based updates](./understand-device-update.md#support-for-a-wide-range-of-update-artifacts), add `packages.microsoft.com` to your machine's repositories by following these steps:
40+
To set up an IoT device or IoT Edge device to install [package based updates](./understand-device-update.md#support-for-a-wide-range-of-update-artifacts), add `packages.microsoft.com` to your machine's repositories by following these steps:
4141

42-
1. In a Terminal window on the machine or IoT device where you want to install the Device Update agent, install the repository configuration that matches your device's operating system, for example:
42+
1. Open a Terminal window on the machine or IoT device where you want to install the Device Update agent.
43+
44+
1. Install the repository configuration that matches your device's operating system, for example:
4345

4446
```shell
4547
curl https://packages.microsoft.com/config/ubuntu/18.04/multiarch/prod.list > ./microsoft-prod.list
@@ -61,52 +63,67 @@ To prepare an IoT device or IoT Edge device to install [package based updates](.
6163
sudo cp ./microsoft.gpg /etc/apt/trusted.gpg.d/
6264
```
6365

64-
Update package lists on your device by running `sudo apt-get update`.
66+
## Provision the Device Update agent
6567

66-
<a name="on-iot-edge-enabled-devices"></a>
67-
## Install and provision the agent
68+
You can provision the Device Update agent as a module identity on IoT Edge enabled devices or non-IoT Edge IoT devices. To check if you have IoT Edge enabled on your device, see [View registered devices and retrieve provisioning information](../iot-edge/how-to-provision-single-device-linux-symmetric.md?preserve-view=true&view=iotedge-2020-11#view-registered-devices-and-retrieve-provisioning-information).
6869

69-
You can download and unzip sample images from the **Assets** section on the [Releases](https://github.com/Azure/iot-hub-device-update/releases) page. In *Tutorial_RaspberryPi3.zip*, the *swUpdate* file is the base image that you can flash onto a Raspberry Pi B3+ board. The *.gz* file is the update you import through Device Update. For more information, see [Azure Device Update for IoT Hub using a Raspberry Pi image](./device-update-raspberry-pi.md#use-bmaptool-to-flash-the-sd-card).
70+
You can download and unzip sample images from the **Assets** section on the [Releases](https://github.com/Azure/iot-hub-device-update/releases) page. In *Tutorial_RaspberryPi3.zip*, the *swUpdate* file is the base image that you can flash onto a Raspberry Pi B3+ board. The *.gz* file is the update you can import through Device Update. For more information, see [Azure Device Update for IoT Hub using a Raspberry Pi image](./device-update-raspberry-pi.md#use-bmaptool-to-flash-the-sd-card).
7071

71-
- For release candidate (rc) agent versions, download the *.deb* file from [Releases](https://github.com/Azure/iot-hub-device-update/releases) to the machine you want to install the Device Update agent on, and then run the following command:
72+
### On IoT Edge enabled devices
7273

73-
```shell
74-
sudo apt-get install -y ./"<PATH TO FILE>"/"<.DEB FILE NAME>"
75-
```
74+
Follow these instructions to provision the Device Update agent on [IoT Edge enabled devices](../iot-edge/index.yml):
7675

77-
- If you're setting up a [Microsoft Connected Cache (MCC) for a disconnected device scenario](connected-cache-disconnected-device-update.md), install the Delivery Optimization APT plugin as follows:
76+
1. Follow the instructions at [Manually provision a single Linux IoT Edge device](../iot-edge/how-to-provision-single-device-linux-symmetric.md?preserve-view=true&view=iotedge-2020-11#install-iot-edge).
7877

79-
```shell
80-
sudo apt-get install deliveryoptimization-plugin-apt
81-
```
78+
1. Install the Device Update image update agent.
8279

83-
### Prepare the device
80+
1. Install the Device Update package update agent.
8481

85-
You can provision the Device Update agent as a module identity on IoT Edge enabled devices or non-IoT Edge IoT devices. To check if you have IoT Edge enabled on your device, see [View registered devices and retrieve provisioning information](../iot-edge/how-to-provision-single-device-linux-symmetric.md?preserve-view=true&view=iotedge-2020-11#view-registered-devices-and-retrieve-provisioning-information).
82+
- For latest agent versions from packages.microsoft.com, update package lists on your device and install the Device Update agent package and its dependencies using:
8683

87-
- For an [IoT Edge enabled device](../iot-edge/index.yml), follow the instructions at [Manually provision a single Linux IoT Edge device](../iot-edge/how-to-provision-single-device-linux-symmetric.md?preserve-view=true&view=iotedge-2020-11#install-iot-edge).
84+
```shell
85+
86+
sudo apt-get update
87+
```
8888

89-
- For a non-IoT Edge enabled device:
90-
1. Install the latest version of the IoT Identity Service by following instructions in [Installing the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/installation.html#install-from-packagesmicrosoftcom).
91-
1. Configure the IoT Identity Service by following the instructions in [Configuring the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/configuration.html).
89+
```shell
90+
91+
sudo apt-get install deviceupdate-agent
92+
```
9293

93-
### Install and configure the Device Update agent
94+
- For release candidate (rc) agent versions, download the *.deb* file from [Releases](https://github.com/Azure/iot-hub-device-update/releases) to the machine you want to install the Device Update agent on, and then run the following command:
9495

95-
1. Install the Device Update image update agent by running the following command:
96+
```shell
97+
sudo apt-get install -y ./"<PATH TO FILE>"/"<.DEB FILE NAME>"
98+
```
9699

97-
```shell
98-
sudo apt-get install deviceupdate-agent
99-
```
100+
- If you're setting up a [Microsoft Connected Cache (MCC) for a disconnected device scenario](connected-cache-disconnected-device-update.md), install the Delivery Optimization APT plugin as follows:
101+
102+
```shell
103+
sudo apt-get install deliveryoptimization-plugin-apt
104+
```
105+
106+
### On non-IoT Edge enabled devices
107+
108+
Follow these instructions to provision the Device Update agent on Linux IoT devices without IoT Edge installed.
109+
110+
1. Install the latest version of the IoT Identity Service by following instructions in [Installing the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/installation.html#install-from-packagesmicrosoftcom).
111+
112+
1. Configure the IoT Identity Service by following the instructions in [Configuring the Azure IoT Identity Service](https://azure.github.io/iot-identity-service/configuration.html).
113+
114+
1. Install the Device Update agent.
115+
116+
## Configure the Device Update agent
100117
101-
1. After you install the device update agent, edit the Device Update configuration file by running the following command.
118+
After you install the device update agent, edit the Device Update configuration file by running the following command.
102119
103120
```shell
104121
sudo nano /etc/adu/du-config.json
105122
```
106123
107-
1. In the *du-config.json* file, set all values that have a `Place value here` placeholder. For agents that use the IoT Identity Service for provisioning, change the `connectionType` to `AIS`, and set the `ConnectionData` field to an empty string. For an example, see [Example "du-config.json" file contents](./device-update-configuration-file.md#example-du-configjson-file-contents).
124+
In the *du-config.json* file, set all values that have a `Place value here` placeholder. For agents that use the IoT Identity Service for provisioning, change the `connectionType` to `AIS`, and set the `ConnectionData` field to an empty string. For an example, see [Example "du-config.json" file contents](./device-update-configuration-file.md#example-du-configjson-file-contents).
108125
109-
### Other IoT devices
126+
### Use a connection string
110127
111128
For testing or on constrained devices, you can also configure the Device Update agent without using the IoT Identity service. You can use a connection string to provision the Device Update agent from the module or device.
112129

0 commit comments

Comments
 (0)