チュートリアル: Windows 上の Linux 用IoT Edgeを使用して、Linux コンテナーを使用してIoT Edge モジュールを開発する

対象: IoT Edge 1.5

このチュートリアルでは、Windows および Visual Studio 2022 で Linux 用のIoT Edgeを使用して、独自のコードを開発し、デバッグし、Azure IoT Edge デバイスにデプロイする手順について説明します。 C# モジュールを Linux デバイスにデプロイすることで、IoT Edge ソリューションの最も一般的な開発者シナリオについて説明します。 Windows上の Linux コンテナーで実行されているカスタム IoT Edge モジュールをデプロイしてデバッグします。 別の言語を使用する場合や、Azure サービスをデプロイする場合でも、このチュートリアルは開発ツールと概念について学習するのに役立ちます。

このチュートリアルには、次の 2 つのIoT Edge開発ツールの手順が含まれています。

• Azure IoT Edge開発ツール CLI コマンド ライン インターフェイス (CLI) は、開発に推奨されるツールです。
• Visual Studio用の Azure IoT Edge Tools 拡張機能(メンテナンス モード

このチュートリアルの冒頭にあるセレクター ボタンを使用して、ツールのバージョンを選択します。

このチュートリアルでは、以下の内容を学習します。

前提条件

このチュートリアルでは、Windows実行されているマシンを開発用コンピューターとして使用することを前提としています。 Windows コンピューターでは、Windowsまたは Linux モジュールを開発できます。 このチュートリアルでは、WindowsIoT Edge を使用して、モジュールのビルドとデプロイ> Linux コンテナーの開発について説明します。

作業を開始する前に、次のことを行います。

• IoT Edge for Linux を Windows にインストールします。

• クイックスタート 初めてのIoT Edge モジュールをWindowsデバイスにデプロイするを読みます。

• .NET Core SDK をダウンロードします。

• 開発用コンピューター Visual Studio 2022 をインストールまたは変更します。 Azure開発と C++を使用したデスクトップ開発のワークロードオプションを選択します。

• Visual Studio 2022 のインストールの準備ができたら、Visual Studio Marketplace から Azure IoT Edge Tools をダウンロードしてインストールします。

  Azure IoT Edge Tools 拡張機能を使用して、IoT Edge ソリューションを作成してビルドできます。 推奨される開発ツールは、Azure IoT Edge開発ツール CLI です。 拡張機能には、Visual Studio プロジェクトの作成に使用するAzure IoT Edge プロジェクト テンプレートが含まれています。 現時点では、使用する開発ツールに関係なく、拡張機能をインストールする必要があります。

  ヒント

  Visual Studio 2019 を使用している場合は、Visual Studio Marketplace から Azure IoT Edge Tools for Visual Studio 2019 をダウンロードしてインストールします。

• クラウド リソースとしてAzureに free または standard レベルの IoT ハブを作成します。

Azure アカウントがない場合は、開始する前に free アカウントを作成します。

主要な概念

このチュートリアルでは、IoT Edge モジュールの開発について説明します。 IoT Edge モジュールは、実行可能コードを含むコンテナーです。 1 つ以上のモジュールを IoT Edge デバイスにデプロイできます。 モジュールは、センサーからのデータの取り込み、データのクリーニングと分析、IoT ハブへのメッセージの送信などの特定のタスクを実行します。 詳細については、「Understand Azure IoT Edge モジュールを参照してください。

IoT Edgeモジュールを開発するときは、開発マシンと、モジュールが最終的にデプロイされるターゲット IoT Edge デバイスの違いを理解することが重要です。 モジュール コードを保持するためにビルドするコンテナーは、 ターゲット デバイスのオペレーティング システム (OS) と一致している必要があります。

たとえば、最も一般的なシナリオは、IoT Edgeを実行している Linux デバイスをターゲットにするWindows コンピューターでモジュールを開発しているユーザーです。 その場合、コンテナーの OS は Linux です。

このチュートリアルを進めていくときには、開発マシンの OS とコンテナーの OS の違いに留意してください。 このチュートリアルでは、Windows ホストを開発に使用し、モジュールをビルドしてデプロイするために、Windows仮想マシン (VM) 上の Linux 用のIoT Edgeを使用します。

このチュートリアルでは、Linux コンテナーでIoT Edgeを実行しているデバイスを対象としています。 ご使用の開発マシンで Linux コンテナーが実行される限り、自分の好きなオペレーティング システムを使用することができます。 このチュートリアルでは、Visual Studioを使用して Linux コンテナーを開発することをお勧めします。 Visual Studio Codeを使用することもできますが、2 つのツールのサポートには違いがあります。 詳細については、「Visual Studio Code を使用した Azure IoT Edge モジュールの開発」を参照してください。

リモート接続用に Docker CLI と Docker エンジンを設定する

IoT Edgeモジュールはコンテナーとしてパッケージ化されるため、開発用コンピューター上にコンテナー エンジンを構築して管理する必要があります。

Windows VM 上の Linux のIoT Edgeには、Docker エンジンのインスタンスが既に含まれています。 このチュートリアルでは、Windows開発者マシンから Windows VM Docker インスタンス上の Linux 用IoT Edgeにリモート接続する方法について説明します。 このリモート接続を使用すると、Windowsの Docker Desktop への依存関係を削除します。

Docker CLI を構成する

最初の手順では、リモート Docker エンジンに接続できるように、Windows開発マシンで Docker CLI を構成します。

1. docker.exe から、プリコンパイル済みの バージョンの Docker CLI をダウンロードします。 公式の cli プロジェクトを GitHub からダウンロードし、リポジトリの指示に従ってコンパイルすることもできます。

2. docker.exe を開発マシンのディレクトリ (たとえば、C:\Docker\bin) に展開します。

3. 「PC について>システム情報>システム設定について」を開きます。

4. [詳細設定>Environment 変数] を選択します。 ユーザー変数でパスを選択します。

5. Path 変数を編集し、docker.exeの場所を追加します。

6. 管理者特権の PowerShell セッションを開きます。

7. 次のコマンドを使用して、Docker CLI にアクセスできることを確認します。

   docker --version
   

   すべての構成が正常に完了すると、コマンドの出力に Docker のバージョンが表示されます。 それは Docker version 20.10.12, build e91ed57 のようになります。

Docker エンジンを構成する

2 番目の手順では、外部接続を受け入れるように、Windows VM Docker エンジンで Linux 用のIoT Edgeを構成し、適切なファイアウォール規則を追加します。

1. 管理者特権の PowerShell セッションを開き、次のコマンドを実行します。

   # Configure the IoT Edge for Linux on Windows VM Docker engine to accept external connections, and add the appropriate firewall rules.
   Invoke-EflowVmCommand "sudo iptables -A INPUT -p tcp --dport 2375 -j ACCEPT"
   
   # Create a copy of the IoT Edge for Linux on Windows VM _docker.service_ in the system folder.
   Invoke-EflowVmCommand "sudo cp /lib/systemd/system/docker.service /etc/systemd/system/docker.service"
   
   # Replace the service execution line to listen for external connections.
   Invoke-EflowVmCommand "sudo sed -i 's/-H fd:\/\// -H fd:\/\/ -H tcp:\/\/0.0.0.0:2375/g'  /etc/systemd/system/docker.service"
   
   # Reload the IoT Edge for Linux on Windows VM services configurations.
   Invoke-EflowVmCommand "sudo systemctl daemon-reload"
   
   # Reload the Docker engine service.
   Invoke-EflowVmCommand "sudo systemctl restart docker.service"
   
   # Check that the Docker engine is listening to external connections.
   Invoke-EflowVmCommand "sudo netstat -lntp | grep dockerd"
   

   出力例を次に示します:

   PS C:\> # Configure the IoT Edge for Linux on Windows virtual machine Docker engine to accept external connections, and add the appropriate firewall rules.
   PS C:\> Invoke-EflowVmCommand "sudo iptables -A INPUT -p tcp --dport 2375 -j ACCEPT"
   PS C:\>
   PS C:\> # Create a copy of the IoT Edge for Linux on Windows VM docker.service in the system folder.
   PS C:\> Invoke-EflowVmCommand "sudo cp /lib/systemd/system/docker.service /etc/systemd/system/docker.service"
   PS C:\>
   PS C:\> # Replace the service execution line to listen for external connections.
   PS C:\> Invoke-EflowVmCommand "sudo sed -i 's/-H fd:\/\// -H fd:\/\/ -H tcp:\/\/0.0.0.0:2375/g' /etc/systemd/system/docker.service"
   PS C:\>
   PS C:\> # Reload the IoT Edge for Linux on Windows VM services configurations.
   PS C:\> Invoke-EflowVmCommand "sudo systemctl daemon-reload"
   PS C:\>
   PS C:\> # Reload the Docker engine service.
   PS C:\> Invoke-EflowVmCommand "sudo systemctl restart docker.service"
   PS C:\>
   PS C:\> # Check that the Docker engine is listening to external connections.
   PS C:\> Invoke-EflowVmCommand "sudo netstat -lntp | grep dockerd"
   tcp6       0      0 :::2375                 :::*                    LISTEN      2790/dockerd
   

接続をテストする

最後のセットアップ手順では、Windows VM Docker エンジンで Linux 用IoT Edgeへの Docker 接続をテストします。

1. Windows VM 上の Linux 用IoT Edgeの IP アドレスを取得します。

   Get-EflowVmAddr
   

   ヒント

   Windows VM 上の Linux のIoT Edgeが静的 IP なしでデプロイされた場合、ホスト OS の再起動またはネットワークの変更Windows間で IP アドレスが変更される可能性があります。 Docker エンジンへのリモート接続を確立するたびに、Windows VM 上の Linux 用IoT Edgeに正しい IP アドレスを使用していることを確認します。

   出力例を次に示します:

   PS C:\> Get-EflowVmAddr
   [03/15/2022 15:22:30] Querying IP and MAC addresses from virtual machine (DESKTOP-J1842A1-EFLOW)
    - Virtual machine MAC: 00:15:5d:6f:da:78
    - Virtual machine IP : 172.31.24.105 retrieved directly from virtual machine
   00:15:5d:6f:da:78
   172.31.24.105 
   

2. Windows VM Docker エンジン上の Linux 用IoT Edgeに接続し、hello-world サンプル コンテナーを実行します。 <EFLOW-VM-IP> を、前の手順で取得した VM IP アドレス上Windows Linux 用のIoT Edgeに置き換えます。

   docker -H tcp://<EFLOW-VM-IP>:2375 run --rm hello-world
   

   コンテナーのダウンロードが完了すると、コンテナーが実行され、次の出力が生成されます。

   PS C:\> docker -H tcp://172.31.24.105:2375 run --rm hello-world
   Unable to find image 'hello-world:latest' locally
   latest: Pulling from library/hello-world
   2db29710123e: Pull complete
   Digest: sha256:4c5f3db4f8a54eb1e017c385f683a2de6e06f75be442dc32698c9bbe6c861edd
   Status: Downloaded newer image for hello-world:latest
   
   Hello from Docker!
   This message shows that your installation appears to be working correctly.
   
   To generate this message, Docker took the following steps:
    1. The Docker client contacted the Docker daemon.
    2. The Docker daemon pulled the "hello-world" image from the Docker Hub.
       (amd64)
    3. The Docker daemon created a new container from that image which runs the
       executable that produces the output you're currently reading.
    4. The Docker daemon streamed that output to the Docker client, which sent it
       to your terminal.
   
   To try something more ambitious, you can run an Ubuntu container with:
    $ docker run -it ubuntu bash
   
   Share images, automate workflows, and more with a free Docker ID:
    https://hub.docker.com/
   
   For more examples and ideas, visit:
    https://docs.docker.com/get-started/
   

Azure IoT Edge プロジェクトを作成する

Visual StudioのIoT Edge プロジェクト テンプレートにより、IoT Edge デバイスに展開できるソリューションが作成されます。 次の手順を使用して、Azure IoT Edge ソリューションを作成し、そのソリューションで最初のモジュールを生成します。 各IoT Edge ソリューションには、複数のモジュールを含めることができます。

1. Visual Studioで、スタート ページで Create a new project を選択するか、ツール バーの New Project ボタンを選択して、新しいプロジェクトを作成します。

2. 新しいプロジェクトの作成 ページで、Azure IoT Edge を検索します。 IoT Edge デバイスのプラットフォーム (Linux IoT Edge モジュール) とアーキテクチャに一致するプロジェクトを選択し、Next を選択します。

3. [ 新しいプロジェクトの構成 ] ページで、プロジェクトの名前を入力し、場所を指定して、[ 作成] を選択します。

4. [ モジュールの追加 ] ダイアログで、開発するモジュールの種類を選択します。 Existing モジュールを選択して、既存のIoT Edge モジュールをデプロイに追加することもできます。

5. [ モジュール名] で、モジュール名を指定します。

6. [リポジトリ URL] で、モジュールのイメージ リポジトリの名前を指定します。 Visual Studioは、モジュール名に localhost:5000/<モジュール名> を自動的に設定します。 独自のレジストリ情報に置き換えます。

   テストにローカル Docker レジストリを使用する場合は、 localhost を使用します。 Azure Container Registryを使用する場合は、レジストリの設定からログイン サーバーを使用します。 ログイン サーバーは <registry name>.azurecr.io のようになります。 文字列の localhost:5000 部分のみを置き換え、最終的な結果が <のように見えるようにします>。

7. [追加] を選択して、お使いのモジュールをプロジェクトに追加します。

   

   注

   既存のIoT Edge プロジェクトがある場合は、module.json ファイルを開いてリポジトリの URL を変更できます。 リポジトリ URL は、JSON ファイルの repository プロパティ内にあります。

これで、Visual Studio ソリューションにIoT Edge プロジェクトとIoT Edge モジュールが作成されました。

プロジェクト構造

ソリューションには、メイン プロジェクト フォルダーとモジュール フォルダーという 2 つのプロジェクトレベルのフォルダーがあります。 たとえば、AzureIotEdgeApp1 というメイン プロジェクト フォルダーと、IotEdgeModule1 というモジュール フォルダーがあるとします。

メイン プロジェクト フォルダーには、 配置マニフェストが含まれています。 配置マニフェストは、ターゲット IoT Edge デバイスで構成するモジュールについて説明する JSON ドキュメントです。

モジュール フォルダーには、モジュール コードのファイルが格納されています。 選択した言語に応じて、Program.cs または main.c という名前が付けられます。 このフォルダーには、モジュールのメタデータを記述する module.json という名前のファイルも含まれています。 さまざまな Docker ファイルは、Windowsまたは Linux コンテナーとしてモジュールをビルドするために必要な情報を提供します。

プロジェクトの配置マニフェスト

編集する配置マニフェストの名前は deployment.debug.template.json です。 このファイルは、デバイスで実行されるすべてのモジュールを定義するIoT Edge配置マニフェストのテンプレートです。 このファイルを使用して、モジュール間の通信方法も定義します。 配置マニフェストの詳細については、「 モジュールをデプロイしてルートを確立する方法」を参照してください。

展開テンプレートには以下が含まれます。

• edgeAgent、edgeHub という 2 つのランタイム モジュール。
• このVisual Studio プロジェクトで作成したカスタム モジュール。
• SimulatedTemperatureSensor という名前のモジュール。 この既定のモジュールでは、モジュールのテストに使用できるシミュレートされたデータが生成されます (必要ない場合は削除します)。 シミュレートされた温度センサーのしくみを確認するには、SimulatedTemperatureSensor.csproj ソース コードを確認します。

IoT Edge ランタイム バージョンを設定する

現在、最新の安定ランタイム バージョンは 1.5 です。 IoT Edgeランタイム のバージョンを、最新の安定したリリースまたはデバイスのターゲットにするバージョンに更新します。

モジュールの開発

新しいモジュールを追加すると、コードに触れることなくテストを開始できるよう、ビルドしてデバイスにデプロイする準備ができている既定のコードが付属します。 モジュール コードは、モジュール フォルダー内の Program.cs (C# の場合) または main.c (C の場合) という名前のファイルにあります。

既定のソリューションでは、SimulatedTemperatureSensor モジュールのシミュレートされたデータがモジュールにルーティングされます。 モジュールは入力を受け取り、Azure IoT Hubに送信します。

独自のコードでモジュール テンプレートをカスタマイズする準備ができたら、Azure IoT Hub SDK を使用して、IoT ソリューションの主なニーズに対応する他のモジュールをビルドします。 これらのニーズには、セキュリティ、デバイス管理、信頼性などがあります。

1 つのモジュールをビルドしてプッシュする

通常は、複数のモジュールを含むソリューション全体内で実行する前に、各モジュールをテストしてデバッグする必要があります。 ソリューションは、Windows VM 上の IoT Edge for Linux 内で実行されている Docker エンジンを使用してビルドまたはデバッグするため、最初の手順は、リモート デバッグを有効にするためにモジュールをビルドして発行することです。

1. Solution Explorer で、モジュール プロジェクト フォルダー (たとえば、myIotEdgeModule) を選択します。

2. カスタム モジュールをスタートアップ プロジェクトとして設定します。 メニューの [プロジェクト]>[スタートアップ プロジェクトとして設定]を選択します。

3. C# Linux モジュールをデバッグするには、Dockerfile.amd64.debug ファイルを更新して SSH サービスを有効にする必要があります。 Dockerfile.amd64.debug ファイルを更新し、以下のテンプレートを使用します: リモート デバッグ サポート付きの Azure IoT Edge 用 AMD64 C# モジュールの Dockerfile。

   注

   Debug を選択すると、Visual Studioは Dockerfile.(amd64|windows-amd64).debug を使用して Docker イメージをビルドします。 このファイルには、ビルド中にコンテナー イメージに .NET Core コマンド ライン デバッガー VSDBG が含まれています。 運用対応のIoT Edge モジュールの場合は、VSDBG なしで を使用する Dockerfile.(amd64|windows-amd64) 構成を使用することをお勧めします。

   テンプレートの最後の行 (ENTRYPOINT ["dotnet", "IotEdgeModule1.dll"]) で、DLL の名前が IoT Edge モジュール プロジェクトの名前と一致していることを確認します。

4. Linux モジュールとの SSH 接続を確立するには、RSA キーを作成する必要があります。 新しい RSA キーを作成するには、管理者特権の PowerShell セッションを開き、次のコマンドを実行します。 同じIoT Edge モジュール フォルダーに RSA キーを保存し、キーの名前が id_rsa であることを確認します。

   ssh-keygen -t RSA -b 4096 -m PEM
   

   

5. Azure Container Registryなどのプライベート レジストリを使用している場合は、次の Docker コマンドを使用してサインインします。 ユーザー名とパスワードは、Azure ポータルのレジストリの Access キー ページから取得できます。 ローカル レジストリを使用している場合は、 ローカル レジストリを実行できます。

   docker -H tcp://<EFLOW-VM-IP>:2375 login -u <Container Registry username> -p <Container Registry password> <Container Registry login server>
   

docker build --rm -f "<DockerFilePath>" -t <ImageNameAndTag> "<ContextPath>" 

# Build the image for the local registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t localhost:5000/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

# Or build the image for an Azure Container Registry

docker build --rm -f "./IotEdgeModule1/Dockerfile.amd64.debug" -t myacr.azurecr.io/iotedgemodule1:0.0.1-amd64 "./IotEdgeModule1"

# Push the Docker image to the local registry

docker push localhost:5000/iotedgemodule1:0.0.1-amd64

# Or push the Docker image to an Azure Container Registry
az acr login --name myacr
docker push myacr.azurecr.io/iotedgemodule1:0.0.1-amd64

ソリューションのデバッグ

1. 管理者特権の PowerShell セッションで、次のコマンドを実行します。

   1. Linux C# モジュールの名前に基づいて、moduleId の値を取得します。 プレースホルダー <iot-edge-module-name> は、モジュールの名前に置き換えます。

      $moduleId = Invoke-EflowVmCommand "sudo docker ps -aqf name=<iot-edge-module-name>"
      

   2. $moduleId が正しいことを確認します。 変数が空の場合は、正しいモジュール名を使用していることを確認します。

   3. Linux コンテナー内で SSH サービスを開始します。

      Invoke-EflowVmCommand "sudo docker exec -it -d $moduleId service ssh start"
      

   4. Windows VM 上で実行されている Linux 用 IoT Edge のモジュールの SSH ポートを開きます。 (このチュートリアルではポート 10022 を使用します)。

      Invoke-EflowVmCommand "sudo iptables -A INPUT -p tcp --dport 10022 -j ACCEPT"
      

   警告

   セキュリティ上の理由から、Windows VM 上の Linux のIoT Edgeが再起動されるたびに、IP テーブル ルールが削除され、元の設定に戻ります。 また、モジュールの SSH サービスを手動で再度開始する必要があります。

2. SSH サービスを正常に開始したら、Debug>プロセスへのアタッチ を選択します。 Connection Type を SSH に設定し、Connection ターゲット を Windows VM 上の Linux のIoT Edgeの IP アドレスに設定します。 Windows VM 上の Linux 用IoT Edgeの IP アドレスがわからない場合は、Get-EflowVmAddr PowerShell コマンドレットを使用できます。

   IP を入力し、Enter キーを押します。 ポップアップ ウィンドウに次の構成を入力します。

   フィールド	値
   ホスト名	Windows VM 上の Linux のIoT Edgeの IP アドレス
   ポート	10022（もしくはデプロイ構成で使用したもの）
   ユーザー名	根
   認証の種類	秘密キー
   秘密キー ファイル	前の手順で作成した id_rsa 値の完全なパス
   パスフレーズ	前の手順で作成したキーに使用したパスフレーズ

3. SSH を使用してモジュールに正常に接続したら、プロセスを選択して [ アタッチ] を選択できます。 C# モジュールでは、プロセス dotnet と Attach to Managed (CoreCLR) を選択する必要があります。 最初は 10 秒から 20 秒かかる場合があります。

4. モジュールを検査するためのブレークポイントを設定します。

   • C# で開発している場合は PipeMessage() 内の ModuleBackgroundService.cs 関数にブレークポイントを設定します。
   • C を使用している場合は InputQueue1Callback() 内の main.c 関数にブレークポイントを設定します。

5. SimulatedTemperatureSensor の出力は、カスタム Linux C# モジュールの input1 にリダイレクトされるはずです。 ブレークポイントがトリガーされるはずです。 変数は、Visual Studio Locals ウィンドウで確認できます。

   

6. デバッグを停止するには、Ctrl + F5 キーを押すか、[ 停止 ] ボタンを選択します。

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

次の推奨記事に進む場合は、作成したリソースおよび構成を維持して、再利用することができます。 テスト デバイスと同じIoT Edge デバイスを使用し続けることもできます。

それ以外の場合は、課金を回避するために、この記事で使用したローカル構成とAzure リソースを削除します。

Azure リソースを削除する

Azureリソースとリソース グループの削除を元に戻すことはできません。 間違ったリソース グループやリソースをうっかり削除しないようにしてください。 保持するリソースがある既存のリソース グループ内にIoT Hubを作成した場合は、リソース グループではなく、IoT Hub リソース自体のみを削除します。

リソースを削除するには、次の手順に従います。

1. Azure ポータルにサインインし、Resource グループ を選択します。
2. IoT Edgeテスト リソースを含むリソース グループの名前を選択します。
3. リソース グループに含まれるリソースの一覧を確認します。 それらすべてを削除する場合は、[ リソース グループの削除] を選択できます。 一部のみを削除する場合は、各リソースを選択して個別に削除します。

次のステップ

このチュートリアルでは、開発用コンピューターにVisual Studioを設定し、そこから最初のIoT Edge モジュールをデプロイしてデバッグしました。 これで基本的な概念が理解できたので、モジュールを通過するデータを分析できるように、モジュールに機能を追加してみます。