チュートリアル: シミュレーターエージェントを使用した Azure Device Update for IoT Hub

[アーティクル]
12/24/2024

Azure Device Update for IoT Hub では、イメージベース、パッケージベース、スクリプトベースの更新がサポートされています。このチュートリアルでは、Ubuntu シミュレーターエージェントを使用する、エンドツーエンドの Device Update イメージベース更新プログラムについて説明します。

イメージ更新プログラムはデバイスの最終状態に対する高い信頼性を提供し、パッケージベース更新プログラムやスクリプトベース更新プログラムのようにパッケージや依存関係の管理に関する問題を引き起こしません。開発環境と運用環境の間でイメージ更新プログラムの結果を簡単にレプリケートすることや、A/B フェールオーバーモデルを簡単に採用することができます。

このチュートリアルでは、次の作業を行いました。

タグを使用して IoT デバイスを Device Update グループに割り当てます。
イメージ更新プログラムをダウンロードしてインストールします。
イメージ更新プログラムをインポートします。
イメージ更新プログラムをデプロイします。
更新プログラムのデプロイ履歴を表示します。

前提条件

Ubuntu 18.04 x64 物理マシンまたは仮想マシン
IoT ハブで構成された Device Update アカウントとインスタンス

デバイスとモジュールを登録して構成する

IoT ハブのデバイスレジストリにデバイスを追加します。 IoT Hub に接続するすべてのデバイスを登録する必要があります。

Azure portal で、Device Update インスタンスに関連付けられている IoT ハブページを開きます。
ナビゲーションウィンドウで [デバイス管理]>[デバイス] の順に選択します。
[デバイス] ページで [デバイスの追加] を選択します。
[デバイス ID] にデバイスの名前を入力します。 [キーの自動生成] チェックボックスがオンになっていることを確認します。
[保存] を選択します。 [デバイス] ページの一覧にデバイスが表示されます。

モジュール ID を作成する

デバイスを登録したら、モジュール ID を作成します。モジュールは IoT デバイスコンポーネントの独立した ID です。これにより、デバイスが複数のプロセスを実行するときにより高度な細分性を実現できます。

このチュートリアルでは、デバイスで実行される Device Update エージェントのモジュール ID を作成します。詳細については、「IoT Hub のモジュールツインの理解と使用」を参照してください。

[デバイス] ページで、登録したデバイスを選択します。
[デバイス] ページで、[モジュール ID の追加] を選択します。
[モジュール ID の追加] ページの [モジュール ID 名] で、モジュールに「DeviceUpdateAgent」などの名前を入力します。
[保存] を選択します。新しいモジュール ID は、デバイスページの [モジュール ID] に表示されます。
モジュール名を選択し、[モジュール ID の詳細] ページで、[接続文字列 (主キー)] の横にある [コピー] アイコンを選択します。 Device Update エージェントを構成する際に使用するために、このモジュール接続文字列を保存します。

モジュールツインにグループタグを追加する

Device Update では、割り当てられたタグと互換性プロパティに基づいて自動的にデバイスがグループに整理されます。各デバイスは 1 つのグループにのみ属しますが、グループには複数のサブグループを含めることができ、さまざまなデバイスクラスを並べ替えることができます。

Device Update により管理される任意のデバイスにタグを割り当て、そのデバイスを Device Update グループに割り当てることができます。タグは、このチュートリアルのようにデバイスツインまたはモジュールツインに含めることができます。各デバイスは、1 つの Device Update グループにのみ割り当てることができます。

[モジュール ID の詳細] ページで、[モジュール ID ツイン] を選択します。
[モジュール ID ツイン] ページで、次のように、modelId および version と同じレベルの新しい DeviceUpdateGroup タグを JSON コードに追加します。
```
"tags": {
    "DeviceUpdateGroup": "DU-simulator-tutorial"
},
```
[保存] を選択します。ポータルによりモジュールツインの形式が再設定され、タグが JSON 構造に組み込まれます。

Device Update エージェントをインストールして構成する

Device Update エージェントは、Device Update が管理するすべてのデバイスで実行されます。このチュートリアルでは、Ubuntu 18.04 デバイスに Device Update エージェントをインストールし、シミュレーターとして実行するように構成し、デバイス構成を変更せずにデバイスに更新プログラムを適用する方法を示します。

Note

Azure IoT ID サービスを使用してデバイスをプロビジョニングすることもできます。これを行うには、Device Update エージェントをインストールする前に、Azure IoT ID サービスをインストールします。次に、"connectionType": "AIS" を使用して Device Update エージェントを構成し、構成ファイルに空の文字列として connectionData を残します。

Microsoft パッケージリポジトリを追加し、信頼できるキーの一覧に Microsoft パッケージ署名キーを追加します。

wget https://packages.microsoft.com/config/ubuntu/18.04/multiarch/packages-microsoft-prod.deb -O packages-microsoft-prod.deb
sudo dpkg -i packages-microsoft-prod.deb
rm packages-microsoft-prod.deb

Device Update エージェントの .deb パッケージをインストールします。
```
sudo apt-get update
sudo apt-get install deviceupdate-agent
```
du-config.json エージェント構成ファイルを開きます。
```
sudo nano /etc/adu/du-config.json
```
次の例の値で du-config.json を更新します。 <connection string> プレースホルダーを、モジュール ID からコピーした接続文字列に置き換えます。パラメーターの詳細については、「Device Update 構成ファイル」を参照してください。
- manufacturer: "contoso"
- model: "video"
- agents.name: "aduagent"
- agents.connectionData: <connection string>
- agents.manufacturer: "contoso"
- agents.model: "video"
編集した du-config.json ファイルは次のようになります。
```
{
   "schemaVersion": "1.0",
   "aduShellTrustedUsers": [
      "adu",
      "do"
   ],
   "manufacturer": "contoso",
   "model": "video",
   "agents": [
      {
      "name": "aduagent",
      "runas": "adu",
      "connectionSource": {
         "connectionType": "string",
         "connectionData": <connection string>
      },
      "manufacturer": "contoso",
      "model": "video"
      }
   ]
}
```
[Ctrl]+[X] を押してエディターを終了し、「y」を入力して変更を保存します。
シミュレーターとして実行するようにエージェントを設定するには、IoT デバイスで次のコマンドを実行します。 Device Update エージェントは、シミュレーターハンドラーを呼び出して、Microsoft SWUpdate 拡張機能を使用する更新プログラムを処理します。
```
  sudo /usr/bin/AducIotAgent --extension-type updateContentHandler --extension-id 'microsoft/swupdate:1' --register-extension /var/lib/adu/extensions/sources/libmicrosoft_simulator_1.so
```

シミュレーターファイルを取得する

[GitHub Device Update リリース][最新リリース][アセット] セクションから Ubuntu 18.04 コンピューターに Tutorial_Simulator.zip アーカイブをダウンロードして抽出します。

wget を使用して ZIP ファイルをダウンロードできます。 <release_version> は、1.0.0 などの最新のリリースに置き換えてください。
```
wget https://github.com/Azure/iot-hub-device-update/releases/download/<release_version>/Tutorial_Simulator.zip
```
抽出した Tutorial_Simulator フォルダーから sample-du-simulator-data.json ファイルを tmp フォルダーにコピーします。
```
cp sample-du-simulator-data.json /tmp/du-simulator-data.json
```
Note

tmp フォルダーが存在しない場合は、次のように作成します。
```
sudo mkdir/tmp
sudo chown root:root/tmp
sudo chmod 1777/tmp
```

/tmp/sample-du-simulator-data.json ファイルのアクセス許可を変更します。

sudo chown adu:adu /tmp/du-simulator-data.json
sudo chmod 664 /tmp/du-simulator-data.json

Device Update エージェントを再起動して、変更を適用します。
```
 sudo systemctl restart deviceupdate-agent
```

更新プログラムをインポートする

Ubuntu 18.04 IoT デバイスと異なる場合は、[GitHub Device Update リリース][最新リリース][アセット] セクションから Ubuntu 18.04 コンピューターに Tutorial_Simulator.zip アーカイブをダウンロードして抽出します。このセクションでは、 TutorialImportManifest_Sim.importmanifest.json と Tutorial_Simulator フォルダーからの adu-update-image-raspberrypi3.swu ファイルを使用します。

更新ファイルは、「Raspberry Pi チュートリアル」にあるものと同じです。このチュートリアルでは更新がシミュレートされているため、特定のファイルの内容は問題になりません。

開発用コンピューターで、Azure portal にサインインし、Device Update インスタンスで構成された IoT ハブに移動します。
ナビゲーションウィンドウで [デバイス管理]>[更新プログラム] の順に選択します。
[更新プログラム] ページで [新しい更新プログラムのインポート] を選択します。
[更新プログラムのインポート] ページで [ストレージコンテナーから選択] を選択します。
既存のストレージアカウントを選択するか、[ストレージアカウント] を選択して新しいストレージアカウントを作成します。
既存のコンテナーを選択するか、[コンテナー] を選択して新しいコンテナーを作成します。このコンテナーは、インポート用の更新ファイルをステージするために使用されます。

Note

以前の更新プログラムから誤ってファイルをインポートしないように、更新プログラムをインポートするごとに新しいコンテナーを使用します。新しいコンテナーを使用しない場合は、必ず既存のコンテナーからあらゆるファイルを削除します。
[コンテナー] ページで [アップロード] を選択します。 TutorialImportManifest_Sim.importmanifest.json と adu-update-image-raspberrypi3.swu ファイルを参照して選択してから、[アップロード] を選択します。
両方のファイルのチェックボックスを選択し、[選択] をクリックして、[更新プログラムのインポート] ページに戻ります。
[更新プログラムのインポート] ページで、インポートするファイルを確認し、[更新プログラムのインポート] を選択します。

インポートプロセスが開始されたら、[インポート履歴の表示] を選択してインポート履歴と状態を表示できます。 [更新の履歴] ページの [ステータス] フィールドには、インポートが完了すると "成功" と表示されます。 [最新の情報に更新] を選択して状態を更新できます。

インポートされた更新プログラムが [更新プログラム] ページに表示されるようになりました。

使用可能な更新プログラムとして一覧に表示されている新しい更新プログラムを示すスクリーンショット。

インポートプロセスの詳細については、Device Update for IoT Hub への更新プログラムのインポートに関する記事を参照してください。

デバイスグループを選択する

デバイスに適用したグループタグを使用して、デバイスグループに更新プログラムをデプロイできます。 [更新プログラム] ページの上部にある [グループとデプロイ] タブを選択して、グループおよびデプロイの一覧と更新プログラムのコンプライアンスグラフを表示します。

更新プログラムのコンプライアンスチャートには、さまざまなコンプライアンス対応状態 (最新の更新状態、利用可能な新しい更新プログラムがある、更新プログラムのインストールが進行中) にあるデバイスの数が表示されます。詳細については、「デバイス更新のコンプライアンス」を参照してください。

[グループ名] の下に、この IoT ハブに接続されているデバイスのすべてのデバイスグループと利用可能な更新プログラムの一覧が表示され、更新プログラムをデプロイするためのリンクが [状態] の下に表示されます。グループのデバイスクラスの要件を満たしていないデバイスは、対応する無効なグループに表示されます。タグとグループの詳細については、デバイスグループの管理に関する記事を参照してください。

このチュートリアルで設定したシミュレーションされたデバイスを含むデバイスグループが表示されているはずです。グループ名を選んで、その詳細を表示します。

更新プログラムをデプロイする

[グループの詳細] ページに、このグループで使用可能な新しい更新プログラムが 1 つ表示されます。 [デプロイ] を選んで、デプロイを始めます。
インポートした更新プログラムは、このグループに最適な更新プログラムとして一覧表示されます。 [デプロイ] を選択します。
デプロイをすぐに開始するようにスケジュールし、[作成] を選択します。
[現在の更新プログラム] タブに移動します。[デプロイの詳細] で、[状態] が アクティブ] に変わります。
デバイスが正常に更新されたら、[更新プログラム] ページに戻ります。コンプライアンスチャートとデプロイの詳細が更新され、インストールされている更新プログラムが含まれていることがわかります。

更新プログラムのデプロイ履歴を表示する

グループの詳細ページに戻り、[デプロイ履歴] タブを選びます。
作成したデプロイの横にある [デプロイの詳細の表示] を選びます。 [最新の情報に更新] を選択して、最新の状態の詳細を表示します。

リソースをクリーンアップする

次のチュートリアルに進む場合は、Device Update と IoT Hub リソースをそのままにします。このチュートリアル用に作成したリソースは、不要になったら削除できます。

Azure portal で、リソースが含まれるリソースグループに移動します。
グループのすべてのリソースを削除する場合は、[リソースグループの削除] を選びます。
リソースの一部のみを削除する場合は、チェックボックスを使用してリソースを選択してから、[削除] を選択します。

次の方法で共有

チュートリアル: シミュレーターエージェントを使用した Azure Device Update for IoT Hub

前提条件