Créer et provisionner un appareil IoT Edge sur Linux avec des clés symétriques

Un hub IoT gratuit ou standard dans votre abonnement Azure.

• Un hub IoT gratuit ou standard dans votre abonnement Azure
• Visual Studio Code
• Extension Azure IoT Edge. L’extension Outils Azure IoT Edge pour Visual Studio Code est en mode maintenance.
• Extension Azure IoT Hub

• Un hub IoT gratuit ou standard dans votre abonnement Azure

• Azure CLI dans votre environnement

  Vous devez utiliser Azure CLI version 2.0.70 ou ultérieure. Utilisez az --version pour valider. Cette version prend en charge les commandes d’extension az et introduit l’infrastructure de commande Knack.

Dans votre hub IoT dans le portail Azure, les appareils IoT Edge sont créés et managés séparément des appareils IoT qui ne sont pas compatibles avec Edge.

1. Connectez-vous au portail Azure et accédez à votre IoT Hub.

2. Dans le volet de gauche, sélectionnez Appareils dans le menu, puis sélectionnez Ajouter un appareil.

3. Dans la page Créer un appareil, fournissez les informations suivantes :

   • Créez un ID d’appareil descriptif, par exemple my-edge-device-1 (tout en minuscules). Copiez cet ID d’appareil car vous en aurez besoin plus tard.
   • Cochez la case Appareil IoT Edge.
   • Sélectionnez Clé symétrique comme type d’authentification.
   • Utilisez les paramètres par défaut pour générer automatiquement les clés d’authentification qui connectent le nouvel appareil à votre hub.

4. Sélectionnez Enregistrer.

Vous devez voir le nouvel appareil listé dans votre hub IoT.

Connexion à Azure

Vous pouvez utiliser les extensions Azure IoT pour Visual Studio Code afin d’effectuer des opérations avec votre hub IoT. Vérifiez que vous avez installé les prérequis de l’extension Azure IoT.

Une fois les extensions Azure IoT Edge et Azure IoT Hub installées, vous remarquez qu’une icône Azure est ajoutée au menu des icônes de gauche. Vous pouvez vous connecter à votre compte Azure via Visual Studio Code en sélectionnant l’icône Azure, puis sélectionnez Se connecter à Azure.

Inscrire un nouvel appareil avec Visual Studio Code

L’inscription d’un nouvel appareil est comparable à la création d’appareil IoT Edge dans le Portail Azure. Cet appareil virtuel est l’un des jumeaux alors que l’appareil réel est l’autre. Visual Studio Code peut le définir pour vous via les étapes suivantes.

1. Dans le menu de l’explorateur Visual Studio Code, développez la section Azure IoT Hub.
2. Sélectionnez les ... dans l’en-tête de section Azure IoT Hub. Si vous ne voyez pas les points de suspension, sélectionnez ou placez le curseur sur l’en-tête.
3. Sélectionnez Créer un appareil IoT Edge.
4. Dans la zone de texte qui s’ouvre, donnez un ID à votre appareil, par exemple my-edge-device-1 (tout en minuscules), puis appuyez sur Entrée.

Dans la console de sortie de Visual Studio Code, vous voyez le résultat de la commande : une impression JSON. Les informations de l’appareil incluent deviceId que vous avez fourni et génère une connectionString qui vous permet de connecter votre appareil physique à votre hub IoT. La console de sortie montre également vos clés et d’autres informations identifiant l’appareil.

Vous pouvez désormais voir votre appareil listé sous la section Azure IoT Hub>Appareils du menu de l’Explorateur.

Utilisez la commande az iot hub device-identity create pour créer une identité d’appareil dans votre hub IoT. Remplacez device_id_here par votre propre ID d’appareil unique et nouveau, par exemple my-edge-device-1 (tout en minuscules). Remplacez hub_name_here par votre hub IoT existant.

Cette commande inclut trois paramètres :

• --device-id ou -d : fournissez un nom descriptif unique dans votre hub IoT.

• --hub-name ou -n : indiquez le nom de votre hub IoT.

• --edge-enabled ou --ee : déclarez que l’appareil est un appareil IoT Edge.

  az iot hub device-identity create --device-id device_id_here --hub-name hub_name_here --edge-enabled
  

Si votre CLI indique que La commande nécessite l’extension azure-iot. Voulez-vous l’installer maintenant ?, tapez alors Y et appuyez sur Enter pour lancer le téléchargement afin de créer votre appareil.

Les appareils compatibles avec Edge qui se connectent à votre hub IoT sont répertoriés dans la page Appareils de votre hub IoT. Si vous avez plusieurs appareils, vous pouvez filtrer la liste en sélectionnant le type Appareils Iot Edge, puis sélectionnez Appliquer.

Pour configurer votre appareil, vous avez besoin de la chaîne de connexion qui établit un lien entre votre appareil physique et son identité dans le hub IoT. Les appareils qui s’authentifient avec des clés symétriques disposent des chaînes de connexion pouvant être copiées dans le portail. Pour trouver votre chaîne de connexion dans le portail :

1. Dans la page Appareils, sélectionnez l’ID d’appareil IoT Edge dans la liste.
2. Copiez la valeur de Chaîne de connexion principale ou Chaîne de connexion secondaire. L’une ou l’autre fonctionne.

Tous les appareils qui se connectent à votre hub IoT sont listés dans la section Azure IoT Hub de l’Explorateur Visual Studio Code. Les appareils IoT Edge se distinguent des appareils non Edge car ils ont une icône différente et vous voyez que les modules $edgeAgent et $edgeHub sont déployés sur chacun d’eux.

Pour configurer votre appareil, vous avez besoin de la chaîne de connexion qui établit un lien entre votre appareil physique et son identité dans le hub IoT. Voici comment obtenir votre chaîne de connexion à partir de Visual Studio Code.

1. Cliquez avec le bouton droit sur l’ID (nom) de votre appareil dans la section Azure IoT Hub.

2. Sélectionnez Copier la chaîne de connexion de l’appareil.

   La chaîne de connexion est copiée dans le Presse-papiers.

Vous pouvez également sélectionner Obtenir les informations de l’appareil dans le menu contextuel pour voir les informations de l’appareil, notamment la chaîne de connexion, dans la fenêtre de sortie.

Pour afficher tous les appareils dans votre hub IoT, utilisez la commande az iot hub device-identity list. Remplacez hub_name_here par votre propre nom de hub IoT.

az iot hub device-identity list --hub-name hub_name_here

Tout appareil inscrit en tant qu’appareil IoT Edge dispose de la propriété capabilities.iotEdge définie sur Vrai. Vous voyez également beaucoup d’autres métadonnées comme sortie JSON, notamment vos ID d’appareil.

Lorsque vous êtes prêt à configurer votre appareil, vous avez besoin de sa chaîne de connexion qui établit un lien entre votre appareil physique et son identité dans le hub IoT. Utilisez la commande az iot hub device-identity connection-string show suivante pour retourner la chaîne de connexion d’un appareil unique. Remplacez [device_id] et [hub_name] par vos propres valeurs. La valeur du paramètre device-identity respecte la casse.

az iot hub device-identity connection-string show --device-id [device_id] --hub-name [hub_name]

Vous devez voir une sortie JSON dans la console, similaire à ce qui suit :

{
  "connectionString": "HostName=[hub_name].azure-devices.net;DeviceId=[device_id];SharedAccessKey=[device_key]"
}

Quand vous copiez la chaîne de connexion à utiliser sur un appareil, n’incluez pas les guillemets autour de la chaîne de connexion.

L’installation peut se faire avec quelques commandes. Ouvrez un terminal et exécutez les commandes suivantes :

• 22.04 :

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

• 20.04 :

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

L’installation avec APT peut être effectuée à l’aide de quelques commandes. Ouvrez un terminal et exécutez les commandes suivantes :

• 11 - Bullseye (arm32v7) :

  curl https://packages.microsoft.com/config/debian/11/packages-microsoft-prod.deb > ./packages-microsoft-prod.deb
  sudo apt install ./packages-microsoft-prod.deb
  

L’installation peut se faire avec quelques commandes. Ouvrez un terminal et exécutez les commandes suivantes :

• 9.x (amd64) :

    wget https://packages.microsoft.com/config/rhel/9.0/packages-microsoft-prod.rpm -O packages-microsoft-prod.rpm
    sudo yum localinstall packages-microsoft-prod.rpm
    rm packages-microsoft-prod.rpm
  

• 8.x (amd64) :

    wget https://packages.microsoft.com/config/rhel/8/packages-microsoft-prod.rpm -O packages-microsoft-prod.rpm
    sudo yum localinstall packages-microsoft-prod.rpm
    rm packages-microsoft-prod.rpm
  

Vous installez le runtime IoT Edge à partir du Snap Store dans une étape ultérieure. Passez à la section suivante.

Installez le moteur Moby.

sudo apt-get update; \
  sudo apt-get install moby-engine

Installez le moteur Moby.

sudo apt-get update; \
  sudo apt-get install moby-engine

Installez le moteur Moby et l’interface CLI.

sudo yum install moby-engine moby-cli

curl -ssl https://raw.githubusercontent.com/moby/moby/master/contrib/check-config.sh -o check-config.sh
chmod +x check-config.sh
./check-config.sh

IoT Edge a des dépendances sur Docker et le service d’identité IoT. Installez les dépendances en utilisant les commandes suivantes :

sudo snap install docker
sudo snap install azure-iot-identity

Le snap Docker est géré par Canonical et pris en charge pour les scénarios de production.

1. Créez ou modifiez le fichier config existant du démon Docker

   sudo nano /etc/docker/daemon.json
   

2. Définissez le pilote de journalisation par défaut sur le pilote de journalisation local, comme indiqué dans l’exemple.

      {
         "log-driver": "local"
      }
   

3. Redémarrez le moteur de conteneur pour appliquer les changements.

   sudo systemctl restart docker
   

Actuellement, le paramètre de pilote de journalisation local n’est pas pris en charge pour le snap Docker.

Installez la dernière version d’IoT Edge et le package du service d’identité IoT (si vous n’êtes pas encore à jour) :

• 22.04 :

  sudo apt-get update; \
     sudo apt-get install aziot-edge
  

• 20.04 :

  sudo apt-get update; \
     sudo apt-get install aziot-edge defender-iot-micro-agent-edge
  

Le package defender-iot-micro-agent-edge facultatif inclut le micro-agent de sécurité Microsoft Defender pour IoT qui fournit une visibilité des points de terminaison sur la gestion de la posture de sécurité, les vulnérabilités, la détection des menaces, la gestion de la flotte et bien plus encore pour vous aider à sécuriser vos appareils IoT Edge. Il est recommandé d’installer le micro-agent avec l’agent Edge pour activer la supervision et le renforcement de la sécurité de vos appareils Edge. Pour en savoir plus sur Microsoft Defender pour IoT, consultez Présentation de Microsoft Defender pour IoT pour les générateurs d’appareils.

Installez la dernière version d’IoT Edge et le package du service d’identité IoT (si vous n’êtes pas encore à jour) :

sudo apt-get update; \
  sudo apt-get install aziot-edge defender-iot-micro-agent-edge

Le package defender-iot-micro-agent-edge facultatif inclut le micro-agent de sécurité Microsoft Defender pour IoT qui fournit une visibilité des points de terminaison sur la gestion de la posture de sécurité, les vulnérabilités, la détection des menaces, la gestion de la flotte et bien plus encore pour vous aider à sécuriser vos appareils IoT Edge. Il est recommandé d’installer le micro-agent avec l’agent Edge pour activer la supervision et le renforcement de la sécurité de vos appareils Edge. Pour en savoir plus sur Microsoft Defender pour IoT, consultez Présentation de Microsoft Defender pour IoT pour les générateurs d’appareils.

Installez la dernière version d’IoT Edge et le package du service d’identité IoT (si vous n’êtes pas encore à jour) :

sudo yum install aziot-edge

Installez IoT Edge à partir du Snap Store :

sudo snap install azure-iot-edge

Connecter des snaps

Par défaut, les snaps n’ont pas de dépendances, ne sont pas approuvés et sont strictement restreints. Par conséquent, les snaps doivent être connectés à d’autres snaps et à des ressources système après l’installation. Utilisez les commandes suivantes pour connecter le service d’identité IoT et les snaps IoT Edge entre eux et aux ressources système. Pour commencer, les snaps doivent être connectés manuellement. Pour les déploiements de production, ils peuvent être configurés pour se connecter automatiquement afin de réduire la charge de travail de provisionnement.

#------------------------
#  IoT Identity Service
#------------------------

# Connect the Identity Service snap to the logging system
# and grant permission to query system info

sudo snap connect azure-iot-identity:log-observe
sudo snap connect azure-iot-identity:mount-observe
sudo snap connect azure-iot-identity:system-observe
sudo snap connect azure-iot-identity:hostname-control

# If using a TPM, enable TPM access

sudo snap connect azure-iot-identity:tpm

#------------
#  IoT Edge
#------------

# Connect to your /home directory to enable writing support bundles

sudo snap connect azure-iot-edge:home

# Connect to logging and grant permission to query system info

sudo snap connect azure-iot-edge:log-observe
sudo snap connect azure-iot-edge:mount-observe
sudo snap connect azure-iot-edge:system-observe
sudo snap connect azure-iot-edge:hostname-control
# Allow IoT Edge to connect to the /var/run/iotedge folder and use sockets

sudo snap connect azure-iot-edge:run-iotedge

# Connect IoT Edge to Docker

sudo snap connect azure-iot-edge:docker docker:docker-daemon

Vous pouvez configurer votre appareil IoT Edge avec une authentification par clé symétrique en utilisant la commande suivante :

sudo iotedge config mp --connection-string 'PASTE_DEVICE_CONNECTION_STRING_HERE'

La commande iotedge config mp crée un fichier config sur l’appareil et entre votre chaîne de connexion dans le fichier config.

1. Appliquez les modifications de la configuration.

   sudo iotedge config apply
   

2. Pour afficher le fichier config, vous pouvez l’ouvrir :

   sudo nano /etc/aziot/config.toml
   

1. Créez un fichier config.toml dans votre répertoire de base et configurez votre appareil IoT Edge avec une authentification par clé symétrique pour le snap.

   sudo nano ~/config.toml
   

2. Vous pouvez faire un provisionnement manuel avec une chaîne de connexion en utilisant les paramètres de provisionnement suivants :

   [provisioning]
   source = "manual"
   connection_string = "REPLACE_WITH_DEVICE_CONNECTION_STRING"
   

   Pour plus d’informations sur le provisionnement des paramètres de configuration, consultez Configurer les paramètres d’appareil IoT Edge.

3. Définissez la configuration pour IoT Edge et le service d’identité en utilisant la commande suivante :

   sudo snap set azure-iot-edge raw-config="$(cat ~/config.toml)"
   

sudo apt-get autoremove --purge aziot-edge

Omettez l’indicateur --purge si vous prévoyez de réinstaller IoT Edge et d’utiliser les mêmes informations de configuration à l’avenir. L’indicateur --purge supprime tous les fichiers associés à IoT Edge, y compris vos fichiers config.

sudo yum remove aziot-edge

Supprimer le runtime IoT Edge :

sudo snap remove azure-iot-edge

Supprimer le service d’identité Azure :

sudo snap remove azure-iot-identity

sudo apt-get autoremove --purge moby-engine

sudo yum remove moby-cli
sudo yum remove moby-engine

sudo snap remove docker