You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: en_US/cluster-linking/configuration.md
+16-4Lines changed: 16 additions & 4 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -2,7 +2,7 @@
2
2
3
3
This page provides guidelines for configuring and managing the Cluster Linking feature through the EMQX Dashboard, configuration file, and REST API.
4
4
5
-
## Configure Cluster Linking via Dashboard
5
+
## Configure and Manage Cluster Linking via Dashboard
6
6
7
7
Go to the EMQX Dashboard and click **Management** -> **Cluster Linking** from the left menu. On the **Cluster Linking** page, click **Create** at the upper right corner to start creating cluster linking.
8
8
@@ -12,16 +12,18 @@ On the pop-up dialog, fill in the following fields:
12
12
13
13
-**Cluster Name**: Enter the name of the remote cluster.
14
14
-**Server Address**: Provide the MQTT listener endpoint of the remote cluster.
15
-
-**Client ID Prefix**: Specify a prefix for ClientIDs used by MQTT connections to the remote cluster.
15
+
-**Client ID Prefix**: Define a prefix for ClientIDs used by MQTT connections to the remote cluster. For more information, see [Configure MQTT Connections](#configure-mqtt-connections).
16
16
-**Username**: Username for authentication to the remote cluster, if required.
17
17
-**Password**: Password for authentication to the remote cluster, if required.
18
-
-**Topics**: List of MQTT topic filters that specify which messages the local cluster will receive from the remote cluster.
18
+
-**Topics**: List of MQTT topic filters that specify which messages the local cluster will receive from the remote cluster. For more information, see [Configure Topics](#configure-topics).
19
19
-**Enable TLS**: Enable this option if communication between clusters requires TLS encryption. Configure the settings such as SSL certificates.
20
20
-**Advanced Settings**: Configure additional settings such as MQTT protocol parameters.
21
21
22
22
Click **Create** after you complete the setting.
23
23
24
-
You can see an entry for the link to the remote cluster is created. From the **Actions** column, you can delete the linking or edit the settings.
24
+
On the Cluster Linking page, the new entry will appear and be enabled by default. The cluster linking list displays the details, such as cluster name, server address, topics, and enable status. You can modify the settings or delete an entry by clicking the **Settings** or **Delete** buttons in the **Actions** column.
25
+
26
+
Clicking the cluster name takes you to the **Overview** tab, where you can monitor message transmission statistics and the execution status of the cluster linking. To permanently remove the cluster linking entry, click the delete icon at the upper right corner of the page. Alternatively, you can temporarily disable the cluster linking by toggling the switch, which will retain your configuration for future use.
25
27
26
28
## Configure Cluster Linking via Configuration File
27
29
@@ -146,3 +148,13 @@ In addition to configuration tasks, the API provides endpoints for monitoring th
-**Description**: Allows you to reset all the accumulated metrics for a specific cluster link. Once reset, the performance statistics tracked for the link will be cleared and start fresh. This is useful for monitoring performance after configuration changes or for troubleshooting purposes.
157
+
158
+
-**Response sample**: The endpoint returns `204` without content.
0 commit comments