# クラスターリンクの設定

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

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

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

![create_cluster_linking](./assets/create_cluster_linking.png)

設定ページで以下の項目を設定します：

- **Cluster Name**：リモートクラスターの名前を入力します。
- **Server**：リモートクラスターのMQTTホストとポートを指定します。
- **Client ID Prefix**：リモートクラスターへのMQTT接続で使用されるClientIDのプレフィックスを定義します。詳細は[Configure MQTT Connections](#configure-mqtt-connections)を参照してください。
- **Username**：必要に応じて、リモートクラスターへの認証用ユーザー名を入力します。
- **Password**：必要に応じて、リモートクラスターへの認証用パスワードを入力します。
- **Topics**：ローカルクラスターがリモートクラスターから受信するメッセージの対象となるMQTTトピックフィルターのリストです。デフォルトでは空のリストです。プラスアイコンをクリックしてトピックを追加したり、不要なトピックを削除して空にすることも可能です。詳細は[Configure Topics](#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プレフィックス* として機能し、ClientIDの割り当てを制御します。

認証や認可パラメータ（`username`、`password`）などのMQTTプロトコルの他の側面も設定可能です。リモートクラスターはこれらの接続を[認証](../access-control/authn/authn.md)し、クラスターリンク設定で指定された特定のMQTTトピックへのパブリッシュを[認可](../access-control/authz/authz.md)できる必要があります。例えば、上記の設定例に対応するリモートクラスターの[ACLルール](../access-control/authz/file.md)は以下のようになります。

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

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

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

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

EMQXのクラスターリンクは、クラスター間のリンク管理を行うためのREST APIを提供しており、設定作業やリンク状態の監視が可能です。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` を返します。