Skip to content

クラスターリンク クイックスタート

このページでは、2つの離れたEMQXクラスター間でクラスターリンクを設定するためのクイックスタートガイドを提供します。

前提条件

異なる2つのリージョンにそれぞれEMQXクラスターをホストするためのコンピュートリソースを用意してください。この例では、us-easteu-west リージョンを使用し、それぞれのクラスター名を cluster-us-eastcluster-eu-west とします。

要件

  • EMQXバージョン5.8.0以降
  • 一意のクラスター名
  • クラスター間のネットワーク通信

クラスターリンクでは、各クラスターのMQTTリスナーが他方のクラスターのネットワークから到達可能である必要があります。トラフィックの均等分散のため、これらのMQTTリスナーはロードバランサーの背後に配置することを推奨します。セキュリティの観点から、パブリックインターネットを使用する場合は、TLSおよび厳格なTLSまたはMQTTクライアント認証を用いてクラスター間通信を保護してください。

最初のクラスター(cluster-us-east)の設定

最初のクラスター cluster-us-east は、以下の設定スニペットをクラスターの設定ファイルに追加して設定します。

bash
# クラスターリンク設定
cluster {
  # このクラスターの名前
  name = "cluster-us-east"
  links = [
    {
      # 2番目のクラスター名
      name = "cluster-eu-west"
      # 2番目のクラスターのMQTTリスナーのエンドポイント
      server = "emqx.us-east.myinfra.net:11883"
      clientid = "clink-us-east"
      topics = ["#"]
    }
  ]
}

# クラスターリンク接続専用リスナー
listeners {
  tcp.clink {
    bind = 11883
  }
}

この設定は以下を指定しています:

  • リモートクラスター名は cluster-eu-west
  • クラスターは emqx.us-east.myinfra.net:11883 でアクセス可能
  • クラスターリンクMQTT接続のクライアントIDプレフィックスは clink-us-east
  • すべてのメッセージ(# ワイルドカードトピックにマッチする)がローカルクラスターに転送される
  • ポート 11883 でクラスターリンク接続用の専用リスナーが有効化されている

2番目のクラスター(cluster-eu-west)の設定

2番目のクラスター cluster-eu-west は、以下の設定スニペットをクラスターの設定ファイルに追加して設定します。

bash
# クラスターリンク設定
cluster {
  name = "cluster-eu-west"
  links = [
    {
      name = "cluster-us-east"
      server = "emqx.eu-west.myinfra.net:11883"
      clientid = "clink-eu-west"
      topics = ["#"]
    }
  ]
}

# クラスターリンク接続専用リスナー
listeners {
  tcp.clink {
    bind = 11883
  }
}

この設定は最初のクラスターの設定と対称的です。両方の設定が完了しクラスターが稼働すると、2つのクラスター間に対称的で双方向のクラスターリンクが確立されます。非対称リンクの作成も可能であり、後述します。

クラスターリンクの検証

異なるクラスターに接続されたクライアント同士が標準のMQTTメカニズムで通信できることを確認するために、MQTTX CLIツールを使って、一方のクラスターからメッセージをパブリッシュし、もう一方でサブスクライブしてみます。

  1. cluster-us-east でサブスクライバーを起動:

    bash
    mqttx sub -h emqx.us-east.myinfra.net --topic linked/# --qos 1 --verbose
    [6/4/2024] [3:53:32 PM] › …  接続中...
    [6/4/2024] [3:53:32 PM] › ✔  接続完了
    [6/4/2024] [3:53:32 PM] › …  linked/# にサブスクライブ中...
    [6/4/2024] [3:53:32 PM] › ✔  linked/# にサブスクライブ完了
  2. cluster-eu-west からメッセージをパブリッシュ:

    bash
    mqttx pub -h emqx.eu-west.myinfra.net --topic linked/42 --message "Hello from the other side!"
    [6/4/2024] [3:53:35 PM] › …  接続中...
    [6/4/2024] [3:53:35 PM] › ✔  接続完了
    [6/4/2024] [3:53:35 PM] › …  メッセージをパブリッシュ中...
    [6/4/2024] [3:53:35 PM] › ✔  メッセージパブリッシュ完了
  3. サブスクライバーがメッセージを受信したことを確認:

    bash
    [6/4/2024] [3:53:35 PM] › topic: linked/42
    payload: Hello from the other side!
  4. 逆方向も同様に実施:

    • cluster-eu-west でサブスクライバーを起動:

      bash
      mqttx sub -h emqx.eu-west.myinfra.net --topic linked/# --qos 1 --verbose
      [6/4/2024] [3:54:12 PM] › …  接続中...
      [6/4/2024] [3:54:12 PM] › ✔  接続完了
      [6/4/2024] [3:54:12 PM] › …  linked/# にサブスクライブ中...
      [6/4/2024] [3:54:12 PM] › ✔  linked/# にサブスクライブ完了
    • cluster-us-east からメッセージをパブリッシュ:

      bash
      mqttx pub -h emqx.us-east.myinfra.net --topic linked/1 --message "Hello from US!"
      [6/4/2024] [3:54:15 PM] › …  接続中...
      [6/4/2024] [3:54:15 PM] › ✔  接続完了
      [6/4/2024] [3:54:15 PM] › …  メッセージをパブリッシュ中...
      [6/4/2024] [3:54:15 PM] › ✔  メッセージパブリッシュ完了
    • サブスクライバーがメッセージを受信したことを確認:

      bash
      [6/4/2024] [3:54:15 PM] › topic: linked/1
      payload: Hello from US!

完璧です!クラスターリンクは正常に動作しています。

TIP

クラスターリンクはクラスター間でサブスクリプション情報を伝播する非同期プロセスです。通常は数ミリ秒程度ですが、サブスクライブ直後にメッセージをパブリッシュすると、メッセージ配信に若干の遅延が発生する場合があります。

非対称リンクのセットアップ

非対称リンクを作成するには、cluster-eu-west の設定を少し変更します。

bash
cluster {
  name = "cluster-eu-west"
  links = [
    {
      name = "cluster-us-east"
      server = "emqx.eu-west.myinfra.net:11883"
      clientid = "clink-eu-west"
      topics = []
    }
  ]
}

ご覧の通り、前回の設定とほぼ同じですが、topics フィールドが空になっています。これは cluster-eu-westcluster-us-east からのメッセージを一切受け取らないことを意味します。これによりクラスターリンクは非対称となり、クラスター間の一方向メッセージ転送に有用です。

上記のメッセージパブリッシュおよびサブスクライブの手順を繰り返すと、cluster-us-east からパブリッシュされたメッセージが cluster-eu-west のサブスクライバーに届かないことが確認できます。