EMQX Enterprise

日本語

简体中文
English

日本語

简体中文
English

Appearance

お問い合わせ
お問い合わせ

クラスターリンクユーザーガイド ​

このページでは、EMQXダッシュボード、設定ファイル、およびREST APIを通じてクラスターリンク機能を設定および管理するためのガイドラインを提供します。

ダッシュボードによるクラスターリンクの設定と管理 ​

EMQXダッシュボードにアクセスし、左側メニューから Management -> Cluster Linking をクリックします。Cluster Linking ページの右上にある Create をクリックしてクラスターリンクの作成を開始します。

create_cluster_linking

設定ページでは、以下の項目を設定します。

  • Cluster Name：リモートクラスターの名前を入力します。
  • Server：リモートクラスターのMQTTホストとポートを指定します。
  • Client ID Prefix：リモートクラスターへのMQTT接続で使用されるClientIDのプレフィックスを定義します。詳細は Configure MQTT Connections を参照してください。
  • Username：必要に応じてリモートクラスター認証用のユーザー名を入力します。
  • Password：必要に応じてリモートクラスター認証用のパスワードを入力します。
  • Topics：ローカルクラスターがリモートクラスターから受信するメッセージの対象となるMQTTトピックフィルターのリストです。デフォルトでは空です。プラス記号をクリックしてトピックを追加したり、削除して空に戻すことができます。詳細は Configure Topics を参照してください。
  • Enable TLS：クラスター間通信にTLS暗号化が必要な場合はこのオプションを有効にし、SSL証明書などの設定を行います。
  • Advanced Settings：MQTTプロトコルパラメータなどの追加設定を行います。

設定が完了したら Create をクリックします。

新しいエントリーがクラスターリンクページに表示され、デフォルトで有効になります。クラスターリンクの一覧には、クラスター名、サーバーアドレス、トピック、状態などの詳細が表示されます。Actions 列の Settings または Delete ボタンで設定の変更や削除が可能です。

クラスター名をクリックすると Overview タブに移動し、メッセージ送受信の統計やクラスターリンクの実行状況を監視できます。ページ右上の削除アイコンをクリックするとクラスターリンクエントリーを完全に削除できます。スイッチを切り替えることで一時的にクラスターリンクを無効化し、設定を保持したまま再利用も可能です。

設定ファイルによるクラスターリンクの設定 ​

EMQX設定ファイルの cluster.links リストに複数のクラスターリンクを設定できます。各リンクは一意のリモートクラスター名を持ち、個別に有効・無効を切り替えられます。

リンクの正常な動作には、各リンクでクラスター名を一貫して設定することが重要です。以下の例では、リモートクラスター名は対応する設定ファイルで emqx-eu-west とする必要があります。

bash
cluster {
  name = "emqx-us-east"
  links = [
    {
      name = "emqx-eu-west"
      server = "emqx.us-east.myinfra.net:11883"
      username = "clink-user:us-east"
      password = "clink-password-no-one-knows"
      clientid = "clink-us-east"
      topics = ["global/#", "fwd/#", "cluster/+/status", ...]
      ssl {
        enable = true
        verify = verify_peer
        certfile = "etc/certs/client/emqx-us-east.pem"
        ...
      }
    }
    ...
  ]
}

リモートの emqx-eu-west クラスターも同様に設定ファイルで emqx-us-east へのリンクを設定しておく必要があります。

リンクの有効化と無効化 ​

設定済みのリンクはデフォルトで有効です。enable パラメータを false に設定すると無効化できます。

リンクを無効化すると、EMQXはリモートクラスターとの通信を停止します。ただし、リモートクラスター側が通信を停止しない場合、警告やアラームが発生する可能性があります。これを避けるため、リンクは両側で無効化してください。

トピックの設定 ​

topics パラメータは、ローカルクラスターが関心を持つMQTTトピックフィルターのリストです。ローカルクラスターは、リモートクラスターからこれらのトピックにパブリッシュされたメッセージを受信します。リストが空の場合、ローカルクラスターはリモートクラスターからメッセージを受信しません。

MQTT接続の設定 ​

クラスターリンクは標準のMQTTを基盤プロトコルとして使用し、リモートクラスターのMQTTリスナーエンドポイントを server に指定します。

クラスターの規模や構成に応じて、リモートクラスターへの複数のMQTTクライアント接続が確立される場合があります。各クライアントは一意のClientIDを持つ必要があり、clientid パラメータでこれらのClientIDのプレフィックスを指定して制御できます。

認証や認可パラメータ（username、password）も設定可能です。リモートクラスターはこれらの接続を認証し、クラスターリンク設定で指定されたトピックへのパブリッシュを認可する必要があります。例えば、上記設定の場合、リモートクラスターは以下のようなACLルールを持つことで正常に動作します。

erlang
%% クラスターリンクMQTTクライアントが"$LINK/#"トピックを操作できるよう許可
{allow, {clientid, {re, "^clink-us-east"}}, all, ["$LINK/#"]}.
...

このルールにより、ClientIDが正規表現 ^clink-us-east にマッチするMQTTクライアントは、$LINK/ で始まる任意のトピックに対してパブリッシュおよびサブスクライブが可能になります。$LINK/ はクラスターリンク関連メッセージの制御用トピックプレフィックスであり、サブスクライバーがクラスターリンクの維持・管理に必要なすべてのメッセージを受信できるようにします。

クラスターリンクはTLS接続をサポートしています。パブリックインターネットや信頼できないネットワーク上でクラスター間通信を行う場合はTLSが必須です。EMQXは相互TLS認証もサポートし、安全で機密性の高い信頼できる通信を実現します。

REST APIによるクラスターリンクの管理 ​

EMQXのクラスターリンクは、クラスター間リンクの管理を可能にするREST APIを提供しています。設定作業やリンク状態の監視を行うための基本的および高度な操作が用意されています。

基本的なREST API操作 ​

簡単なユースケース向けに、以下のエンドポイントで基本的なREST API操作をサポートしています。

  • クラスターリンクの設定：
    • エンドポイント：PUT /cluster/links
    • 機能：必要な設定パラメータを一括で送信し、クラスターリンクの作成または更新を行います。シンプルなホット設定に適しています。
  • クラスターリンク情報の取得：
    • エンドポイント：GET /cluster/links
    • 機能：現在のすべてのクラスターリンクの設定と状態を取得します。アクティブなリンクを素早く確認できます。

高度なCRUD API操作 ​

より詳細な管理には、以下のCRUD（作成、取得、更新、削除）操作が利用可能です。

操作エンドポイント機能
クラスターリンクの作成POST /cluster/links新しいクラスターリンクを作成し、初期設定を行います。
特定クラスターリンクの取得GET /cluster/links/{name}名前で指定した特定のクラスターリンクの詳細情報を取得します。
クラスターリンクの更新PUT /cluster/links/{name}既存のクラスターリンクの設定（トピック、サーバーアドレス、認証情報など）を変更します。
クラスターリンクの削除DELETE /cluster/links/{name}指定したクラスターリンクを削除し、クラスター間接続を終了します。

クラスターリンクの状態およびメトリクスの監視 ​

設定以外に、APIはクラスターリンクの状態やパフォーマンスを監視するためのエンドポイントも提供します。

クラスターリンクの状態取得：

  • エンドポイント：GET /cluster/links または GET /cluster/links/{name}

  • 機能：すべてのクラスターリンクまたは特定リンクの状態を返します。レスポンスには全体の状態（running、stoppedなど）やノードごとの詳細状態が含まれます。

  • レスポンス例：

    json
    {
  ...
  "server": "broker.emqx.io:1883",
  "topics": ["t/#"],
  "status": "running",
  "node_status": [
    {"node": "emqx@127.0.0.1", "status": "running"}
  ]
}

クラスターリンクのメトリクス取得：

  • エンドポイント：GET /cluster/links/{name}/metrics

  • 説明：アクティブルート数（ゲージタイプ）など、クラスターリンクに関連するメトリクスを提供し、リンクの負荷やパフォーマンスを評価できます。

  • レスポンス例：

    json
    {
  "metrics": {"routers": 10240},
  "node_metrics": [{}]
}

特定クラスターリンクのメトリクスリセット

  • エンドポイント：PUT /cluster/links/link/:name/metrics/reset

  • 説明：指定したクラスターリンクの累積メトリクスをリセットします。リセット後はパフォーマンス統計がクリアされ、新たに計測が開始されます。設定変更後の監視やトラブルシューティングに役立ちます。

  • レスポンス例：204（コンテンツなし）を返します。