Skip to content

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

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

前提条件

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

要件

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

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

本番環境に移行する前に、専用のセキュアクラスターリンクガイドに従い、各クラスターの認証、認可、および$LINK/トピックネームスペースを強化してください。

最初のクラスター(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のサブスクライバーに届かないことが確認できます。