Integrazione e distribuzione continue nei dispositivi Azure IoT Edge

Articolo
07/12/2024

Si applica a: IoT Edge 1.5 IoT Edge 1.4

Importante

IoT Edge 1.5 LTS e IoT Edge 1.4 LTS sono versioni supportate. IoT Edge 1.4 LTS raggiungerà la fine del servizio il 12 novembre 2024. Se si usa una versione precedente, vedere Aggiornare IoT Edge.

Si può facilmente adottare DevOps con le applicazioni Azure IoT Edge con le attività integrate Azure IoT Edge in Azure Pipelines. Questo articolo illustra come usare Azure Pipelines per creare, testare e distribuire moduli Azure IoT Edge usando YAML. In alternativa, è possibile usare l'editor classico.

Diagramma dei rami di sviluppo continuo e integrazione continua per lo sviluppo e la produzione.

Questo articolo descrive come usare le attività di Azure IoT Edge integrate per Azure Pipelines per creare e rilasciare pipeline per la soluzione IoT Edge. Ogni attività di Azure IoT Edge aggiunta alla pipeline implementa una delle quattro azioni seguenti:

Azione	Descrizione
Compilare immagini del modulo	Recupera il codice della soluzione IoT Edge e compila le immagini del contenitore.
Esegui push delle immagini del modulo	Esegue il push delle immagini del modulo nel registro contenitori specificato.
Generare il manifesto della distribuzione	Recupera un file deployment.template.json e le variabili, quindi genera il file manifesto della distribuzione di IoT Edge finale.
Distribuire nei dispositivi IoT Edge	Crea distribuzioni di IoT Edge in uno o più dispositivi IoT Edge.

Se non diversamente specificato, le procedure descritte in questo articolo non esplorano tutte le funzionalità disponibili tramite i parametri dell'attività. Per ulteriori informazioni, vedi le seguenti risorse:

Prerequisiti

Un repository Azure Repos. Se non se ne ha uno, è possibile creare un nuovo repository Git nel progetto. Per questo articolo è stato creato un repository denominato IoTEdgeRepo.
Una soluzione IoT Edge di cui sia stato eseguito il commit e il push nel repository. Se si vuole creare una nuova soluzione di esempio per testare le procedure di questo articolo, seguire i passaggi descritti in Sviluppare moduli di Azure IoT Edge con Visual Studio Code. Per questo articolo è stata creata una soluzione nel repository denominata IoTEdgeSolution, che include il codice per un modulo denominato filtermodule.

Per questo articolo, tutto quello che serve è la cartella della soluzione creata dai modelli IoT Edge in Visual Studio Code o Visual Studio. Non è necessario compilare, eseguire il push, distribuire o eseguire il debug di questo codice prima di procedere. Questi processi verranno configurati in Azure Pipelines.

Occorre conoscere il percorso del file deployment.template.json nella soluzione, che viene usato in diversi passaggi. Se non si ha familiarità con il ruolo del modello di distribuzione, vedere Informazioni su come distribuire i moduli e stabilire route.

Suggerimento

Se si sta creando una nuova soluzione, prima di tutto clonare il repository in locale. Quindi, quando si crea la soluzione, sarà possibile crearla direttamente nella cartella del repository. Da questa posizione è possibile eseguire facilmente il commit e il push dei nuovi file.
Un registro contenitori in cui eseguire il push delle immagini dei moduli. È possibile usare il Registro Azure Container o un registro di terze parti.
Un hub IoT di Azure attivo con almeno due dispositivi IoT Edge per provare le fasi separate di test e distribuzione in produzione. È possibile seguire gli articoli di avvio rapido per creare un dispositivo IoT Edge in Linux o Windows

Per altre informazioni sull'uso di Azure Repos, vedere Condividere il codice con Visual Studio e Azure Repos.

Creare una pipeline di compilazione per l'integrazione continua

In questa sezione viene creata una nuova pipeline di compilazione. Configurare la pipeline per l'esecuzione automatica quando si archiviano modifiche nella soluzione IoT Edge di esempio e per pubblicare i log di compilazione.

Accedere all'organizzazione Azure DevOps (https://dev.azure.com/{your organization}) e aprire il progetto che contiene il repository della soluzione IoT Edge.
Nel menu del riquadro sinistro del progetto selezionare Pipeline. Selezionare Crea pipeline al centro della pagina. In alternativa, se si hanno già pipeline di compilazione, selezionare il pulsante Nuova pipeline in alto a destra.
Nella pagina Dov'è il codice? selezionare GIT Azure Repos YAML. Se si vuole usare l'editor classico per creare le pipeline di compilazione del progetto, vedere la guida all'editor classico.
Selezionare il repository per cui si sta creando una pipeline.
Nella pagina Configura la pipeline selezionare Pipeline di base. Se è disponibile un file YAML di Azure Pipelines preesistente che si vuole usare per creare questa pipeline, è possibile selezionare File YAML di Azure Pipelines esistente e specificare il ramo e il percorso nel repository per il file.
Nella pagina Esamina il codice YAML della pipeline è possibile selezionare il nome predefinito azure-pipelines.yml per rinominare il file di configurazione della pipeline.

Selezionare Mostra assistente per aprire il riquadro Attività.

Per aggiungere un'attività, posizionare il cursore alla fine del file YAML o ovunque si desideri aggiungere le istruzioni per l'attività. Cercare e selezionare Azure IoT Edge. Immettere i parametri dell'attività come segue. Quindi selezionare Aggiungi.

Parametro	Descrizione
Azione	Selezionare Compila immagini del modulo.
File template.json	Specificare il percorso del file deployment.template.json nel repository che contiene la soluzione IoT Edge.
Piattaforma predefinita	Selezionare il sistema operativo appropriato per i moduli in base al dispositivo IoT Edge di destinazione.

Per altre informazioni su questa attività e sui relativi parametri, vedere Attività Azure IoT Edge.

Screenshot del riquadro dell'attività e come aggiungere attività alla pipeline.

Suggerimento

Dopo l'aggiunta di ogni attività, l'editor evidenzia automaticamente le righe aggiunte. Per evitare la sovrascrittura accidentale, deselezionare le righe e fornire nuovo spazio per l'attività successiva prima di aggiungere attività aggiuntive.

Ripetere questo processo per aggiungere altre tre attività con i parametri seguenti:

Attività: Azure IoT Edge

Parametro	Descrizione
Azione	Selezionare Esegui push delle immagini del modulo.
Tipo di registro contenitori	Usare il tipo predefinito: Registro Azure Container.
Sottoscrizione di Azure	Selezionare la propria sottoscrizione.
Registro Azure Container	Scegliere il registro che si vuole usare per la pipeline.
File template.json	Specificare il percorso del file deployment.template.json nel repository che contiene la soluzione IoT Edge.
Piattaforma predefinita	Selezionare il sistema operativo appropriato per i moduli in base al dispositivo IoT Edge di destinazione.

Per altre informazioni su questa attività e sui relativi parametri, vedere Attività Azure IoT Edge.

Attività: Copia file

Parametro	Descrizione
Cartella di origine	Cartella di origine da cui copiare. Empty è la radice del repository. Usare le variabili se i file non si trovano nel repository. Esempio: `$(agent.builddirectory)`.
Contenuto	Aggiungere due righe: `deployment.template.json` e `**/module.json`.
Target Folder	Specificare la variabile `$(Build.ArtifactStagingDirectory)`. Per informazioni sulla descrizione, vedere Creare variabili.

Per altre informazioni su questa attività e sui relativi parametri, vedere Attività Copia file.

Attività: Pubblica artefatti della compilazione

Parametro	Descrizione
Percorso per la pubblicazione	Specificare la variabile `$(Build.ArtifactStagingDirectory)`. Per informazioni sulla descrizione, vedere Creare variabili.
Nome dell'artefatto	Specificare il nome predefinito: `drop`
Percorso di pubblicazione degli artefatti	Usare la posizione predefinita: `Azure Pipelines`

Per altre informazioni su questa attività e sui relativi parametri, vedere Attività Pubblica artefatti della compilazione.

Selezionare Salva dall'elenco a discesa Salva ed esegui in alto a destra.
Il trigger per l'integrazione continua è abilitato per impostazione predefinita per la pipeline YAML. Per modificare queste impostazioni, selezionare la pipeline e selezionare Modifica in alto a destra. Selezionare Altre azioni accanto al pulsante Esegui in alto a destra e passare a Trigger. L'integrazione continua viene visualizzata come abilitata sotto il nome della pipeline. Per visualizzare i dettagli per il trigger, selezionare la casella Esegui l'override del trigger di integrazione continua YAML da qui.

Screenshot che mostra come controllare le impostazioni dei trigger della pipeline dal menu Trigger in Altre azioni.

Passare alla sezione successiva per creare la pipeline di versione.

Creare una pipeline di versione per la distribuzione continua

In questa sezione si crea una pipeline di versione configurata per essere eseguita automaticamente quando la pipeline di compilazione rilascia gli artefatti e mostra i log di distribuzione in Azure Pipelines.

Creare una nuova pipeline e aggiungere una nuova fase:

Nella scheda Versioni in Pipeline scegliere + Nuova pipeline. In alternativa, se sono già disponibili pipeline di versione, scegliere il pulsante + Nuova e fare clic su + Nuova pipeline di versione.
Quando viene richiesto di selezionare un modello, scegliere di iniziare con una fase vuota.
La nuova pipeline di versione viene inizializzata con un'unica fase, denominata Fase 1. Rinominare la fase 1 dev e considerarla come una pipeline di distribuzione continua per l'ambiente di sviluppo. In genere, le pipeline di distribuzione continua hanno più fasi, tra cui dev, staging e prod. È possibile usare nomi diversi e crearne di più in base alle proprie procedure DevOps. Dopo aver modificato il nome, chiudere la finestra dei dettagli della fase.

È anche possibile rinominare la pipeline di versione selezionando il testo "Nuova pipeline di versione" nella parte superiore.
Collegare la versione agli artefatti di compilazione pubblicati dalla pipeline di compilazione. Selezionare Aggiungi nell'area Artefatti.
Nella pagina Aggiungi un artefatto selezionare Compilazione come Tipo di origine. Scegliere il progetto e la pipeline di compilazione che è stata creata. Se lo si desidera, è possibile modificare Alias di origine impostando un valore più descrittivo. Quindi selezionare Aggiungi.
Aprire i trigger degli artefatti e selezionare l'interruttore per abilitare il trigger di distribuzione continua. A questo punto, ogni volta che è disponibile una nuova compilazione viene creata una nuova versione.
La fase dev è preconfigurata con un processo e nessuna attività. Nel menu della pipeline selezionare Attività e quindi scegliere la fase dev. Selezionare Processo agente e modificare il Nome visualizzato in dev. È possibile configurare i dettagli sul processo dell'agente, ma l'attività di distribuzione non dipende dalla piattaforma, pertanto è possibile usare qualsiasi Specifica agente nel Pool di agenti scelto.
Nel processo di controllo di qualità selezionare il segno più (+) per aggiungere due attività. Cercare e aggiungere Azure IoT Edge due volte.

Selezionare la prima attività Azure IoT Edge e configurarla con i valori seguenti:

Parametro	Descrizione
Display name	Il nome visualizzato viene aggiornato automaticamente quando il campo Azione cambia.
Azione	Selezionare `Generate deployment manifest`.
File template.json	Specificare il percorso: `$(System.DefaultWorkingDirectory)/Drop/drop/deployment.template.json`. Il percorso viene pubblicato dalla pipeline di compilazione.
Piattaforma predefinita	Selezionare il sistema operativo appropriato per i moduli in base al dispositivo IoT Edge di destinazione.
Percorso di output	Inserire il percorso `$(System.DefaultWorkingDirectory)/Drop/drop/configs/deployment.json`. Questo percorso è il file manifesto della distribuzione di IoT Edge finale.

Queste configurazioni consentono di sostituire gli URL delle immagini del modulo nel file deployment.template.json. Genera manifesto della distribuzione consente anche di sostituire le variabili con il valore esatto definito nel file deployment.template.json. In Visual Studio/Visual Studio Code si specifica il valore effettivo in un file .env. In Azure Pipelines il valore viene impostato nella scheda Variabili della pipeline di versione. Passare alla scheda Variabili e configurare il nome e il valore come indicato di seguito:

ACR_ADDRESS: valore Server di accesso di Registro Azure Container. È possibile recuperare il server di accesso dalla pagina Panoramica del registro contenitori nel portale di Azure.
ACR_PASSWORD: password del Registro Azure Container.
ACR_USER: nome utente del Registro Azure Container.

Se nel progetto sono presenti altre variabili, è possibile specificare il nome e il valore in questa scheda. Genera manifesto della distribuzione può riconoscere solo le variabili nel formato ${VARIABLE}. Assicurarsi di usare questo formato nei file *.template.json.

"registryCredentials": {
  "<ACR name>": { // Your Azure Container Registry **Registry name** value
    "username": "${ACR_USER}",
    "password": "${ACR_PASSWORD}",
    "address": "${ACR_ADDRESS}"
  }
}

Configurare le variabili per la pipeline di versione nella scheda Variabili

Selezionare la seconda attività Azure IoT Edge e configurarla con i valori seguenti:

Parametro	Descrizione
Display name	Il nome visualizzato viene aggiornato automaticamente quando il campo Azione cambia.
Azione	Selezionare `Deploy to IoT Edge devices`.
File di distribuzione	Inserire il percorso `$(System.DefaultWorkingDirectory)/Drop/drop/configs/deployment.json`. Questo percorso è il file manifesto della distribuzione di IoT Edge.
Sottoscrizione di Azure	Selezionare la sottoscrizione che contiene l'hub IoT.
Nome hub IoT	Selezionare l'hub IoT.
Scegli un dispositivo singolo/multiplo	Scegliere se si vuole che la pipeline di versione esegua la distribuzione in uno o più dispositivi. Se si distribuisce a un singolo dispositivo, immettere l'ID del dispositivo IoT Edge. Se si distribuisce a più dispositivi, specificare la condizione di destinazione del dispositivo. La condizione di destinazione è un filtro per la corrispondenza di un set di dispositivi IoT Edge nell'hub IoT. Se si vogliono usare i tag del dispositivo come condizione, è necessario aggiornare i tag di dispositivo corrispondenti con il dispositivo gemello hub IoT. Aggiornare l'ID distribuzione di IoT Edge e la priorità della distribuzione IoT Edge nelle impostazioni avanzate. Per altre informazioni sulla creazione di una distribuzione per più dispositivi, vedere Informazioni sulle distribuzioni automatiche IoT Edge.
ID dispositivo o condizione di destinazione	A seconda della selezione precedente, specificare un ID dispositivo o una condizione di destinazione da distribuire in più dispositivi.
Avanzato	Per l'ID di distribuzione IoT Edge, specificare `$(System.TeamProject)-$(Release.EnvironmentName)`. Questa variabile esegue il mapping del nome del progetto e della versione con l'ID di distribuzione IoT Edge.

Se l'attività prevede l'uso di un'immagine che si trova in un registro attendibile Docker privato che non è visibile al cloud pubblico, è possibile impostare la variabile di ambiente SKIP_MODULE_IMAGE_VALIDATION su true per ignorare la convalida dell'immagine.

Aggiungere attività di Azure IoT Edge per la fase dev

Selezionare Salva per salvare le modifiche nella nuova pipeline di versione. Tornare alla visualizzazione della pipeline selezionando Pipeline dal menu.

Verificare la CI/CD di IoT Edge con la compilazione e le pipeline di rilascio

Per attivare un processo di compilazione, è possibile eseguire il push di un commit al repository del codice sorgente o attivarlo manualmente. In questa sezione si attiva manualmente la pipeline CI/CD per verificarne il funzionamento. Si verifica quindi che la distribuzione abbia esito positivo.

Nel menu del riquadro a sinistra selezionare Pipeline e aprire la pipeline di compilazione creata all'inizio di questo articolo.
È possibile attivare un processo di compilazione nella propria pipeline di compilazione selezionando il pulsante Esegui pipeline in alto a destra.
Controllare le impostazioni di Esegui pipeline. Selezionare quindi Esegui.
Selezionare Processo agente 1 per controllare lo stato di avanzamento dell'esecuzione. È possibile esaminare i log dell'output del processo selezionando il processo.
Se la pipeline di compilazione viene completata correttamente, viene attivata una versione nella fase dev. La versione dev completata correttamente crea la distribuzione di IoT Edge per i dispositivi IoT Edge di destinazione.
Selezionare la fase dev per visualizzare i log di versione.
Se la pipeline ha esito negativo, iniziare esaminando i log. È possibile visualizzare i log passando al riepilogo dell'esecuzione della pipeline e selezionando il processo e l'attività. Se una determinata attività ha esito negativo, controllare i log per tale attività. Per istruzioni dettagliate sulla configurazione e l'uso dei log, vedere Esaminare i log per eseguire la diagnostica dei problemi della pipeline.

Passaggi successivi

Per altre informazioni sulla distribuzione IoT Edge, vedere Understand IoT Edge deployments for single devices or at scale (Informazioni sulle distribuzioni IoT Edge per singoli dispositivi o su vasta scala)
Eseguire le procedure per creare, aggiornare o eliminare una distribuzione in Distribuire e monitorare i moduli di IoT Edge su larga scala.

Condividi tramite