From 968776cc5275f7e7a46dfa3c9f4298c98458ddb1 Mon Sep 17 00:00:00 2001 From: Meggielqk <126552073+Meggielqk@users.noreply.github.com> Date: Sat, 14 Sep 2024 17:17:29 +0800 Subject: [PATCH 1/3] Update cluster linking doc --- en_US/access-control/authn/kerberos.md | 14 +++++++++++++- en_US/cluster-linking/configuration.md | 10 ++++++---- zh_CN/data-integration/rule-get-started.md | 2 +- 3 files changed, 20 insertions(+), 6 deletions(-) diff --git a/en_US/access-control/authn/kerberos.md b/en_US/access-control/authn/kerberos.md index 38aac49c0..0cb61c41c 100644 --- a/en_US/access-control/authn/kerberos.md +++ b/en_US/access-control/authn/kerberos.md @@ -84,7 +84,19 @@ The `principal` is the server principal, which must be present in the system's d The following diagram shows how the authentication process works. -![kerberos_workflow](./assets/kerberos_workflow.png) +```mermaid +sequenceDiagram + participant Client + participant Server + + Client->>Server: CONNECT (Authentication Method="GSSAPI-KERBEROS", Authentication Data=ClientInitialToken) + Server-->>Client: AUTH (rc=0x18, Authentication Method="GSSAPI-KERBEROS", Authentication Data=ServerInitialToken) + loop SASL Challenge-Response + Client->>Server: AUTH (Authentication Method="GSSAPI-KERBEROS") + Server-->>Client: AUTH (Authentication Method="GSSAPI-KERBEROS") + end + Server-->>Client: CONNACK (rc=0, Authentication Method="GSSAPI-KERBEROS") +``` ## Common Issues and Troubleshooting diff --git a/en_US/cluster-linking/configuration.md b/en_US/cluster-linking/configuration.md index 8054f558c..a1a8cdaee 100644 --- a/en_US/cluster-linking/configuration.md +++ b/en_US/cluster-linking/configuration.md @@ -2,7 +2,7 @@ This page provides guidelines for configuring and managing the Cluster Linking feature through the EMQX Dashboard, configuration file, and REST API. -## Configure Cluster Linking via Dashboard +## Configure and Manage Cluster Linking via Dashboard 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. @@ -12,16 +12,18 @@ On the pop-up dialog, fill in the following fields: - **Cluster Name**: Enter the name of the remote cluster. - **Server Address**: Provide the MQTT listener endpoint of the remote cluster. -- **Client ID Prefix**: Specify a prefix for ClientIDs used by MQTT connections to the remote cluster. +- **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). - **Username**: Username for authentication to the remote cluster, if required. - **Password**: Password for authentication to the remote cluster, if required. -- **Topics**: List of MQTT topic filters that specify which messages the local cluster will receive from the remote cluster. +- **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). - **Enable TLS**: Enable this option if communication between clusters requires TLS encryption. Configure the settings such as SSL certificates. - **Advanced Settings**: Configure additional settings such as MQTT protocol parameters. Click **Create** after you complete the setting. -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. +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. + +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. ## Configure Cluster Linking via Configuration File diff --git a/zh_CN/data-integration/rule-get-started.md b/zh_CN/data-integration/rule-get-started.md index d456ebffd..164be76ad 100644 --- a/zh_CN/data-integration/rule-get-started.md +++ b/zh_CN/data-integration/rule-get-started.md @@ -183,7 +183,7 @@ SQL 处理结果将以 JSON 形式呈现在**输出结果**部分。SQL 处理 ### 查看动作（Sink）和 Source -**规则**页面上的**动作（Sink）**和 **Source** 标签页显示了所有创建的动作（Sink）和 Source。您可以查看基本信息，如名称、连接状态、关联的规则以及启用状态。点击关联规则的数量会将您带到包含该动作（Sink）或 Source 的规则列表，帮助您更轻松地管理数据集成设置。 +**规则**页面上的**动作** **（Sink）** 和 **Source** 标签页显示了所有创建的动作（Sink）和 Source。您可以查看基本信息，如名称、连接状态、关联的规则以及启用状态。点击关联规则的数量会将您带到包含该动作（Sink）或 Source 的规则列表，帮助您更轻松地管理数据集成设置。 您可以通过**操作**列重新连接或修改动作（Sink）或 Source 的设置。点击**更多**，您可以删除该动作（Sink）或 Source，或者使用它创建新规则。 From c14a615b8732e2dbadcfbf55b9a7455d07bbba15 Mon Sep 17 00:00:00 2001 From: Meggielqk <126552073+Meggielqk@users.noreply.github.com> Date: Sat, 14 Sep 2024 17:27:29 +0800 Subject: [PATCH 2/3] Update configuration.md --- zh_CN/cluster-linking/configuration.md | 10 ++++++---- 1 file changed, 6 insertions(+), 4 deletions(-) diff --git a/zh_CN/cluster-linking/configuration.md b/zh_CN/cluster-linking/configuration.md index be4935b0a..5aafaaa53 100644 --- a/zh_CN/cluster-linking/configuration.md +++ b/zh_CN/cluster-linking/configuration.md @@ -2,7 +2,7 @@ 本页面提供通过 EMQX Dashboard、配置文件，以及 REST API 来配置和管理集群连接功能的指南。 -## 通过 Dashboard 配置集群连接 +## 通过 Dashboard 配置和管理集群连接 登录 EMQX Dashboard，从左侧菜单中选择 **管理** -> **集群连接**。在**集群连接**页面，点击右上角的**创建**按钮开始配置新的集群连接。 @@ -12,16 +12,18 @@ - **集群名称**：输入远程集群的名称。 - **服务器地址**：提供远程集群的 MQTT 监听端点。 -- **客户端 ID 前缀**：指定用于与远程集群的 MQTT 连接的客户端 ID 前缀。 +- **客户端 ID 前缀**：指定用于与远程集群的 MQTT 连接的客户端 ID 前缀。详见：[配置 MQTT 连接](./#配置-mqtt-连接)。 - **用户名**：（可选）如有需要，输入连接到远程集群的认证用户名。 - **密码**：（可选）如有需要，输入连接到远程集群的认证密码。 -- **主题**：列出 MQTT 主题过滤器的列表，指定本地集群将从远程集群接收的消息。 +- **主题**：列出 MQTT 主题过滤器的列表，指定本地集群将从远程集群接收的消息。详见：[配置主题](./#配置主题)。 - **启用 TLS**：如果集群之间的通信需要 TLS 加密，请启用此选项。配置 SSL 证书等设置。 - **高级设置**：配置其他如 MQTT 协议参数的设置。 完成设置后，点击**创建**。 -您将看到一个连接远程集群的条目已创建。在**操作**列，您可以删除该连接或编辑设置。 +在集群连接页面中，您可以看到新创建的集群连接条目，默认为启用状态。集群连接列表显示了详细信息，例如集群名称、服务器地址、主题和启用状态。在**操作**列中，您可以通过点击**设置**或**删除**按钮来修改配置或删除条目。 + +点击集群名称将进入**概览**标签页，您可以在此监控消息传输统计数据以及集群连接的执行状态。要永久删除集群连接条目，请点击页面右上角的删除图标。或者，您可以通过切换开关暂时禁用集群连接，配置将会被保留以供将来使用。 ## 通过配置文件配置集群连接 From 0eeb7ec0f558110287280af814df7899dbbb5da8 Mon Sep 17 00:00:00 2001 From: Meggielqk <126552073+Meggielqk@users.noreply.github.com> Date: Sat, 14 Sep 2024 17:30:06 +0800 Subject: [PATCH 3/3] Update configuration.md --- zh_CN/cluster-linking/configuration.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/zh_CN/cluster-linking/configuration.md b/zh_CN/cluster-linking/configuration.md index 5aafaaa53..02ebf2e30 100644 --- a/zh_CN/cluster-linking/configuration.md +++ b/zh_CN/cluster-linking/configuration.md @@ -12,10 +12,10 @@ - **集群名称**：输入远程集群的名称。 - **服务器地址**：提供远程集群的 MQTT 监听端点。 -- **客户端 ID 前缀**：指定用于与远程集群的 MQTT 连接的客户端 ID 前缀。详见：[配置 MQTT 连接](./#配置-mqtt-连接)。 +- **客户端 ID 前缀**：指定用于与远程集群的 MQTT 连接的客户端 ID 前缀。详见：[配置 MQTT 连接](#配置-mqtt-连接)。 - **用户名**：（可选）如有需要，输入连接到远程集群的认证用户名。 - **密码**：（可选）如有需要，输入连接到远程集群的认证密码。 -- **主题**：列出 MQTT 主题过滤器的列表，指定本地集群将从远程集群接收的消息。详见：[配置主题](./#配置主题)。 +- **主题**：列出 MQTT 主题过滤器的列表，指定本地集群将从远程集群接收的消息。详见：[配置主题](#配置主题)。 - **启用 TLS**：如果集群之间的通信需要 TLS 加密，请启用此选项。配置 SSL 证书等设置。 - **高级设置**：配置其他如 MQTT 协议参数的设置。