デバイス更新プログラムの APT マニフェスト

[アーティクル]
03/27/2023

APT マニフェストは、APT 更新ハンドラーに必要な更新の詳細を記述した JSON ファイルです。このファイルは、他の更新プログラムと同様に、Device Update for IoT Hub にインポートすることができます。

詳細については、「Device Update for IoT Hub に更新プログラムを追加する」を参照してください。

概要

APT マニフェストが更新プログラムとしてデバイス更新エージェントに配信されると、エージェントはマニフェストを処理し、必要な操作を実行します。必要な操作には、APT マニフェストファイルに指定されているパッケージとその依存関係を指定リポジトリからダウンロードし、インストールする作業が含まれます。

デバイス更新プログラムは、APT UpdateType と APT 更新ハンドラーをサポートしています。このサポートによりデバイス更新エージェントは、インストールされている Debian パッケージを評価し、必要なパッケージを更新することができます。

スキーマ

APT マニフェストファイルは、バージョン管理されたスキーマを含む JSON ファイルです。

{
    "name": "<name>",
    "version": "<version>",
    "packages": [
        {
            "name": "<package name>",
            "version": "<version specifier>"
        }
    ]
}

次に例を示します。

{
    "name": "contoso-iot-edge",
    "version": "1.0.0.0",
    "packages": [
        {
            "name" : "thermocontrol",
            "version" : "1.0.1"
        },
        {
            "name" : "tempreport",
            "version" : "2.0.0"
        }
    ]
}

各 APT マニフェストには次のプロパティが含まれています。

Name: この APT マニフェストの名前。これには、シナリオにとって意味のある任意の名前または ID を指定できます。たとえば、「 contoso-iot-edge 」のように入力します。
Version: この APT マニフェストのバージョン番号。たとえば、「 1.0.0.0 」のように入力します。
Packages: パッケージ固有のプロパティを含むオブジェクトの一覧。
- Name: パッケージの名前または ID。たとえば、「 iotedge 」のように入力します。
- Version: パッケージの、必要なバージョン基準。たとえば、「 1.0.8-2 」のように入力します。バージョン値に等号を含めることはできません。バージョンを省略した場合は、指定したパッケージの使用可能な最新バージョンがインストールされます。

現在、サポートされているのは、正確なバージョン番号のみです。バージョン番号は、[epoch:]upstream_version[-debian_revision] 形式の目的の Debian パッケージバージョンです。 epoch は符号なし int であり、 upstream_version には英数字と文字 ("."、"+"、"-"、"~" など) を含めることができます。先頭は必ず数字にします。

Note

'1.0.8' は '1.0.8-0' と同等です

たとえば、 "name":"iotedge" および "version":"1.0.8-2" は、apt-get install iotedge=1.0.8-2 コマンドを使用してパッケージをインストールすることと同じです

Debian パッケージのバージョン管理方法の詳細については、Debian ポリシーマニュアルを参照してください。

Note

インストールする依存パッケージが自動的に解決されると、APT パッケージマネージャーは、パッケージによって指定されたバージョン管理の要件を無視します。依存パッケージの明示的なバージョンを指定しない限り、特定のバージョンに対する厳格な要件 (=) がパッケージ自体により指定されている場合でも、最新のバージョンが使用されます。このように自動で解決されると、条件が満たされない依存関係に関するエラーが発生する可能性があります。詳細情報

特定のバージョンの Azure IoT Edge セキュリティデーモンを更新している場合は、必要なバージョンの aziot-edge パッケージと、それに依存する aziot-identity-service パッケージを APT マニフェストに含める必要があります。詳しくは、IoT Edge を更新する方法に関する記事を参照してください。

APT マニフェストを使用して、デバイス更新エージェントとその依存関係を更新することができます。他のパッケージの場合と同様に、APT マニフェストでデバイス更新エージェント名と必要なバージョンを一覧表示します。その後、この APT マニフェストを、Device Update for IoT Hub のパイプラインを使用してインポートし、デプロイすることができます。

パッケージの削除

APT マニフェストを使用して、インストールされているパッケージをデバイスから削除することもできます。 1 つの APT マニフェストを使用して、複数のパッケージの削除、追加、更新を行うことができます。

パッケージを削除するには、パッケージ名の後にマイナス記号 "-" を追加します。削除しようとしているパッケージのバージョン番号は含めないでください。 APT マニフェストを使用してパッケージを削除しても、その依存関係と構成は削除されません。

次に例を示します。

{
    "name": "contoso-video",
    "version": "2.0.0.1",
    "packages": [
        {
            "name" : "foo-"
        }
    ]
}

この APT マニフェストにより、デプロイ先のデバイスからパッケージ "foo" が削除されます。

インストール条件に推奨される値

APT マニフェストのインストール条件は <name>-<version> です。ここで、<name> は APT マニフェストの名前、<version> は APT マニフェストのバージョンです。たとえば、「 contoso-iot-edge-1.0.0.0 」のように入力します。

APT マニフェストの作成に関するガイドライン

APT マニフェストの作成時には、注意すべきガイドラインがいくつかあります。

APT マニフェストは必ず、整形式の json ファイルにします。
各 APT マニフェストのバージョンは一意であることが必要です。使用するシナリオで合理的で、簡単に従うことができるように、標準化された方法を使用して、APT マニフェストのバージョンをインクリメントするようにします。
個々のパッケージの必要な状態に関しては、デバイスにインストールするパッケージの正確な名前とバージョンを指定します。パッケージのソースとして使用するパッケージリポジトリと照合して、常に値を検証します。
APT マニフェスト内のパッケージが、インストールまたは削除される順序で一覧表示されていることを確認します
必要な結果が得られるように、必ずテストデバイスでパッケージのインストールを検証します。
パッケージの特定のバージョン (iotedge 1.0.9-1 など) をインストールする場合のベストプラクティスは、インストールする依存パッケージの明示的なバージョン (libiothsm 1.0.9-1 など) も APT マニフェストに含めることです
必須ではありませんが、APT マニフェストは、デバイスが不明な状態にならないように累積的に作成してください。累積的に更新すると、インストール中にエラーが発生したか、オフラインになったためにデバイスが APT 更新プログラムのデプロイをスキップした場合でも、デバイスには、使用するすべてのパッケージの必要なバージョンが含まれます

次に例を示します。

基本 APT マニフェスト

{
    "name": "contoso-iot-edge",
    "version": "1.0",
    "packages": [
        {
            "name": "foo",
            "version": "1.0.1"
        }
    ]
}

不適切な更新プログラム

この更新プログラムには、bar パッケージが含まれていますが、foo パッケージは含まれていません。

{
    "name": "contoso-iot-edge",
    "version": "2.0",
    "packages": [
        {
            "name": "bar",
            "version": "3.0.2"
        }
    ]
}

適切な更新プログラム

この更新プログラムには、foo パッケージが含まれており、bar パッケージも含まれています。

{
    "name": "contoso-iot-edge",
    "version": "2.0",
    "packages": [
        {
            "name": "foo",
            "version": "1.0.1"
        },
        {
            "name": "bar",
            "version": "3.0.2"
        }
    ]
}

次のステップ

Device Update に更新プログラムをインポートする

Share via

デバイス更新プログラムの APT マニフェスト

概要

スキーマ

パッケージの削除

インストール条件に推奨される値

APT マニフェストの作成に関するガイドライン

次のステップ

その他のリソース