Tutorial: Entwickeln IoT Edge-Modulen mit Linux-Containern mithilfe von IoT Edge für Linux unter Windows

  • Artikel

Gilt für:IoT Edge 1.4 checkmark IoT Edge 1.4

Wichtig

IoT Edge Version 1.4 wird unterstützt. Wenn Sie ein früheres Release verwenden, finden Sie weitere Informationen unter Aktualisieren von IoT Edge.

Dieses Lernprogramm führt Sie durch das Entwickeln, Debuggen und Bereitstellen Ihres eigenen Codes auf einem IoT Edge-Gerät mit IoT Edge für Linux unter Windows und Visual Studio 2022. Sie lernen das am häufigsten verwendete Entwicklerszenario für IoT Edge-Lösungen kennen, indem Sie ein C#-Modul auf einem Linux-Gerät bereitstellen. Sie stellen ein benutzerdefiniertes Azure IoT Edge-Modul bereit, das in einem Linux-Container unter Windows (EFLOW) ausgeführt wird. Auch wenn Sie die Verwendung einer anderen Sprache oder die Bereitstellung eines Azure-Diensts planen, ist dieses Tutorial dennoch nützlich, um mehr über Entwicklungstools und -konzepte zu erfahren.

Dieser Artikel enthält Schritte für zwei IoT Edge-Entwicklungstools:

  • Befehlszeilenschnittstelle (CLI) ist das bevorzugte Tool für die Entwicklung.
  • Azure IoT Edge-Tools für die Visual Studio-Erweiterung . Die Erweiterung befindet sich im Wartungsmodus.

Verwenden Sie die Schaltfläche für die Toolauswahl am Anfang dieses Artikels, um die Toolversion auszuwählen.

In diesem Tutorial lernen Sie Folgendes:

  • Einrichten Ihres Entwicklungscomputers
  • Verwenden der IoT Edge-Tools für Visual Studio Code zum Erstellen eines neuen Projekts
  • Erstellen Ihres Projekts als Container und Speichern in einer Azure-Containerregistrierung
  • Bereitstellen Ihres Codes auf einem IoT Edge-Gerät

Voraussetzungen

In diesem Artikel wird davon ausgegangen, dass Sie einen Windows-Computer als Entwicklungscomputer verwenden. Auf Windows-Computern können Sie entweder Windows- oder Linux-Module entwickeln. Dieses Lernprogramm führt Sie durch die Entwicklung von Linux-Containern mit IoT Edge für Linux unter Windows zum Erstellen und Bereitstellen der Module.

Nachdem Visual Studio 2022 fertig ist, benötigen Sie auch die folgenden Tools und Komponenten:

  • Laden Sie Azure IoT Edge Tools aus dem Visual Studio Marketplace herunter, und installieren Sie sie. Sie können die Azure IoT Edge Tools-Erweiterung verwenden, um Ihre IoT Edge-Lösung zu erstellen und zu erstellen. Das bevorzugte Entwicklungstool ist das Befehlszeilentool (CLI) Azure IoT Edge Dev Tool. Die Erweiterung enthält die Azure IoT Edge-Projektvorlagen, die zum Erstellen des Visual Studio-Projekts verwendet werden. Derzeit benötigen Sie die Erweiterung unabhängig vom verwendeten Entwicklungstool installiert.

    Wichtig

    Die Azure IoT Edge Tools für VS 2022-Erweiterung befindet sich im modus Standard Tenance. Das bevorzugte Entwicklungstool ist das Befehlszeilentool (CLI) Azure IoT Edge Dev Tool.

    Tipp

    Wenn Sie Visual Studio 2019 verwenden, laden Sie Azure IoT Edge Tools für VS 2019 aus dem Visual Studio-Marketplace herunter, und installieren Sie es.

Cloudressourcen:

  • Einen IoT-Hub in Azure im Tarif „Free“ oder „Standard“.

Wenn Sie kein Azure-Abonnement haben, erstellen Sie ein kostenloses Azure-Konto, bevor Sie beginnen.

Wichtige Begriffe

In diesem Tutorial wird Schritt für Schritt die Entwicklung eines IoT Edge-Moduls beschrieben. Ein IoT Edge-Modul (auch kurz als Modul bezeichnet) ist ein Container mit ausführbarem Code. Sie können ein oder mehrere Module auf einem IoT Edge-Gerät bereitstellen. Mit Modulen werden bestimmte Aufgaben durchgeführt, z. B. das Erfassen der Daten von Sensoren, das Bereinigen oder Analysieren von Daten oder das Senden von Nachrichten an einen IoT-Hub. Weitere Informationen finden Sie unter Grundlegendes zu Azure IoT Edge-Modulen.

Beim Entwickeln von IoT Edge-Modulen ist es wichtig, dass Sie den Unterschied zwischen dem Entwicklungscomputer und dem IoT Edge-Zielgerät verstehen, auf dem das Modul später bereitgestellt wird. Der Container, den Sie für Ihren Modulcode erstellen, muss mit dem Betriebssystem (BS) des Zielgeräts übereinstimmen. Am häufigsten kommt beispielsweise ein Szenario vor, bei dem ein Modul auf einem Windows-Computer entwickelt wird, das für ein Linux-Gerät mit IoT Edge bestimmt ist. In diesem Fall wird als Betriebssystem für den Container Linux verwendet. Denken Sie beim Durcharbeiten dieses Tutorials an den Unterschied zwischen dem Betriebssystem des Entwicklungscomputers und dem Betriebssystem des Containers. In diesem Tutorial verwenden Sie Ihren Windows-Host für die Entwicklung und die IoT Edge-VM für Linux unter Windows (EFLOW) zum Erstellen und Bereitstellen der Module.

In diesem Tutorial geht es um Geräte, auf denen IoT Edge mit Linux-Containern ausgeführt wird. Sie können Ihr bevorzugtes Betriebssystem verwenden, solange auf Ihrem Entwicklungscomputer Linux-Container ausgeführt werden. Es wird empfohlen, Visual Studio für die Entwicklung mit Linux-Containern zu verwenden, damit dieses Lernprogramm verwendet wird. Alternativ können Sie Visual Studio Code nutzen, aber zwischen den beiden Tools gibt es Unterschiede in Bezug auf die Unterstützung. Weitere Informationen finden Sie unter Entwickeln von Azure IoT Edge-Modulen mit Visual Studio Code.

Einrichten der Docker-CLI- und Docker-Engine-Remoteverbindung

Da IoT Edge-Module als Container verpackt werden, benötigen Sie auf Ihrem Entwicklungscomputer eine Container-Engine zum Erstellen und Verwalten der Container. Der virtuelle EFLOW-Computer enthält bereits eine Instanz des Docker-Moduls. In diesem Lernprogramm erfahren Sie, wie Sie eine Remoteverbindung vom Windows-Entwicklercomputer mit der EFLOW-VM-Docker-Instanz herstellen. Hierdurch umgehen wir die Abhängigkeit von Docker Desktop für Windows.

Der erste Schritt besteht im Konfigurieren der Docker-CLI auf dem Windows-Entwicklungssystem, um eine Verbindung mit der Docker-Remote-Engine herstellen zu können.

  1. Laden Sie die vorkompilierte docker.exe-Version der Docker-CLI von docker-cli Chocolatey herunter. Sie können das offizielle cli-Projekt auch von docker/cli GitHub herunterladen GitHub und es gemäß den Repositoryanweisungen kompilieren.
  2. Extrahieren Sie docker.exe in ein Verzeichnis auf Ihrem Entwicklungssystem. Beispiel: C:\Docker\bin
  3. Öffnen Sie Über Ihren PC ->Systeminformationen ->Erweiterte Systemeinstellungen
  4. Wählen Sie Erweitert ->Umgebungsvariablen -> Aktivieren Sie unter Benutzervariablen die Option Pfad
  5. Bearbeiten Sie die Variable Pfad, und fügen Sie den Speicherort der docker.exe hinzu
  6. Öffnen Sie eine PowerShell-Sitzung mit erhöhten Rechten.
  7. Überprüfen Sie mithilfe des Befehls, ob auf die Docker-CLI zugegriffen werden kann. 
    docker --version

Wenn alles erfolgreich konfiguriert wurde, sollte der vorherige Befehl die Docker-Version ausgeben, z. B. Docker-Version 20.10.12, Build e91ed57.

Im zweiten Schritt konfigurieren Sie die Docker-Engine des virtuellen EFLOW-Computers so, dass externe Verbindungen akzeptiert werden, und fügen die entsprechenden Firewallregeln hinzu.

Warnung

Die Docker-Engine für externe Verbindungen verfügbar zu machen, kann zu erhöhten Sicherheitsrisiken führen. Diese Konfiguration sollte nur zu Entwicklungszwecken verwendet werden. Stellen Sie sicher, dass Sie die Konfiguration auf die Standardeinstellungen zurücksetzen, nachdem die Entwicklung abgeschlossen ist.

  1. Öffnen Sie eine PowerShell-Sitzung mit erhöhten Rechten, und führen Sie die folgenden Befehle aus.

    # Configure the EFLOW virtual machine 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 EFLOW 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 EFLOW 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"

    Es folgt eine Beispielausgabe.

    PS C:\> # Configure the EFLOW 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 EFLOW 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 EFLOW 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

  2. Der letzte Schritt besteht im Testen der Docker-Verbindung mit der EFLOW-VM-Docker-Engine. Zunächst benötigen Sie die EFLOW-VM-IP-Adresse.

    Get-EflowVmAddr

    Tipp

    Wenn der virtuelle EFLOW-Computer ohne statische IP bereitgestellt wurde, kann sich die IP-Adresse bei Neustarts des Windows-Hosts oder Netzwerkänderungen ändern. Sie sollten deshalb jedes Mal, wenn Sie eine Docker-Engine-Remoteverbindung herstellen möchten, sicherstellen, dass Sie die korrekte EFLOW-VM-IP-Adresse verwenden.

    Es folgt eine Beispielausgabe.

    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

  3. Stellen Sie mithilfe der abgerufenen IP-Adresse eine Verbindung zum EFLOW VM Docker-Modul her, und führen Sie den Beispielcontainer „Hello-World“ aus. Ersetzen Sie <EFLOW-VM-IP> durch die IP-Adresse für EFLOW-VM, die im vorherigen Schritt abgerufen wurde.

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

    Sie sollten beobachten können, dass der Container heruntergeladen und ausgeführt wird. Danach wird Folgendes ausgegeben.

    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 are 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/

Erstellen eines Azure IoT Edge-Projekts

Die IoT Edge-Projektvorlage in Visual Studio erstellt eine Projektmappe, die auf IoT Edge-Geräten bereitgestellt werden kann. Sie erstellen zunächst eine Azure IoT Edge-Lösung und generieren anschließend das erste Modul in dieser Lösung. Jede IoT Edge-Lösung kann mehrere Module enthalten.

Wichtig

Die von Visual Studio erstellte IoT Edge-Projektstruktur entspricht nicht der Projektstruktur in Visual Studio Code.

Derzeit unterstützt die Azure IoT Edge Dev Tool CLI das Erstellen des Visual Studio-Projekttyps nicht. Sie müssen die Visual Studio IoT Edge-Erweiterung verwenden, um das Visual Studio-Projekt zu erstellen.

  1. Erstellen Sie in Visual Studio ein neues Projekt.

  2. Suchen Sie auf der Seite Neues Projekt erstellen nach Azure IoT Edge. Wählen Sie das Projekt aus, das der Plattform (Linux IoT Edge-Modul) und Architektur für Ihr IoT Edge-Gerät entspricht, und wählen Sie Weiter aus.

    Create New Project

  3. Geben Sie auf der Seite Konfigurieren Ihres neuen Projekts einen Namen und den Speicherort für Ihr Projekt ein, und wählen Sie dann Erstellen aus.

  4. Wählen Sie im Fenster Modul hinzufügen den Typ des Moduls aus, das Sie entwickeln möchten. Sie können auch Vorhandenes Modul auswählen, um Ihrer Bereitstellung ein vorhandenes IoT Edge-Modul hinzuzufügen. Geben Sie den Modulnamen und das Modulimagerepository an.

  5. Geben Sie unter Repository-URL den Namen des Imagerepositorys des Moduls an. Visual Studio füllt den Modulnamen automatisch mit localhost:5000/<Name Ihres Moduls> aus. Ersetzen Sie ihn durch Ihre eigenen Registrierungsinformationen. Wenn Sie eine lokale Docker-Registrierung zum Testen verwenden, können Sie localhost nutzen. Nutzen Sie den Anmeldeserver aus Ihren Registrierungseinstellungen, wenn Sie Azure Container Registry verwenden. Der Anmeldeserver hat die Form <Registrierungsname>.azurecr.io. Ersetzen Sie nur den Teil localhost:5000 der Zeichenfolge, damit das endgültige Ergebnis die folgende Form hat: <Registrierungsname>.azurecr.io/ <Name Ihres Moduls> .

  6. Wählen Sie Hinzufügen aus, um Ihr Modul dem Projekt hinzuzufügen.

    Screenshot of adding how to add an application and module to Visual Studio solution

    Hinweis

    Wenn Sie bereits ein IoT Edge-Projekt haben, können Sie die Repository-URL ändern, indem Sie die Datei module.json öffnen. Die Repository-URL ist in der Eigenschaft repository der JSON-Datei zu finden.

Nun enthält Ihre Visual Studio-Projektmappe ein IoT Edge-Projekt und ein IoT Edge-Modul.

Projektstruktur

In Ihrer Projektmappe gibt es zwei Ordner auf Projektebene: einen Hauptprojektordner und einen einzelnen Modulordner. Beispielsweise verfügen Sie möglicherweise über einen Hauptprojektordner namens AzureIotEdgeApp1 und einen Modulordner mit dem Namen IotEdgeModule1. Der Hauptprojektordner enthält Ihr Bereitstellungsmanifest.

Der Modulordner enthält abhängig von der Sprache, die Sie ausgewählt haben, eine Datei für Ihren Modulcode mit dem Namen Program.cs oder main.c. Dieser Ordner enthält auch eine Datei mit dem Namen module.json, die die Metadaten Ihres Moduls beschreibt. Verschiedene Docker-Dateien stellen die Informationen bereit, die zum Erstellen Ihres Moduls als Windows- oder Linux-Container erforderlich sind.

Bereitstellungsmanifest Ihres Projekts

Das von Ihnen bearbeitete Bereitstellungsmanifest heißt deployment.debug.template.json. Diese Datei ist eine Vorlage eines IoT Edge-Bereitstellungsmanifests, das alle auf einem Gerät ausgeführten Module sowie die Art und Weise definiert, wie sie miteinander kommunizieren. Weitere Informationen zu Bereitstellungsmanifesten finden Sie unter Bereitstellen von Modulen und Einrichten von Routen in IoT Edge.

Wenn Sie diese Bereitstellungsvorlage öffnen, sehen Sie, dass die beiden Runtimemodule edgeAgent und edgeHub zusammen mit dem benutzerdefinierten Modul enthalten sind, das Sie in diesem Visual Studio-Projekt erstellt haben. Ein viertes Modul mit dem Namen SimulatedTemperatureSensor ist ebenfalls enthalten. Dieses Standardmodul generiert simulierte Daten, mit denen Sie Ihre Module testen können, oder löschen, wenn dies nicht erforderlich ist. Der Quellcode „SimulatedTemperatureSensor.csproj“ veranschaulicht die Funktionsweise des simulierten Temperatursensors.

Festlegen der IoT Edge-Runtimeversion

Zurzeit ist Version 1.4 die neueste stabile Runtimeversion. Sie sollten die IoT Edge-Runtimeversion auf die neueste stabile Version oder die Zielversion für Ihre Geräte aktualisieren.

  1. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Namen Ihres Hauptprojekts, und wählen Sie IoT Edge-Runtimeversion festlegen aus.

    Screenshot of how to find and select the menu item named 'Set IoT Edge Runtime version'.

  2. Wählen Sie mithilfe des Dropdownmenüs die auf Ihren IoT Edge-Geräten ausgeführte Runtimeversion und dann OK aus, um Ihre Änderungen zu speichern. Wenn keine Änderung vorgenommen wurde, wählen Sie Abbrechen aus, um den Vorgang zu beenden.

    Derzeit enthält die Erweiterung keine Auswahl für die neuesten Runtimeversionen. Wenn Sie die Runtimeversion auf eine höhere Version als 1.2 festlegen möchten, öffnen Sie die Bereitstellungsmanifestdatei deployment.debug.template.json. Ändern Sie die Runtimeversion für die Systemruntime-Modulimages edgeAgent und edgeHub. Wenn Sie beispielsweise die IoT Edge-Runtimeversion 1.4 verwenden möchten, ändern Sie in der Bereitstellungsmanifestdatei die folgenden Zeilen:

    "systemModules": {
   "edgeAgent": {
    //...
      "image": "mcr.microsoft.com/azureiotedge-agent:1.4"
    //...
   "edgeHub": {
   //...
      "image": "mcr.microsoft.com/azureiotedge-hub:1.4",
   //...

  3. Wenn Sie die Version geändert haben, generieren Sie Ihr Bereitstellungsmanifest erneut, indem Sie mit der rechten Maustaste auf den Namen Ihres Projekts klicken und Bereitstellung für IoT Edge generieren auswählen. Dadurch wird ein Bereitstellungsmanifest basierend auf Ihrer Bereitstellungsvorlage generiert und im Konfigurationsordner Ihres Visual Studio-Projekts angezeigt.

  1. Öffnen Sie die Bereitstellungsmanifestdatei "deployment.debug.template.json ". Das Bereitstellungsmanifest ist ein JSON-Dokument, in dem die Module beschrieben werden, die auf dem IoT Edge-Zielgerät konfiguriert werden sollen.

  2. Ändern Sie die Runtimeversion für die Systemruntime-Modulimages edgeAgent und edgeHub. Wenn Sie beispielsweise die IoT Edge-Runtimeversion 1.4 verwenden möchten, ändern Sie in der Bereitstellungsmanifestdatei die folgenden Zeilen:

    "systemModules": {
    "edgeAgent": {
    //...
        "image": "mcr.microsoft.com/azureiotedge-agent:1.4",
    //...
    "edgeHub": {
    //...
        "image": "mcr.microsoft.com/azureiotedge-hub:1.4",
    //...

Einrichten der Visual Studio 2022-Remote-Docker-Modulinstanz

Verwenden Sie die Azure IoT Edge-Tools-Erweiterung, und konfigurieren Sie sie so, dass das Remote-Docker-Modul verwendet wird, das auf dem virtuellen EFLOW-Computer ausgeführt wird.

  1. Wählen Sie Extras ->Azure IoT Edge-Tools ->IoT Edge-Tooleinstellungen...

  2. Ersetzen Sie den localhost-Wert DOCKER_HOST durch die IP-Adresse des virtuellen EFLOW-Computers. Wenn Sie die IP-Adresse nicht zur Hand haben, verwenden Sie das EFLOW PowerShell-cmdlet Get-EflowVmAddr, um sie abzurufen. Wenn die EFLOW-VM-IP-Adresse beispielsweise 172.20.1.100 ist, sollte der neue Wert tcp://172.20.1.100:2375 lauten.

    Screenshot of IoT Edge Tools settings

  3. Klicken Sie auf OK.

Entwickeln Ihres Moduls

Wenn Sie ein neues Modul hinzufügen, enthält es Standardcode, der sofort genutzt und auf einem Gerät bereitgestellt werden kann, sodass Sie mit dem Testen beginnen können, ohne Code zu berühren. Der Modulcode befindet sich im Modulordner in einer Datei mit dem Namen Program.cs (für C#) oder main.c (für C).

Die Standardlösung ist so aufgebaut, dass die simulierten Daten aus dem SimulatedTemperatureSensor-Modul an Ihr Modul weitergeleitet werden, das die Eingabe entgegennimmt und sie dann an IoT Hub sendet.

Wenn Sie bereit sind, die Modulvorlage mit Ihrem eigenen Code anzupassen, erstellen Sie mit den Azure IoT Hub SDKs weitere Module, die die wesentlichen Anforderungen für IoT-Lösungen wie Sicherheit, Geräteverwaltung und Zuverlässigkeit berücksichtigen.

Erstellen und Pushen eines einzelnen Moduls

In der Regel möchten Sie jedes Modul testen und debuggen, bevor Sie es in einer Gesamtlösung mit mehreren Modulen ausführen. Da die Lösung mit dem Docker-Modul erstellt oder gedebuggt wird, das innerhalb der EFLOW-VM ausgeführt wird, besteht der erste Schritt darin, das Modul zu erstellen und zu veröffentlichen, um das Remotedebugging zu aktivieren.

  1. Wählen Sie in Projektmappen-Explorer den Modulprojektordner (z. B. myIotEdgeModule) aus, und markieren Sie sie. Legen Sie das benutzerdefinierte Modul als Startprojekt fest. Wählen Sie im Menü Projekt>Als Startprojekt festlegen aus.

  2. Zum Debuggen des C#-Linux-Moduls müssen wir die Dockerfile.amd64.debug-Datei aktualisieren, um den SSH-Dienst zu aktivieren. Aktualisieren Sie die Dockerfile.amd64.debug-Datei , um die folgende Vorlage zu verwenden: Dockerfile für Azure IoT Edge AMD64 C#-Modul mit Remotedebugunterstützung.

    Hinweis

    Bei der Auswahl von Debuggen verwendet Visual Studio Dockerfile.(amd64|windows-amd64).debug zum Erstellen von Docker-Images. Dies bindet den .NET Core-Befehlszeilendebugger VSDBG beim Erstellen in Ihr Containerimage ein. Wir empfehlen Ihnen, für produktionsbereite IoT Edge-Module die Konfiguration Version zu verwenden, die Dockerfile.(amd64|windows-amd64) ohne VSDBG verwendet.

    Warnung

    Stellen Sie sicher, dass die letzte Zeile der Vorlage ENTRYPOINT ["dotnet", "IotEdgeModule1.dll"], die den Namen der DLL enthält, mit dem Namen Ihres IoT Edge-Modulprojekts übereinstimmt.

    Screenshot of setting the Dockerfile template

  3. Um eine SSH-Verbindung mit dem Linux-Modul herzustellen, müssen wir einen RSA-Schlüssel erstellen. Öffnen Sie eine PowerShell-Sitzung mit erhöhten Rechten, und führen Sie die folgenden Befehle aus, um einen neuen RSA-Schlüssel zu erstellen. Stellen Sie sicher, dass Sie den RSA-Schlüssel in demselben IoT Edge Modulordner speichern und der Name des Schlüssels id_rsa ist.

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

    Screenshot of how to create an SSH key

  4. Wenn Sie eine private Registrierung wie Azure Container Registry (ACR) verwenden, melden Sie sich dort mit dem folgenden Docker-Befehl an. Sie erhalten den Benutzernamen und das Kennwort über die Seite Zugriffsschlüssel der Registrierung im Azure-Portal. Wenn Sie eine lokale Registrierung verwenden, können Sie eine lokale Registrierung ausführen.

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

  1. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Projektordner, und wählen Sie IoT Edge-Module erstellen und pushen aus, um das Docker-Image für jedes Modul zu kompilieren und zu pushen.

  2. Wenn Sie eine private Registrierung wie Azure Container Registry verwenden, müssen Sie Ihre Anmeldeinformationen für die Registrierung den Laufzeiteinstellungen hinzufügen, die in der Datei deployment.template.json enthalten sind. Ersetzen Sie die Platzhalter durch Ihren tatsächlichen Benutzernamen, das Kennwort und den Registrierungsnamen des ACR-Administrators.

          "settings": {
        "minDockerVersion": "v1.25",
        "loggingOptions": "",
        "registryCredentials": {
          "registry1": {
            "username": "<username>",
            "password": "<password>",
            "address": "<registry name>.azurecr.io"
          }
        }
      }

    Hinweis

    In diesem Artikel werden die Administratoranmeldeinformationen für die Azure Container Registry verwendet, die für Entwicklungs- und Testszenarien geeignet sind. Wenn Sie für die Produktionsszenarien bereit sind, empfehlen wir Ihnen, eine Authentifizierungsoption mit den geringstmöglichen Rechten, z. B. Dienstprinzipale, auszuwählen. Weitere Informationen finden Sie unter Verwalten des Zugriffs auf Ihre Containerregistrierung.

  3. Es ist erforderlich, Port 22 für den Zugriff auf den Modul-SSH-Dienst verfügbar zu machen. In diesem Tutorial wird 10022 als Hostport verwendet. Sie können jedoch einen anderen Port angeben, der als SSH-Port verwendet wird, um eine Verbindung mit dem Linux C#-Modul herzustellen. Sie müssen die SSH-Portinformationen unter „createOptions“ zu den Einstellungen dieses Linux-Moduls in der Datei hinzufügen deployment.debug.template.json.

         "createOptions": {
        "HostConfig": {
           "Privileged": true,
           "PortBindings": {
                 "22/tcp": [
                    {
                       "HostPort": "10022"
                    }
                 ]
           }
        }
     }

  4. Klicken Sie im Projektmappen-Explorer mit der rechten Maustaste auf den Projektordner, und wählen Sie Bereitstellung für IoT Edge generieren aus, um den neuen IoT Edge-JSON-Datei zu erstellen.

  5. Öffnen Sie den Cloud-Explorer durch Klicken auf Ansicht>Cloud-Explorer. Vergewissern Sie sich, dass Sie bei Visual Studio 2019 angemeldet sind.

  6. Erweitern Sie in Cloud-Explorer Ihr Abonnement, suchen Sie Ihren Azure IoT Hub und das Azure IoT Edge-Gerät, das Sie bereitstellen möchten.

  7. Klicken Sie mit der rechten Maustaste auf IoT Edge Gerät, und wählen Sie Bereitstellung erstellen aus. Navigieren Sie zu dem für Ihre Plattform konfigurierten Debugmanifest im Ordner config der Visual Studio-Projektmappe, z. B. deployment.amd64.json.

Erstellen des Moduls „Docker-Image“

Nachdem Sie Ihr Modul entwickelt haben, können Sie das Modulimage erstellen, um es in einer Containerregistrierung für die Bereitstellung auf Ihrem IoT Edge-Gerät zu speichern.

Verwenden Sie die Dockerfile des Moduls, um das Docker-Modulimage zu erstellen.

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

Angenommen, Ihre Befehlsshell befindet sich in Ihrem Projektverzeichnis und der Modulname lautet IotEdgeModule1. Verwenden Sie die folgenden Befehle, um das Image für die lokale Registrierung oder eine Azure-Containerregistrierung zu erstellen:

# 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"

Pushen des Moduls „Docker-Image“

Pushen Sie Ihr Modulimage in die lokale Registrierung oder eine Containerregistrierung.

docker push <ImageName>

Beispiel:

# 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

Stellen Sie das Modul auf dem IoT Edge-Gerät bereit.

Öffnen Sie in Visual Studio die Bereitstellungsmanifestdatei deployment.debug.template.json im Hauptprojekt. Das Bereitstellungsmanifest ist ein JSON-Dokument, in dem die Module beschrieben werden, die auf dem IoT Edge-Zielgerät konfiguriert werden sollen. Vor der Bereitstellung müssen Sie Ihre Azure Container Registry-Anmeldeinformationen, die Modulimages und die richtigen createOptions-Werte aktualisieren. Weitere Informationen zu „createOption“-Werten finden Sie unter Konfigurieren von Erstellungsoptionen für Container für IoT Edge-Module.

  1. Wenn Sie eine Azure Container-Registrierung zum Speichern Ihres Modulimages verwenden, müssen Sie Ihre Anmeldeinformationen in den EdgeAgent-Einstellungen zu deployment.debug.template.json hinzufügen. Ein auf ein Objekt angewendeter

    "modulesContent": {
"$edgeAgent": {
  "properties.desired": {
    "schemaVersion": "1.1",
    "runtime": {
      "type": "docker",
      "settings": {
        "minDockerVersion": "v1.25",
        "loggingOptions": "",
        "registryCredentials": {
          "myacr": {
            "username": "myacr",
            "password": "<your_acr_password>",
            "address": "myacr.azurecr.io"
          }
        }
      }
    },
//...

  2. Ersetzen Sie den Eigenschaftswert image durch den Namen des Modulimages, den Sie an die Registrierung gepusht haben. Wenn Sie beispielsweise ein Image mit dem Tag myacr.azurecr.io/iotedgemodule1:0.0.1-amd64 für das benutzerdefinierte Modul IotEdgeModule1 gepusht haben, ersetzen Sie den Eigenschaftswert „image“ durch den Tagwert.

  3. Fügen Oder ersetzen Sie den createOptions-Wert durch Zeichenfolgeninhalt für jedes System und benutzerdefinierte Modul in der Bereitstellungsvorlage.

    Die Einstellungen image und createOptions von IotEdgeModule1 sehen beispielsweise etwa wie folgt aus:

    "IotEdgeModule1": {
"version": "1.0.0",
"type": "docker",
"status": "running",
"restartPolicy": "always",
"settings": {
    "image": "myacr.azurecr.io/iotedgemodule1:0.0.1-amd64",
    "createOptions": "{\"HostConfig\":{\"PortBindings\":{\"5671/tcp\":[{\"HostPort\":\"5671\"}],\"8883/tcp\":[{\"HostPort\":\"8883\"}],\"443/tcp\":[{\"HostPort\":\"443\"}]}}}"
}

Verwenden Sie den Befehl IoT Edge Azure CLI set-modules zum Bereitstellen der Module für den Azure IoT Hub. Verwenden Sie beispielsweise den folgenden Befehl, um die in der Datei deployment.debug.amd64.json definierten Module für den IoT Hub my-iot-hub und das IoT Edge-Gerät my-device bereitzustellen:

az iot edge set-modules --hub-name my-iot-hub --device-id my-device --content ./deployment.debug.template.json --login "HostName=my-iot-hub.azure-devices.net;SharedAccessKeyName=iothubowner;SharedAccessKey=<SharedAccessKey>"

Tipp

Sie finden Ihre IoT Hub-Verbindungszeichenfolge im Azure-Portal unter „Azure IoT Hub“ >Sicherheitseinstellungen> Freigegebene Zugriffsrichtlinien.

  1. Klicken Sie im Cloud-Explorer mit der rechten Maustaste auf Ihr Edgegerät, und aktualisieren Sie es. Sie können beobachten wie das neue Modul zusammen mit den Modulen $edgeAgent und $edgeHub ausgeführt wird.

Debuggen der Lösung

  1. Führen Sie die folgenden Befehle in einer PowerShell-Sitzung mit erhöhten Rechten aus.

    1. Rufen Sie die moduleId basierend auf dem Namen ab, der für das Linux C#-Modul verwendet wird. Ersetzen Sie den Platzhalter<iot-edge-module-name> durch den Namen Ihres Moduls.

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

    2. Überprüfen Sie, ob $moduleId korrekt ist: Wenn die Variable leer ist, stellen Sie sicher, dass Sie den richtigen Modulnamen verwenden.

    3. Starten des SSH-Diensts innerhalb des Linux-Containers

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

    4. Öffnen Sie den SSH-Port des Moduls auf der EFLOW-VM (in diesem Tutorial wird Port 10022 verwendet).

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

    Warnung

    Aus Sicherheitsgründen wird bei jedem Neustart des virtuellen EFLOW-Computers die IP-Tabellenregel gelöscht und auf die ursprünglichen Einstellungen zurückgesetzt. Außerdem muss der Modul-SSH-Dienst manuell neugestartet werden.

  2. Wählen Sie nach dem erfolgreichen Start des SSH-Diensts Debuggen ->An den Prozess anhängen aus, und legen Sie „Verbindungstyp“ auf SSH und das „Verbindungsziel“ auf die IP-Adresse Ihres virtuellen EFLOW-Computers fest. Wenn Sie die EFLOW VM-IP-Adresse nicht kennen, können Sie sie mithilfe des PowerShell-Cmdlets Get-EflowVmAddr abrufen. Geben Sie zuerst die IP-Adresse ein, und drücken Sie dann die EINGABETASTE. Nehmen Sie im Popupfenster die folgenden Einstellungen vor ein:

    Feld Wert
    Hostname Verwenden der EFLOW VM-IP
    Port 10022 (oder der Port, den Sie in Ihrer Bereitstellungskonfiguration verwendet haben)
    Benutzername root
    Authentifizierungstyp Privater Schlüssel
    Private Schlüsseldatei Vollständiger Pfad zum id_rsa, der in einem vorherigen Schritt erstellt wurde
    Passphrase Passphrase, die für den in einem vorherigen Schritt erstellten Schlüssel verwendet wird

    Screenshot of how to connect to a remote system

  3. Nachdem Sie mithilfe von SSH erfolgreich eine Verbindung mit dem Modul erstellt haben, können Sie den Prozess auswählen und „Anfügen“ auswählen. Für das C#-Modul müssen Sie die Verarbeitung von Dotnet und dann Anfügen an „Verwaltet“ (CoreCLR) auswählen. Es kann das erste Mal 10 bis 20 Sekunden dauern.

    Screenshot of how to attach an edge module process.

  4. Legen Sie einen Haltepunkt fest, um das Modul zu überprüfen.

    • Legen Sie bei der Entwicklung in C# in ModuleBackgroundService.cs einen Haltepunkt in der PipeMessage()-Funktion fest.
    • Wenn Sie C verwenden, legen Sie in InputQueue1Callback() einen Haltepunkt in der InputQueue1Callback()-Funktion fest.

  5. Die Ausgabe des SimulatedTemperatureSensor sollte an input1 des benutzerdefinierten Linux C#-Moduls umgeleitet werden. Es sollte ein Breakpoint ausgelöst werden. Sie können Variablen in Visual Studio im Fenster Lokal ansehen.

    Screenshot of how to debug a single module

  6. Drücken Sie zum Beenden des Debuggens STRG+F5, oder wählen Sie die Schaltfläche „Beenden“ aus.

Bereinigen von Ressourcen

Falls Sie mit dem nächsten empfohlenen Artikel fortfahren möchten, können Sie die erstellten Ressourcen und Konfigurationen beibehalten und wiederverwenden. Sie können auch dasselbe IoT Edge-Gerät als Testgerät weiter nutzen.

Andernfalls können Sie die in diesem Artikel verwendeten lokalen Konfigurationen und die Azure-Ressourcen löschen, um Kosten zu vermeiden.

Löschen von Azure-Ressourcen

Das Löschen von Azure-Ressourcen und -Ressourcengruppen kann nicht rückgängig gemacht werden. Achten Sie daher darauf, dass Sie nicht versehentlich die falsche Ressourcengruppe oder die falschen Ressourcen löschen. Wenn Sie den IoT-Hub in einer bereits vorhandenen Ressourcengruppe erstellt haben, die Ressourcen enthält, die Sie behalten möchten, löschen Sie nicht die Ressourcengruppe, sondern nur die IoT-Hub-Ressource.

So löschen Sie die Ressourcen:

  1. Melden Sie sich beim Azure-Portal an, und wählen Sie anschließend Ressourcengruppen aus.

  2. Wählen Sie den Namen der Ressourcengruppe aus, die Ihre IoT Edge-Testressourcen enthält.

  3. Überprüfen Sie die Liste der Ressourcen, die in Ihrer Ressourcengruppe enthalten sind. Wenn Sie alle löschen möchten, klicken Sie auf Ressourcengruppe löschen. Wenn Sie nur einige Ressourcen löschen möchten, klicken Sie auf die jeweiligen Ressourcen, um sie einzeln zu löschen.

Nächste Schritte

In diesem Tutorial haben Sie Visual Studio 2019 auf Ihrem Entwicklungssystem eingerichtet und damit Ihr erstes IoT Edge-Modul bereitgestellt und gedebuggt. Nachdem Sie sich nun mit den grundlegenden Konzepten vertraut gemacht haben, können Sie versuchen, einem Modul Funktionen hinzuzufügen, damit es den Datenfluss analysieren kann.

Entwickeln von Azure IoT Edge-Modulen mithilfe von Visual Studio Code