ローカルデバッグコンソール - AWS IoT Greengrass

翻訳は機械翻訳により提供されています。提供された翻訳内容と英語版の間で齟齬、不一致または矛盾がある場合、英語版が優先します。

ローカルデバッグコンソール

ローカルのデバッグコンソールコンポーネント (aws.greengrass.LocalDebugConsole) は、ローカルダッシュボードを提供します。このダッシュボードには、AWS IoT Greengrassコアデバイスとそのコンポーネント。このダッシュボードを使用して、コアデバイスをデバッグし、ローカルコンポーネントを管理できます。

重要

本番稼働環境では、このコンポーネントを使用しないでください。このコンポーネントは、開発環境でのみ使用することを目的としています。へのアクセス権を持つすべてのユーザーAWS IoT Greengrassコアデバイス上の CLI は、情報にアクセスし、このコンポーネントが公開する操作を実行できます。

Versions

このコンポーネントには、次のバージョンがあります。

  • 2.2.x

  • 2.1.x

  • 2.0.x

Type

このコンポーネントは、プラグインコンポーネント(aws.greengrass.plugin). -Greengrass 核は核と同じ Java Virtual Machine (JVM) でこのコンポーネントを実行します。このコンポーネントをインストールまたは再起動すると、nucleus が再起動します。

このコンポーネントは、Greengrass 核と同じログファイルを使用します。詳細については、「表示AWS IoT GreengrassCore ソフトウェアのログ」を参照してください。

詳細については、「コンポーネントタイプ」を参照してください。

Requirements

このコンポーネントには以下の要件があります。

  • ダッシュボードへのサインインには、ユーザー名とパスワードを使用します。ユーザー名。debugというオプションが用意されています。を使用する必要があります。AWS IoT GreengrassCLI を使用して、コアデバイスのダッシュボードでユーザーを認証する一時パスワードを作成します。使用できる必要があります。AWS IoT GreengrassCLI を使用して、ローカルデバッグコンソールを使用します。詳細については、「」を参照してください。Greengrass CLI の要件。パスワードを生成してサインインする方法の詳細については、」ローカルデバッグコンソールコンポーネントの使用

Dependencies

コンポーネントをデプロイすると、AWS IoT Greengrassは、互換性のあるバージョンの依存関係もデプロイします。つまり、コンポーネントを正常にデプロイするには、コンポーネントとそのすべての依存関係の要件を満たす必要があります。このセクションでは、依存関係を一覧表示します。リリースバージョンと、各依存関係のコンポーネントバージョンを定義するセマンティックバージョン制約があります。コンポーネントの各バージョンの依存関係は、AWS IoT Greengrassconsole。コンポーネントの詳細ページで、の依存関係: リスト

2.2.2

次の表は、このコンポーネントのバージョン 2.2.2.2 の依存関係の一覧です。

依存関係 互換性のあるバージョン 依存性タイプ
Greengrass 核 >=2.1.0 <2.5.0 ハード
Greengrass >=2.1.0 <2.5.0 ハード
2.2.1

次の表に、このコンポーネントのバージョン 2.2.1 の依存関係を示します。

依存関係 互換性のあるバージョン 依存性タイプ
Greengrass 核 >=2.1.0 <2.4. ハード
Greengrass >=2.1.0 <2.4. ハード
2.2.0

次の表は、このコンポーネントのバージョン 2.2.0 の依存関係の一覧です。

依存関係 互換性のあるバージョン 依存性タイプ
Greengrass 核 >=2.1.0 <2.3.0 ハード
Greengrass >=2.1.0 <2.3.0 ハード
2.1.0

次の表は、このコンポーネントのバージョン 2.1.0 の依存関係の一覧です。

依存関係 互換性のあるバージョン 依存性タイプ
Greengrass 核 >=2.1.0 <2.2.0 ハード
Greengrass >=2.1.0 <2.2.0 ハード
2.0.x

次の表に、このコンポーネントのバージョン 2.0.x の依存関係を示します。

依存関係 互換性のあるバージョン 依存性タイプ
Greengrass 核 >=2.0.3 <2.1.0 ソフト
Greengrass >=2.0.3 <2.1.0 ソフト

コンポーネントの依存関係の詳細については、『』を参照してください。コンポーネントレシピのリファレンス

Configuration

このコンポーネントには、コンポーネントのデプロイ時にカスタマイズできる次の構成パラメータが用意されています。

v2.1.x - v2.2.x
httpsEnabled

(任意)ローカルデバッグコンソールで HTTPS 通信をイネーブルにできます。HTTPS 通信を有効にすると、ローカルのデバッグコンソールによって自己署名証明書が作成されます。Web ブラウザーは、自己署名証明書を使用する Web サイトに対してセキュリティ警告を表示するため、証明書を手動で確認する必要があります。その後、警告をバイパスできます。詳細については、「Usage」を参照してください。

デフォルト: true

port

(任意)ローカルデバッグコンソールを提供するポート。

デフォルト: 1441

websocketPort

(任意)ローカルデバッグコンソールに使用する websocket ポート。

デフォルト: 1442

例: 設定のマージの更新

次に、デフォルト以外のポートでローカルデバッグコンソールを開き、HTTPS をディセーブルにする設定例を示します。

{ "httpsEnabled": false, "port": "10441", "websocketPort": "10442" }
v2.0.x
port

(任意)ローカルデバッグコンソールを提供するポート。

デフォルト: 1441

websocketPort

(任意)ローカルデバッグコンソールに使用する websocket ポート。

デフォルト: 1442

例: 設定のマージの更新

次に、デフォルト以外のポートでローカルデバッグコンソールを開くように指定する設定例を示します。

{ "port": "10441", "websocketPort": "10442" }

Usage

ローカルデバッグコンソールを使用するには、Greengrass CLI からセッションを作成します。セッションを作成すると、Greengrass CLI は、ローカルデバッグコンソールへのサインインに使用できるユーザー名と一時パスワードを提供します。

次の手順に従って、コアデバイスまたは開発コンピュータでローカルデバッグコンソールを開きます。

v2.1.x - v2.2.x

バージョン 2.1.0 以降では、ローカルのデバッグコンソールはデフォルトで HTTPS を使用します。HTTPS が有効になっている場合、ローカルのデバッグコンソールは接続をセキュリティで保護するために使用される自己署名証明書を作成します。この自己署名証明書が原因で、ローカルデバッグコンソールを開くと、Web ブラウザーにセキュリティ警告が表示されます。Greengrass CLI を使用してセッションを作成すると、出力に証明書のフィンガープリントが含まれるため、証明書が正当であり、接続が安全であることを確認できます。

HTTPS を無効にできます。詳細については、「」を参照してください。ローカルデバッグコンソールの設定

ローカルデバッグコンソールを開くには

  1. (オプション)開発用コンピュータでローカルデバッグコンソールを表示するには、SSH 経由でコンソールのポートを転送します。ただし、最初に、を有効にする必要があります。AllowTcpForwardingオプションをコアデバイスの SSH 設定ファイルに追加します。デフォルトでは、このオプションは有効になっています。開発コンピューターで次のコマンドを実行して、ダッシュボードをhttp://localhost:1441開発用コンピュータにをインストールします。

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    注記

    デフォルトのポートは、1441および1442。詳細については、「」を参照してください。ローカルデバッグコンソールの設定

  2. ローカルデバッグコンソールを使用するセッションを作成します。セッションを作成すると、認証に使用するパスワードが生成されます。ローカルデバッグコンソールでは、セキュリティを強化するためにパスワードが必要です。このコンポーネントを使用して重要な情報を表示したり、コアデバイス上で操作を実行したりできるからです。また、コンポーネント構成で HTTPS をイネーブルにすると、ローカルのデバッグコンソールによって接続を保護するための証明書が作成されます。HTTPS はデフォルトでは有効になっています。

    の使用AWS IoT GreengrassCLI を使用してセッションを作成します。このコマンドは、8 時間後に期限切れとなる 43 文字のランダムパスワードを生成します。置換/greengrass/v2へのパスでAWS IoT Greengrass V2のルートフォルダを開きます。

    sudo /greengrass/v2/bin/greengrass-cli get-debug-password

    HTTPS を使用するようにローカルデバッグコンソールを設定した場合、コマンド出力は次の例のようになります。証明書フィンガープリントを使用して、ローカルデバッグコンソールを開いたときに、接続が安全であることを確認します。

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password expires at: 2021-04-01T17:01:43.921999931-07:00 The local debug console is configured to use TLS security. The certificate is self-signed so you will need to bypass your web browser's security warnings to open the console. Before you bypass the security warning, verify that the certificate fingerprint matches the following fingerprints. SHA-256: 15 0B 2C E2 54 8B 22 DE 08 46 54 8A B1 2B 25 DE FB 02 7D 01 4E 4A 56 67 96 DA A6 CC B1 D2 C4 1B SHA-1: BC 3E 16 04 D3 80 70 DA E0 47 25 F9 90 FA D6 02 80 3E B5 C1

    デバッグビューコンポーネントは、8 時間持続するセッションを作成します。その後、新しいパスワードを生成して、ローカルのデバッグコンソールを再度表示する必要があります。

  3. ダッシュボードを開き、サインインします。Greengrass コアデバイス、または SSH 経由でポートを転送する場合は、開発用コンピューターでダッシュボードを表示します。次のいずれかを行ってください。

    • ローカルデバッグコンソールで HTTPS を有効にした場合 (デフォルト設定)、次の操作を行います。

      1. オープンhttps://localhost:1441、または SSH 経由でポートを転送した場合は、開発用コンピューターにインストールします。

        ブラウザに、無効なセキュリティ証明書に関するセキュリティ警告が表示されることがあります。

      2. ブラウザにセキュリティ警告が表示された場合は、証明書が正当であることを確認し、セキュリティ警告をバイパスします。次の作業を行います。

        1. 証明書の SHA-256 または SHA-1 フィンガープリントを検索し、get-debug-passwordコマンドが以前に印刷されました。お使いのブラウザは、一方または両方のフィンガープリントを提供することがあります。ブラウザのマニュアルを参照して、証明書とそのフィンガープリントを確認してください。一部のブラウザでは、証明書のフィンガープリントをサムプリントと呼びます。

          注記

          証明書のフィンガープリントが一致しない場合は、[] に移動します。ステップ 2をクリックして、新しいセッションを作成します。それでも証明書のフィンガープリントが一致しない場合は、接続が安全でない可能性があります。

        2. 証明書のフィンガープリントが一致する場合は、ブラウザのセキュリティ警告をバイパスして、ローカルのデバッグコンソールを開きます。ブラウザのセキュリティ警告を回避するには、ブラウザのドキュメントを参照してください。

      3. ユーザー名とパスワードを使用して Web サイトにサインインします。get-debug-passwordコマンドが以前に印刷されました。

        ローカルデバッグコンソールが開きます。

      4. ローカルのデバッグコンソールに TLS ハンドシェイクが失敗したため WebSocket に接続できないというエラーが表示された場合は、WebSocket URL の自己署名セキュリティ警告をバイパスする必要があります。

        
                          ローカルデバッグコンソールの WebSocket TLS ハンドシェイクエラー。

        次の作業を行います。

        1. オープンhttps://localhost:1442をローカルデバッグコンソールを開いたのと同じブラウザで実行します。

        2. 証明書を確認し、セキュリティ警告をバイパスします。

          警告をバイパスすると、ブラウザに HTTP 404 ページが表示される場合があります。

        3. オープンhttps://localhost:1441をクリックします。

          ローカルデバッグコンソールには、コアデバイスに関する情報が表示されます。

    • ローカルのデバッグコンソールで HTTPS を無効にした場合は、次の操作を行います。

      1. オープンhttp://localhost:1441をインストールするか、SSH 経由でポートを転送した場合は、開発用コンピューターで開きます。

      2. ユーザー名とパスワードを使用して Web サイトにサインインします。get-debug-passwordコマンドが以前に印刷されました。

        ローカルデバッグコンソールが開きます。

v2.0.x

ローカルデバッグコンソールを開くには

  1. (オプション)開発用コンピュータでローカルデバッグコンソールを表示するには、SSH 経由でコンソールのポートを転送します。ただし、最初に、を有効にする必要があります。AllowTcpForwardingオプションをコアデバイスの SSH 設定ファイルに追加します。デフォルトでは、このオプションは有効になっています。開発用コンピューターで次のコマンドを実行して、http://localhost:1441開発用コンピュータにをインストールします。

    ssh -L 1441:localhost:1441 -L 1442:localhost:1442 username@core-device-ip-address
    注記

    デフォルトのポートは、1441および1442。詳細については、「」を参照してください。ローカルデバッグコンソールの設定

  2. ローカルデバッグコンソールを使用するセッションを作成します。セッションを作成すると、認証に使用するパスワードが生成されます。ローカルデバッグコンソールでは、セキュリティを強化するためにパスワードが必要です。このコンポーネントを使用して重要な情報を表示したり、コアデバイス上で操作を実行したりできるからです。

    の使用AWS IoT GreengrassCLI を使用してセッションを作成します。このコマンドは、8 時間後に期限切れとなる 43 文字のランダムパスワードを生成します。置換/greengrass/v2へのパスをAWS IoT Greengrass V2のルートフォルダを開きます。

    sudo /greengrass/v2/bin/greengrass-cli get-debug-password

    コマンド出力は、次の例のようになります。

    Username: debug Password: bEDp3MOHdj8ou2w5de_sCBI2XAaguy3a8XxREXAMPLE Password will expire at: 2021-04-01T17:01:43.921999931-07:00

    デバッグビューコンポーネントは、セッションが 4 時間持続を作成し、ローカルデバッグコンソールを再度表示するには、新しいパスワードを生成する必要があります。

  3. オープンhttp://localhost:1441をインストールするか、SSH 経由でポートを転送した場合は、開発用コンピューターで開きます。

  4. ユーザー名とパスワードを使用して Web サイトにサインインします。get-debug-passwordコマンドが以前に印刷されました。

    ローカルデバッグコンソールが開きます。

Changelog

次の表に、の各バージョンの変更点を示します。

バージョン

変更

2.2.2

Greengrass 核バージョン 2.4.0 のリリースを更新しました。

2.2.1

Greengrass 核バージョン 2.3.0 のリリースを更新しました。

2.2.0

Greengrass 核バージョン 2.2.0 のリリースを更新しました。

2.1.0

新機能
  • HTTPS を使用して、ローカルのデバッグコンソールへの接続を保護します。デフォルトでは HTTPS は有効になっています。

バグ修正と機能向上
  • 設定エディタで flashbar メッセージを閉じることができます。

2.0.3

当初のバージョン