Azure IoT Edge デバイスへの継続的インテグレーションと継続的デプロイ (クラシックエディター)

2021-08-26

適用対象: IoT Edge 1.4

重要

サポートされているリリースは、IoT Edge 1.5 LTS と IoT Edge 1.4 です。以前のリリースの場合は、「IoT Edge を更新する」を参照してください。

Azure Pipelines には、Azure IoT Edge アプリケーションで DevOps を採用するのに役立つ組み込みの Azure IoT Edge タスクが含まれています。この記事では、Azure Pipelines の継続的インテグレーションと継続的デプロイ機能を使用して、クラシックエディターを使用してアプリケーションを迅速かつ効率的に Azure IoT Edge にビルド、テスト、デプロイする方法について説明します。または、 YAML を使用することもできます。

開発と生産のための継続的インテグレーションと継続的開発ブランチの図。

この記事では、Azure Pipelines の組み込みの Azure IoT Edge タスクを使用して、IoT Edge ソリューション用のビルドパイプラインおよびリリースパイプラインを作成する方法について説明します。パイプラインに追加される各 Azure IoT Edge タスクは、次の 4 つのアクションのいずれかを実装します。

アクション	説明
モジュールイメージをビルドする	IoT Edge ソリューションコードを受け取り、コンテナーイメージをビルドします。
モジュールイメージをプッシュする	指定したコンテナーレジストリにモジュールイメージをプッシュします。
配置マニフェストを生成する	deployment.template.json ファイルと変数を受け取り、最終的な IoT Edge 配置マニフェストファイルを生成します。
IoT Edge デバイスにデプロイする	1 つ以上の IoT Edge デバイスに IoT Edge 展開を作成します。

特に指定がない限り、この記事の手順では、タスクパラメーターで使用できるすべての機能については説明しません。詳細については、次のリソースを参照してください。

タスクのバージョン
詳細 - 該当する場合は、ビルドしないモジュールを指定します。
管理オプション
環境変数
出力変数

[前提条件]

Azure Repos リポジトリ。ない場合は、プロジェクト内に新しい Git リポジトリを作成することができます。この記事では、IoTEdgeRepo というリポジトリを作成しました。
リポジトリにコミットおよびプッシュされた IoT Edge ソリューション。この記事をテストするための新しいサンプルソリューションを作成する場合は、「Visual Studio Code を使用して IoT Edge モジュールを開発する」の手順に従ってください。この記事では、IoTEdgeSolution という名前のソリューションをリポジトリに作成しました。これには filtermodule という名前のモジュールのコードが含まれています。

この記事では、必要なのは、Visual Studio Code または Visual Studio のいずれかにある IoT Edge テンプレートで作成されたソリューションフォルダーだけです。続ける前にこのコードをビルド、プッシュ、デプロイ、またはデバッグする必要はありません。これらのプロセスは Azure Pipelines で設定します。

ソリューション内の deployment.template.json ファイルへのパスを確認します。これはいくつかの手順で使用されます。デプロイテンプレートの役割についてよく知らない場合は、モジュールをデプロイしてルートを確立する方法に関するページを参照してください。

ヒント

新しいソリューションを作成する場合は、最初にリポジトリをローカルで複製します。その後で、ソリューションを作成するときに、リポジトリフォルダー内に直接作成することができます。そこから新しいファイルを簡単にコミットおよびプッシュできます。
モジュールイメージをプッシュできるコンテナーレジストリ。 Azure Container Registry またはサードパーティ製のレジストリを使用することができます。
テストと運用環境のデプロイの個々のステージをテストするための少なくとも 2 つの IoT Edge デバイスのある、アクティブな Azure IoT Hub。クイックスタートの記事に従って、Linux または Windows 上に IoT Edge デバイスを作成することができます

継続的インテグレーションのためのビルドパイプラインを作成する

このセクションでは、新しいビルドパイプラインを作成します。 IoT Edge ソリューションへの変更をチェックインするたびに、自動的に実行されるようにパイプラインを構成し、ビルドログを発行します。

ご自身の Azure DevOps 組織 (https://dev.azure.com/{your organization}) にサインインして、IoT Edge ソリューションのリポジトリが含まれているプロジェクトを開きます。
プロジェクトの左側ペインのメニューで、[パイプライン] を選択します。ページの中央にある [パイプラインの作成] を選択します。または、既にビルドパイプラインがある場合は、右上にある [新しいパイプライン] ボタンを選択します。
[ コードの場所 ] ページの下部にある [ クラシックエディターを使用する] を選択します。 YAML を使用してプロジェクトのビルドパイプラインを作成する場合は、 YAML ガイドを参照してください。
プロンプトに従ってパイプラインを作成します。
1. 新しいビルドパイプラインのソース情報を指定します。ソースとして Azure Repos Git を選択し、IoT Edge ソリューションコードが配置されているプロジェクト、リポジトリ、ブランチを選択します。その後、 [続行] を選択します。
2. テンプレートの代わりに [空のジョブ] を選択します。
パイプラインが作成されると、パイプラインエディターが表示されます。ここでは、パイプラインの名前、エージェントプール、およびエージェントの仕様を変更できます。

Microsoft がホストするプール、または管理するセルフホステッドプールを選択できます。

パイプラインの説明で、ターゲットプラットフォームに基づいて適切なエージェント仕様を選択します。
- Linux コンテナー用のプラットフォーム amd64 でモジュールをビルドする場合は、ubuntu-18.04 を選択します
- Windows 1809 コンテナー用のプラットフォーム amd64 でモジュールをビルドする場合は、 Windows でセルフホステッドエージェントを設定する必要があります。
- Linux コンテナー用のプラットフォーム arm32v7 または arm64 でモジュールをビルドする場合は、 Linux でセルフホステッドエージェントを設定する必要があります。
パイプラインには、 エージェントジョブ 1 というジョブが事前構成されています。プラス記号 (+) を選択して、4 つのタスクをジョブに追加します。 Azure IoT Edge は 2 回、 ファイルを 1 回コピーし、 ビルド成果物を 1 回発行します 。各タスクを検索し、タスクの名前にカーソルを合わせると、[ 追加 ] ボタンが表示されます。

4 つのタスクがすべて追加されると、エージェントジョブは次の例のようになります。

最初の Azure IoT Edge タスクを選択して編集します。このタスクは、指定したターゲットプラットフォームを使用して、ソリューション内のすべてのモジュールをビルドします。次の値を使用してタスクを編集します。

パラメーター	説明
[表示名]	表示名は、アクションフィールドが変更されると自動的に更新されます。
アクション	[モジュールイメージをビルドする] を選択します。
.template.json ファイル	省略記号 (...) を選択し、IoT Edge ソリューションを含むリポジトリ内の deployment.template.json ファイルに移動します。
既定のプラットフォーム	ターゲットの IoT Edge デバイスに基づいて、モジュールの適切なオペレーティングシステムを選択します。
出力変数	エッジなど、deployment.json ファイルが生成するファイルパスに関連付ける参照名を指定します。

このタスクとそのパラメーターの詳細については、「Azure IoT Edge タスク」を参照してください。

これらの構成では、 module.json ファイルで定義されているイメージリポジトリとタグを使用して、モジュールイメージの名前とタグを付けます。 ビルドモジュールイメージ は、変数を、 module.json ファイルで定義した正確な値に置き換えるのにも役立ちます。 Visual Studio または Visual Studio Code では、 .env ファイルで実際の値を指定します。 Azure Pipelines では、[ パイプライン変数 ] タブで値を設定します。パイプラインエディターメニューの [ 変数 ] タブを選択し、名前と値を次のように構成します。

ACR_ADDRESS: Azure Container Registry のログインサーバー値。ログインサーバーの値は、Azure portal のコンテナーレジストリの概要ページで確認できます。

プロジェクトに他の変数がある場合は、このタブで名前と値を指定できます。 ビルドモジュールイメージ は、 ${VARIABLE} 形式の変数のみを認識します。 **/module.json ファイルでは、必ずこの形式を使用してください。

2 番目の Azure IoT Edge タスクを選択して編集します。このタスクは、選択したコンテナーレジストリにすべてのモジュールイメージをプッシュします。

パラメーター	説明
[表示名]	表示名は、アクションフィールドが変更されると自動的に更新されます。
アクション	[モジュールイメージをプッシュする] を選択します。
コンテナーレジストリの種類	既定の種類である `Azure Container Registry` を使用します。
Azure サブスクリプション	サブスクリプションを選択します。
Azure Container Registry（アジュールコンテナレジストリ）	モジュールイメージの格納に使用するコンテナーレジストリの種類を選択します。選択したレジストリの種類に応じて、フォームが変更されます。 Azure Container Registry を選択した場合は、ドロップダウンリストを使用して、Azure サブスクリプションとコンテナーレジストリの名前を選択します。 [汎用コンテナーレジストリ] を選択した場合は、[新規] を選択してレジストリサービス接続を作成します。
.template.json ファイル	省略記号 (...) を選択し、IoT Edge ソリューションを含むリポジトリ内の deployment.template.json ファイルに移動します。
既定のプラットフォーム	ターゲットの IoT Edge デバイスに基づいて、モジュールの適切なオペレーティングシステムを選択します。
配置マニフェストにレジストリ資格情報を追加する	docker イメージを配置マニフェストにプッシュするためのレジストリ資格情報を追加するには、true を指定します。

このタスクとそのパラメーターの詳細については、「Azure IoT Edge タスク」を参照してください。

モジュールイメージをホストするために複数のコンテナーレジストリがある場合は、このタスクを複製し、別のコンテナーレジストリを選択し、[詳細設定] で [モジュールのバイパス] を使用して、この特定のレジストリ用ではないイメージをバイパスする必要があります。

[ ファイルのコピー ] タスクを選択して編集します。このタスクを使用して、成果物のステージングディレクトリにファイルをコピーします。

パラメーター	説明
[表示名]	既定の名前を使用するか、カスタマイズする
ソースフォルダー	コピーするファイルを含むフォルダー。
内容	`deployment.template.json` と `**/module.json` の 2 つの行を追加します。これら 2 つのファイルは、IoT Edge 配置マニフェストを生成するための入力として機能します。
ターゲットフォルダー	変数 `$(Build.ArtifactStagingDirectory)` を指定します。内容については、「ビルド変数」を参照してください。

このタスクとそのパラメーターの詳細については、「ファイルのコピータスク」を参照してください。

[ ビルド成果物の発行 ] タスクを選択して編集します。リリースパイプラインにパスを発行できるように、タスクへの成果物ステージングディレクトリパスを指定します。

パラメーター	説明
[表示名]	既定の名前を使用するか、カスタマイズします。
公開するためのパス	変数 `$(Build.ArtifactStagingDirectory)` を指定します。詳細については、「変数のビルド」を参照してください。
アーティファクト名	既定の名前を使用する: drop
成果物の公開場所	既定の場所を使用する: Azure Pipelines

このタスクとそのパラメーターの詳細については、「ビルド成果物の発行タスク」を参照してください。

[トリガー] タブを開き、[継続的インテグレーションを有効にする] チェックボックスをオンにします。コードを含むブランチが含まれていることを確認します。

継続的インテグレーショントリガーを有効にする方法を示すスクリーンショット。

[保存] > [キュー] ドロップダウンから [保存] を選択します。

これで、新しいコードをリポジトリにプッシュするときに、このパイプラインが自動的に実行されるように構成されました。最後のタスクであるパイプライン成果物を発行すると、リリースパイプラインがトリガーされます。次のセクションに進んで、リリースパイプラインをビルドします。

継続的デプロイのためのリリースパイプラインを作成する

このセクションでは、ビルドパイプラインが成果物を削除したときに自動的に実行されるように構成されたリリースパイプラインを作成し、Azure Pipelines にデプロイログを表示します。

新しいパイプラインを作成し、新しいステージを追加します。

[パイプライン] の [リリース] タブで、[+ 新しいパイプライン] を選択します。または、既にリリースパイプラインがある場合は、[+ 新規] ボタンを選択し、[+ 新しいリリースパイプライン] を選択します。
テンプレートを選択するよう求められたら、[空のジョブ] で開始を選択してください。
ステージ 1 という 1 つのステージを持つ新しいリリースパイプラインが初期化されます。ステージ 1 の名前を dev に変更し、お使いの開発環境用の継続的デプロイパイプラインとして扱います。通常、継続的デプロイパイプラインには、dev、staging、prod の複数のステージがあります。使用する DevOps 手法に応じて、別の名前を使用したり、さらに作成したりできます。名前を変更した後、ステージの詳細ウィンドウを閉じます。

上部にある "新しいリリースパイプライン" のテキストを選択して、リリースパイプラインの名前を変更することもできます。
ビルドパイプラインによって発行されているビルド成果物に、リリースをリンクします。成果物領域で追加をクリックします。
[成果物の追加] ページで、[ソースの種類] として [ビルド] を選択します。作成したプロジェクトとビルドパイプラインを選択します。 [ソースエイリアス] は、必要に応じてわかりやすいものに変更できます。その後、 [追加] を選択します。
成果物トリガーを開き、切り替えを選択して継続的デプロイトリガーを有効にします。これで、新しいビルドが使用可能になるたびに新しいリリースが作成されます。
dev ステージは、1 つのジョブ、0 個のタスクで、事前に構成されています。パイプラインメニューから [タスク] を選択し、[dev] ステージを選択します。 [エージェントジョブ] を選択し、その [表示名] を QA に変更します。エージェントジョブの詳細を構成できますが、デプロイタスクはプラットフォームに依存しないため、選択した [エージェントプール] で任意の [エージェント仕様] を使用できます。
QA ジョブで、プラス記号 (+) を選択して 2 つのタスクを追加します。 [Azure IoT Edge] を検索して 2 回追加します。

最初の Azure IoT Edge タスクを選択し、次の値を使用して構成します。

パラメーター	説明
[表示名]	表示名は、アクションフィールドが変更されると自動的に更新されます。
アクション	[`Generate deployment manifest`] を選択します。
.template.json ファイル	パスを指定します: `$(System.DefaultWorkingDirectory)/Drop/drop/deployment.template.json`。このパスはビルドパイプラインから発行されます。
既定のプラットフォーム	ターゲットの IoT Edge デバイスに基づいて、モジュールの適切なオペレーティングシステムを選択します。
出力パス	パス `$(System.DefaultWorkingDirectory)/Drop/drop/configs/deployment.json` を設定します。このパスは、最終的な IoT Edge 配置マニフェストファイルです。

これらの構成は、deployment.template.json ファイル内のモジュールイメージ URL を置き換えるのに役立ちます。また、[Generate deployment manifest]$配置マニフェストの生成$は、deployment.template.json ファイルで定義したのと同じ値に変数を置き換えるのにも役立ちます。 Visual Studio/Visual Studio Code では、.env ファイルに実際の値を指定します。 Azure Pipelines では、[リリースパイプライン変数] タブで値を設定します。[変数] タブに移動し、次のように名前と値を構成します。

ACR_ADDRESS: Azure Container Registry のログインサーバー値。 Azure portal で、コンテナーレジストリの概要ページからログインサーバーを取得できます。
ACR_PASSWORD: Azure Container Registry のパスワード。
ACR_USER: Azure Container Registry のユーザー名。

プロジェクトに他の変数がある場合は、このタブでその名前と値を指定できます。[デプロイマニフェストの生成] で認識できるのは ${VARIABLE} フレーバー内の変数だけです。 *.template.json ファイルでこのフレーバーを使用していることを確認してください。

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

[変数] タブでリリースパイプラインの変数を構成する

2 つ目の [Azure IoT Edge] タスクを選択し、次の値を使用して構成します。

パラメーター	説明
[表示名]	表示名は、アクションフィールドが変更されると自動的に更新されます。
アクション	[`Deploy to IoT Edge devices`] を選択します。
デプロイファイル	パス `$(System.DefaultWorkingDirectory)/Drop/drop/configs/deployment.json` を設定します。このパスは IoT Edge デプロイマニフェストファイルです。
Azure サブスクリプション	IoT Hub が含まれているサブスクリプションを選択します。
IoT Hub の名称	IoT ハブを選択します。
1 つまたは複数のデバイスを選択	リソースパイプラインを 1 つのデバイスまたは複数のデバイスのどちらにデプロイするかを選択します。 1 つのデバイスにデプロイする場合は、IoT Edge デバイス ID を入力します。複数のデバイスにデプロイする場合は、デバイスのターゲット条件を指定します。ターゲット条件とは、IoT Hub 内の一連の IoT Edge デバイスと突き合わせるフィルターです。デバイスタグを条件として使用する場合は、対応するデバイスタグを IoT Hub デバイスツインに合わせて更新する必要があります。詳細設定で、IoT Edge デプロイ ID と IoT Edge デプロイの優先順位を更新します。複数のデバイスのデプロイを作成する方法の詳細については、IoT Edge 自動デプロイについての理解に関するページを参照してください。
デバイス ID またはターゲット条件	以前の選択に応じて、複数のデバイスにデプロイするためのデバイス ID またはターゲット条件を指定します。
アドバンスド	IoT Edge デプロイ ID には、`$(System.TeamProject)-$(Release.EnvironmentName)` を指定します。この変数により、プロジェクトとリリース名がその IoT Edge デプロイ ID を使用してマッピングされます。

パブリッククラウドに表示されないプライベート Docker Trusted Registry に存在するイメージを使用するタスクの場合は、SKIP_MODULE_IMAGE_VALIDATION 環境変数を true に設定して、イメージの検証をスキップできます。

dev ステージに Azure IoT Edge タスクを追加する

[保存] を選択して、新しいリリースパイプラインの変更内容を保存します。メニューで [パイプライン] タブを選択して、パイプラインビューに戻ります。

注

Azure DevOps の Azure IoT Edge タスクでは、階層化されたデプロイはまだサポートされていません。

ただし、 Azure DevOps で Azure CLI タスクを使用して、階層型デプロイとしてデプロイを作成できます。 インラインスクリプトの値には、az iot edge deployment create コマンドを使用できます。

az iot edge deployment create -d {deployment_name} -n {hub_name} --content modules_content.json --layered true

ビルドパイプラインとリリースパイプラインの IoT Edge CI/CD を検証する

ビルドジョブをトリガーするには、コミットをソースコードリポジトリにプッシュするか、手動でトリガーできます。このセクションでは、CI/CD パイプラインを手動でトリガーして、その動作をテストします。その後、デプロイが成功したことを確認します。

左側のウィンドウメニューから、[パイプライン] を選択し、この記事の冒頭で作成したビルドパイプラインを開きます。
右上にある [パイプラインの実行] ボタンを選択すると、ビルドパイプラインのビルドジョブをトリガーできます。
[パイプラインの実行] の設定をレビューします。次に、 [実行] を選択します。
[エージェントジョブ 1] を選択して、実行の進行状況を監視します。ジョブを選択すると、ジョブの出力ログをレビューできます。
ビルドパイプラインが正常に完了すると、dev ステージへのリリースがトリガーされます。 dev へのリリースが成功すると、IoT Edge デバイスを対象とする IoT Edge デプロイが作成されます。
開発ステージをクリックすると、リリースログが表示されます。
パイプラインでエラーが発生した場合は、まずログを確認します。ログを表示するには、パイプラインの実行の概要に移動し、ジョブとタスクを選択します。特定のタスクが失敗している場合は、そのタスクのログを確認します。ログを構成および使用するための詳細な手順については、「ログを確認してパイプラインの問題を診断する」を参照してください。