Skip to content

EMQX Fleets デプロイメントの管理

このページでは、EMQX Fleets デプロイメントの管理操作について説明します。デプロイメントの概要監視、依存サービスの確認、Fleets TLS/SSL の管理、API キーの管理、デプロイメント設定の構成などが含まれます。

デプロイメント概要

デプロイメント概要 ページは、Fleets デプロイメントのメインダッシュボードです。デプロイメントのデバイス統計、デプロイメントメタデータ、依存サービス、Fleets TLS/SSL 情報、および API キーを表示します。

fleets_deployment_overview

デバイス統計とデプロイメント情報

指標説明
Thing Typesこのデプロイメントで定義されている Thing Types の総数
Things登録済みデバイスの総数
Things Online / Offline現在のオンラインおよびオフラインのデバイス数
Statusデプロイメントの状態:実行中または停止中
Regionデプロイメントが稼働しているリージョンおよびクラウドプロバイダー
Created Atデプロイメント作成のタイムスタンプ

依存サービス

依存サービス セクションでは、Fleets デプロイメントに接続されている EMQX ブローカーおよび EMQX Tables のデプロイメントを表示します。Fleets はこれらのサービスに依存して MQTT デバイスの接続性と時系列データの保存を実現しています。

各サービスカードには以下が表示されます:

項目説明
Service Type依存するサービスの種類(例:ブローカー、Tables)
Deployment Name接続されているブローカーまたは Tables デプロイメントの名前
Health Status依存サービスの現在のヘルスステータス
Service EndpointFleets がサービスに接続するために使用する内部サービスエンドポイント

このセクションのリフレッシュアイコンをクリックすると、表示されているサービスステータスを更新できます。

Fleets TLS/SSL

Fleets TLS/SSL は、デバイスと Fleets デプロイメントに接続されたブローカー間の MQTT 接続を保護します。また、証明書ベースのデバイス認証のための証明書基盤も提供します。Fleets TLS/SSL セクションでは、Fleets デプロイメントに関連付けられた TLS/SSL 証明書を表示します。

Fleets TLS/SSL は接続されたブローカーに同期され、ブローカーの TLS/SSL ページで Fleets 管理として表示されます。もし接続されたブローカーにすでに TLS/SSL 設定がある場合、Fleets TLS/SSL 設定の作成によりブローカーの TLS/SSL 設定が引き継がれます。その後、ブローカーの TLS/SSL 設定は読み取り専用となり、Fleets デプロイメントから管理する必要があります。

証明書リストには以下が含まれます:

項目説明
Expire At証明書の有効期限
Common Name証明書のコモンネーム
TLS/SSL TypeTLS/SSL 認証の種類
Status証明書の状態
Source証明書のソース

Fleets は既存の TLS/SSL 有効期限アラート機構を利用して、サーバー TLS 証明書またはクライアント証明書発行 CA の有効期限切れ前に通知します。

利用可能な操作は TLS/SSL の状態によって異なります。状態が Running の場合は設定の置換または削除が可能です。Pending の場合は証明書操作は一時的に利用できません。Failed の場合はコンソール上で TLS/SSL 設定の削除や再作成はできません。支援が必要な場合は サポートチケットの提出 で EMQX チームにお問い合わせください。

Fleets TLS/SSL 設定の作成

  1. デプロイメント概要 ページの Fleets TLS/SSL セクションに移動します。
  2. + Create TLS/SSL をクリックします。
  3. TLS/SSL Type を選択します:
    • one-way:クライアントはサーバー証明書を検証します。
    • two-way:クライアントとサーバーがお互いの証明書を検証します。証明書ベースのデバイス認証を有効にする場合はこちらを使用します。
  4. 必要な PEM エンコード済み証明書ファイルを入力またはアップロードします:
    • Certificate and Certificate Chain:サーバー証明書および証明書チェーン
    • Certificate Private Key:サーバー証明書に対応する秘密鍵
    • Client CA Certificate:two-way TLS/SSL の場合に必要。クライアント証明書の発行および検証に使用される CA 証明書
    • Client CA Private Key:two-way TLS/SSL の場合に必要。クライアント証明書発行に使用される秘密鍵
  5. Confirm をクリックします。

TIP

秘密鍵は証明書設定のためにのみ使用されます。送信後は表示されず、ダウンロードもできません。

Fleets TLS/SSL 設定の置換

現在の Fleets TLS/SSL 設定を置換するには、Fleets TLS/SSL セクションから編集し、証明書群を再度完全に提出してください。Fleets は単一の証明書フィールドのみを独立して編集することはサポートしていません。

TLS/SSL タイプは置換時に変更できません。one-way と two-way TLS/SSL を切り替えるには、既存の設定を削除してから、必要なタイプで新規作成してください。

Fleets TLS/SSL の置換は、接続されたブローカー上の Fleets 管理 TLS/SSL 設定も更新します。

Fleets TLS/SSL 設定の削除

Fleets TLS/SSL を削除すると、Fleets デプロイメントおよび接続されたブローカーの両方から Fleets 管理 TLS/SSL 設定が削除され、ブローカー側の TLS/SSL 管理が復元されます。

重要なお知らせ

Fleets TLS/SSL の削除は、TLS/SSL または証明書認証を通じて接続しているデバイスに影響を与えます。証明書ベースのデバイス認証を有効にしている場合は、TLS/SSL 設定を削除する前に Device AuthenticationCertificate 以外に切り替えてください。

Fleets デプロイメントが接続されたブローカーの TLS/SSL 設定を管理している状態で削除されると、ブローカーからも Fleets 管理 TLS/SSL 設定が削除されます。

デプロイメント API キー

API キーは Fleets REST API へのプログラム的アクセスを可能にします。各キーには特定のエンドポイントおよび HTTP メソッドにスコープされた API 権限が設定されています。

完全な API リファレンスは EMQX Fleets API を参照してください。

このデプロイメントの API エンドポイント は、デプロイメント概要ページの Deployment API Key セクションの上部に表示されます。すべての Fleets REST API 呼び出しのベース URL としてこの URL を使用してください:

text
https://{deploymentId}.ala.gcp.fleets.mqttce.net:8443

すべての API リクエストは、API キーとシークレットを使った Basic Auth で認証します:

text
Authorization: Basic <base64(apiKey:apiSecret)>

deployment_api_keys

API キーの作成

  1. デプロイメント概要 ページの Deployment API Key セクションに移動します。

  2. + New API Key をクリックします。

  3. キーの Name を入力します。

  4. API Permissions で、このキーがアクセスを許可されるエンドポイントおよび HTTP メソッドを選択します。メソッドボタン(GET、POST、PUT、PATCH、DELETE)でメソッドごとにフィルターしたり、検索ボックスでパスプレフィックスを絞り込めます。

    キーには必要な権限のみを付与してください。例えば、デバイスがデータを報告するためのキーなら POST /api/v1/thing-datas のみで十分です。読み取り専用の監視用キーなら /api/v1/things/api/v1/thing-types への GET アクセスだけで足ります。管理やテスト目的以外で Select All は使用しないでください。

    new_api_key
  5. Confirm をクリックすると、生成された API KeyAPI Secret がダイアログに表示されます。

    TIP

    API Secret は作成時にのみ表示されます。安全に保管してください。後から取得できません。

  6. Close をクリックします。

API キーの管理

  • 権限の表示:キーの左側の展開矢印をクリックすると、割り当てられた API Permissions がリソースパスごとにグループ化されて表示されます。
  • 編集Actions 列の編集アイコンをクリックして、Name の変更や API Permissions の修正が可能です。
  • 削除Actions 列の削除アイコンをクリックすると、即座にアクセス権が取り消されます。

重要なお知らせ

稼働中のアプリケーションやデバイスで使用されている API キーを削除すると、連携が即座に切断されます。削除前にキーが使用されていないことを必ず確認してください。

デプロイメント設定

デプロイメント設定 ページでは、デプロイメントの構成詳細を表示します。

項目説明
Deployment Name編集可能。編集アイコンをクリックして名前を変更します。
Deployment IDこのデプロイメントの一意の識別子。API 呼び出しやサポート依頼で使用します。
Plan現在のプラン(例:Starter)。
Network IDこのデプロイメントのネットワーク識別子。
Cloud Platformクラウドプロバイダー(読み取り専用)。
Regionデプロイメントのリージョン(読み取り専用)。
Billing Method現在の課金方法。パブリックベータ期間中は、トライアルデプロイメントは Trial、非トライアルは Free と表示されます。

デプロイメント名の変更

  1. デプロイメント設定 に移動します。
  2. Deployment Name の横にある編集アイコンをクリックします。
  3. 新しい名前を入力して確定します。

デバイス認証の設定

Device Authentication セクションでは、接続されたブローカー経由で接続するデバイスの認証方法を制御します。

利用可能な認証モードは以下の通りです:

モード説明
Passwordブローカーに設定されたユーザー名とパスワード認証情報でデバイスを認証します。
Certificateクライアント証明書でデバイスを認証します。このモードを利用するには、two-way Fleets TLS/SSL 設定が実行中である必要があります。

証明書認証を有効にするには、まず two-way Fleets TLS/SSL 設定を作成し、状態が Running になるまで待ちます。その後、デプロイメント設定 に移動し、Device AuthenticationCertificate を選択して Apply をクリックします。

デプロイメントの削除

Fleets デプロイメントを削除するには、デプロイメント設定 に移動し、Delete Deployment をクリックします。

重要なお知らせ

Fleets デプロイメントの削除は永久的で元に戻せません。Fleets デプロイメントおよびそのデバイス管理データが削除されます。Fleets デプロイメントが接続されたブローカーの TLS/SSL 設定を管理している場合、Fleets 管理 TLS/SSL 設定もブローカーから削除されます。

次のステップ