diff --git a/ecp/directory.json b/ecp/directory.json index 2731757..1778585 100644 --- a/ecp/directory.json +++ b/ecp/directory.json @@ -138,7 +138,7 @@ }, { "title": "EMQX 集群监控", - "path": "https://docs.emqx.com/zh/enterprise/v4.4/getting-started/dashboard-ee.html#%E7%9B%91%E6%8E%A7" + "path": "monitor/monitor_cluster" }, { "title": "边缘服务监控", @@ -326,7 +326,7 @@ }, { "title": "Monitor EMQX Clusters", - "path": "https://docs.emqx.com/en/enterprise/v4.4/getting-started/dashboard-ee.html#monitor" + "path": "monitor/monitor_cluster" }, { "title": "Monitor Edge Services", diff --git a/ecp/en_US/cluster/_assets/cluster-alarm-notification.png b/ecp/en_US/cluster/_assets/cluster-alarm-notification.png new file mode 100644 index 0000000..e5784c1 Binary files /dev/null and b/ecp/en_US/cluster/_assets/cluster-alarm-notification.png differ diff --git a/ecp/en_US/cluster/_assets/cluster-existing-reg.png b/ecp/en_US/cluster/_assets/cluster-existing-reg.png index 0c04c4c..c0b8cbc 100644 Binary files a/ecp/en_US/cluster/_assets/cluster-existing-reg.png and b/ecp/en_US/cluster/_assets/cluster-existing-reg.png differ diff --git a/ecp/en_US/cluster/_assets/cluster-list.png b/ecp/en_US/cluster/_assets/cluster-list.png index 4c17f06..8d9d71b 100644 Binary files a/ecp/en_US/cluster/_assets/cluster-list.png and b/ecp/en_US/cluster/_assets/cluster-list.png differ diff --git a/ecp/en_US/cluster/add_manage.md b/ecp/en_US/cluster/add_manage.md index 21395cc..24782c3 100644 --- a/ecp/en_US/cluster/add_manage.md +++ b/ecp/en_US/cluster/add_manage.md @@ -1,20 +1,27 @@ # Add EMQX Clusters -ECP supports adding clusters by creating (recommended) or adding existing EMQX clusters. It is recommended to add clusters by creating with ECP, which offers more extensive functionality and allows for license and connection quota sharing. +ECP supports adding clusters by creating (recommended) or adding existing EMQX clusters: + +- Creating clusters with ECP offers more extensive functionality and allows for license and connection quota sharing. +- Adding clusters into ECP allows easy management for existing clusters. ECP supports management for EMQX v4 Enterprise Edition (4.4.6 and above) and EMQX v5 Enterprise Edition (5.6.0 and above). There are functional differences between creating (**Hosted Clusters**) and managing clusters (**Managed Clusters**) on the ECP platform, as shown in the table below. -|Function|Hosted Clusters|Managed Clusters| -|:--------:|:----:|:----:| -|Start/Stop|✅|❌| -|Horizontal Scaling|✅|❌| -|Vertical Scaling|✅|❌| -|Update Network Type|✅|❌| -|Update Connection Limit|✅|❌| -|Upgrade/Downgrade|✅|❌| -|Cluster Transfer|✅|✅| -|Delete|✅|✅| -|Log|✅|✅| +|Function|Hosted v4 Clusters|Managed v4 Clusters|Managed v5 Clusters| +|:--------:|:----:|:----:|:----:| +|Start/Stop|✅|❌|❌| +|Deletion|✅|✅|✅| +|Horizontal Scaling|✅|❌|❌| +|Vertical Scaling|✅|❌|❌| +|Update Network Type|✅|❌|❌| +|Update Connection Limit|✅|❌|✅*| +|Upgrade/Downgrade|✅|❌|❌| +|Log|✅|✅|✅| +|Cluster Monitor|❌|❌|✅| +|Cluster Alarm|❌|❌|✅| +|Cluster Transfer|✅|✅|✅| + +\* For managed clusters, **Update Connection Limit** feature applies to EMQX v5.7.0 and above. ## Create a Hosted Cluster @@ -33,6 +40,30 @@ The newly-created clusters will be listed in the **Cluster List** panel with the cluster-running +## Status for Hosted Cluster + +You can start or stop a cluster as your business requirement changes. + +1. Log in as system admin, organization admin, or project admin. +2. On the target cluster, click the more icon and select **Stop**/**Start**. + +Hosted EMQX cluster can be in the following states: + +| Status | Description | +| ------------------ | ------------------------------------------------------------ | +| Creating | Intermediate state during the process of new cluster creation | +| Updating | Intermediate state during cluster OM operations, such as horizontal or vertical scaling, network type modifications, connection number modifications, cluster upgrade or downgrade | +| Starting | When starting the service | +| Running | Normal running state of the cluster | +| Stopping | When stopping the service or an intermediate state after deleting a cluster | +| Stopped | After stopping or deleting | +| Syncing Status | Intermediate state during horizontal or vertical scaling, cluster upgrade or downgrade, network type modifications, connection number modifications | +| Downgraded Running | One or more nodes of the cluster are unavailable, but the overall cluster is still usable | +| Error | The most recent task executed by the cluster failed (can auto-recover), or a cluster fault or dirty data occurred (this state rarely appears) | +| Nonexistent | The task to create the cluster was not successfully issued | + +For clusters in the state of Error, you can click the more icon and click **Try Fix**. If the problem is successfully solved, the cluster state will be Running; or consider deleting the cluster or reaching out to EMQ's technical support. + ## Add an Existing Cluster ECP also provides the capability to manage existing EMQX clusters. ECP supports the management of EMQX v4 (version 4.4.6 and above) and EMQX v5 (version 5.6.0 and above). @@ -109,30 +140,18 @@ ECP also provides the capability to manage existing EMQX clusters. ECP supports ![cluster-v5-dashboard](./_assets/cluster-v5-dashboard.png) -## Cluster Status - -You can start or stop a cluster as your business requirement changes. - -1. Log in as system admin, organization admin, or project admin. -2. On the target cluster, click the more icon and select **Stop**/**Start**. +## Status for Managed Cluster +Managed EMQX cluster can be in the following states: +| Status | Description | +| ----------- | ------------------------------------------------------------ | +| Created | Cluster with no node registered yet | +| Registering | Intermediate state during cluster node registration | +| Running | Normal running state of the cluster | +| Deleting | Intermediate state before cluster deletion completes | +| Error | Abnormal running state of the cluster, or network connection issue between agent and cluster or between agent and ECP | -EMQX cluster can be in the following states: - -| Status | Description | -| ------------------ | ------------------------------------------------------------ | -| Creating | Intermediate state during the process of new cluster creation | -| Updating | Intermediate state during cluster OM operations, such as horizontal or vertical scaling, network type modifications, connection number modifications, cluster upgrade or downgrade | -| Starting | When starting the service | -| Running | Normal running state of the cluster | -| Stopping | When stopping the service or an intermediate state after deleting a cluster | -| Stopped | After stopping or deleting | -| Syncing Status | Intermediate state during horizontal or vertical scaling, cluster upgrade or downgrade, network type modifications, connection number modifications | -| Downgraded Running | One or more nodes of the cluster are unavailable, but the overall cluster is still usable | -| Error | The most recent task executed by the cluster failed (can auto-recover), or a cluster fault or dirty data occurred (this state rarely appears) | -| Nonexistent | The task to create the cluster was not successfully issued | - -For clusters in the state of Error, you can click the more icon and click **Try Fix**. If the problem is successfully solved, the cluster state will be Running; or consider deleting the cluster or reaching out to EMQ's technical support. +For clusters in the state of Error, you can click the Error status icon to view possible cause. \ No newline at end of file diff --git a/ecp/en_US/cluster/introduction.md b/ecp/en_US/cluster/introduction.md index 0b74e0b..5af11d8 100644 --- a/ecp/en_US/cluster/introduction.md +++ b/ecp/en_US/cluster/introduction.md @@ -4,14 +4,14 @@ In ECP, clusters refer to the EMQX clusters deployed on cloud servers, which serve as high-performance message broker for IoT devices. Built on the MQTT protocol, EMQX offers a lightweight, reliable, and scalable solution for communication between IoT devices. It excels in real-time, high availability, and easy implementation. For a comprehensive understanding of EMQX, please refer to the detailed documentation available on [EMQX Enterprise](https://docs.emqx.com/en/enterprise/v4.4/). -With ECP's cluster management features, users can efficiently handle multiple clusters, create new ones, onboard existing ones, and perform various tasks like troubleshooting, scaling, modifying network types, adjusting connections, upgrading/downgrading, transferring ownership, and deletion. The platform's user-friendly interface offers cluster information overview and log access for improved visibility. +With ECP's cluster management features, users can efficiently handle multiple clusters, create new ones, onboard existing ones, and perform various tasks like troubleshooting, scaling, modifying network types, adjusting connections, upgrading/downgrading, transferring ownership, and deletion. The platform's user-friendly interface offers cluster information overview, monitor, alarm and log access for improved visibility. ## Access Cluster Workspace -After logging in, you can find the **Workspace** option in the ribbon area. Click on it to navigate to the **Workspace - Cluster** page. This page provides an overview of the EMQX clusters hosted or managed by ECP and displays this project's current number of members. +After logging in, you can find the **Workspace** option in the ribbon area. Click on it to navigate to the **Workspace - Cluster** page. This page provides an overview of the EMQX clusters hosted or managed by ECP. :::tip -System admin, organization admin, project admin, and regular users all can access this page, however, regular users do not have access to the administration page, and the **Workspace - Cluster** page serves as their landing page. +System admin, organization admin, project admin, and regular users all can access this page. For the permission of each role, see [Permissions and Roles](../acl/authorize.md#roles-and-permissions). ::: diff --git a/ecp/en_US/cluster/ops.md b/ecp/en_US/cluster/ops.md index aa9fac3..f7837a0 100644 --- a/ecp/en_US/cluster/ops.md +++ b/ecp/en_US/cluster/ops.md @@ -86,7 +86,7 @@ To view the external IP and port, click on the Cluster name (or Cluster ID), or ![LoadBalancer](./_assets/cluster-loadbalancer.png) -## Update Connect Limit (Kubernetes Deployment) +## Update Connect Limit You can dynamically modify the number of connections in the cluster according to business needs: @@ -95,9 +95,9 @@ You can dynamically modify the number of connections in the cluster according to However, please be noted that: -1. The number of connections is limited by the total number of connections allowed by the license. -2. If you are using the LoadBalancer network type, please avoid modifying the number of connections if not necessary, otherwise, it will cause the LoadBalancer's IP address to change. - +1. For hosted cluster, if you are using the LoadBalancer network type, please avoid modifying the number of connections if not necessary, otherwise, it will cause the LoadBalancer's IP address to change. +2. For managed cluster, This feature applies to EMQX v5.7.0 and above. The license quota on ECP will be restored once unregistration or cluster deletion completes, and the connections assigned to EMQX cluster will be reclaimed then. Please reset the EMQX license via **Reset License** from EMQX dashboard. +3. For clusters in the state of Error, you can click the Error status icon to view possible cause. ## Upgrade (Kubernetes Deployment) @@ -128,17 +128,44 @@ For easier management, ECP provides a feature for transferring EMQX clusters acr ECP offers a unified log feature. 1. Log in as system admin, organization admin, or project admin. - -2. On the target cluster, click the more icon and select **Log**. +2. If the existing cluster is added into ECP, please enable and specify logs location when registering cluster node. + - parameter for enabling log collection: `--emqx-log-collection-enabled` + - parameter for cluster log directory path: `--emqx-log-collection-dir /opt/emqx/log`. If the cluster is installed via docker, please mount the log directory on the host machine into the container, and use the directory path on the host machine in the parameter. +3. On the target cluster, click the more icon and select **Log**. You will be directed to the **Log** page, where you can view the log level, generated time, and log messages. For more information on logs, see [Logs](../log/introduction.md). log -## Delete Clusters +## Delete Cluster For unused clusters, it's advisable to delete them to save IT resources. 1. Log in as system admin, organization admin, or project admin. - 2. On the target cluster, click the more icon and select **Delete** and confirm the action. ECP will first stop the cluster before proceeding with the deletion. + +## Monitor Cluster + +ECP provides the status overview for managed clusters on the **Cluster Monitor** page. For details, see [Monitor EMQX Clusters](../monitor/monitor_cluster.md) + +:::tip + +Monitoring on clusters feature applies to EMQX v5. + +::: + +## View Cluster Alarms + +ECP provides the alarm management for cluster rules and connectors on the **Alarm** page. + +To notify cluster alarms by email or Webhook, enable "Push EMQX Alarm" when creating notification. + + + +For other details of alarm, see [Alarms](../monitor/alarm_rules.md) + +:::tip + +Cluster alarms feature applies to EMQX v5. + +:: \ No newline at end of file diff --git a/ecp/en_US/edge_service/edge_project_statistics.md b/ecp/en_US/edge_service/edge_project_statistics.md index 5bc811c..6821743 100644 --- a/ecp/en_US/edge_service/edge_project_statistics.md +++ b/ecp/en_US/edge_service/edge_project_statistics.md @@ -34,4 +34,4 @@ After finishing creating the edge service instances or adding existing edge serv ## Driver and Rule Lists -Underneath these two cards, you'll find the driver and rule lists for edge services, like list for not running drivers, list for abnormal drivers, list for not running rules. These lists provide name and type for each driver or rule, and details about instance it runs on, including edge service name, status, endpoint and version. You can filter edge services in the list by nam. Moreover, you can perform O&M actions per instance by clicking **Details** button from Action column. \ No newline at end of file +Underneath these two cards, you'll find the driver and rule lists for edge services, like list for not running drivers, list for abnormal drivers, list for not running rules. These lists provide name and type for each driver or rule, and details about instance it runs on, including edge service name, status, endpoint and version. You can filter edge services in the list by name. Moreover, you can perform O&M actions per instance by clicking **Details** button from Action column. \ No newline at end of file diff --git a/ecp/en_US/monitor/_assets/alert-notification.png b/ecp/en_US/monitor/_assets/alert-notification.png index 6dea592..7b489e3 100644 Binary files a/ecp/en_US/monitor/_assets/alert-notification.png and b/ecp/en_US/monitor/_assets/alert-notification.png differ diff --git a/ecp/en_US/monitor/_assets/alert-rules.png b/ecp/en_US/monitor/_assets/alert-rules.png index 448638f..e904ea3 100644 Binary files a/ecp/en_US/monitor/_assets/alert-rules.png and b/ecp/en_US/monitor/_assets/alert-rules.png differ diff --git a/ecp/en_US/monitor/_assets/cluster-monitor.png b/ecp/en_US/monitor/_assets/cluster-monitor.png new file mode 100644 index 0000000..e9c09cf Binary files /dev/null and b/ecp/en_US/monitor/_assets/cluster-monitor.png differ diff --git a/ecp/en_US/monitor/alarm_rules.md b/ecp/en_US/monitor/alarm_rules.md index 31d6530..a7fd5f6 100644 --- a/ecp/en_US/monitor/alarm_rules.md +++ b/ecp/en_US/monitor/alarm_rules.md @@ -48,7 +48,7 @@ You can configure the notification silence duration and the objects for which th If the silence duration applies to "Single alarm level", then ECP won't repeatedly send notifications for the same alarm within the silence duration period. Notifications will resume once the silence duration expires. -If the silence duration applies to "Edge service instance level", then any alarms generated on the same edge service within the silence duration period won't trigger repeated notifications. Notifications will resume once the silence duration expires. +If the silence duration applies to "Edge/Cluster service instance level", then any alarms generated on the same edge service or cluster within the silence duration period won't trigger repeated notifications. Notifications will resume once the silence duration expires. Notification silence settings only affect alarms notification through emails and Webhooks. All alarm events will still be displayed in the Active/History Alarms. @@ -58,7 +58,7 @@ Log in as system admins, organization admins, or project admins, you can also se ![alert_rules](./_assets/alert-rules.png) -ECP currently supports alarm rules triggered by edge services and those triggered by ECP itself. Rules triggered by edge services include NeuronEX driver exceptions, NeuronEX rule exceptions, and NeuronEX restarted event. ECP-triggered rules include NeuronEX offline event, email sending failures, and Webhook sending failures. For more details on these rules, please refer to the [Operations Management - Alarm Rules List](../monitor/rules.md). +ECP currently supports alarm rules triggered by edge services, by EMQX clusters and by ECP itself. Rules triggered by edge services include NeuronEX driver exceptions, NeuronEX rule exceptions, NeuronEX offline event, and NeuronEX restarted event. Rules triggered by clusters include EMQX rule exceptions and EMQX connector exceptions. ECP-triggered rules include email sending failures, and Webhook sending failures. For more details on these rules, please refer to the [Operations Management - Alarm Rules List](../monitor/rules.md). You can set both the triggering conditions and rescovery conditions for each rule. The only exception is **NeuronEX restart** alarm rule, which you cannot set for either. You can set smaller triggering values if you want alarms to be more sensitive. Or you can set larger triggering values if you prefer to limit the frequency of alarms. Currently, the upper limit for triggering and recovery values is 10. @@ -70,9 +70,9 @@ Log in as system admins, organization admins, or project admins, you can also se ![alarm-notification-config](./_assets/alarm-notification-config.png) -ECP supports configuring one or more alarm notifications. Different alarm notifications are associated with different edge services by service tags. When alarms are triggered on these associated edge services, notifications will be sent to the corresponding email and Webhooks. +ECP supports configuring one or more alarm notifications. Different alarm notifications are associated with different edge services by service tags, or associated to cluster if **Push EMQX Alarm** is enabled. When alarms are triggered on these associated edge services or clusters, notifications will be sent to the corresponding email and Webhooks. - + ### Alarmed Edge Services @@ -80,6 +80,10 @@ If "All" is selected, any alarms triggered on edge services within the project w Please note: If the alarm is triggered on project level, such as email sending failure or Webhook sending failure alarms, notifications will be sent to emails and Webhooks in all notification configurations. +### Push EMQX Alarm + +If "Push EMQX Alarm" is enabled, any alarm generated on clusters within the project will be sent to the email or Webhook. + ### Email Notification 1. Click the **Email Notification** toggle switch to enable notification by email. diff --git a/ecp/en_US/monitor/monitor_cluster.md b/ecp/en_US/monitor/monitor_cluster.md new file mode 100644 index 0000000..7711dc5 --- /dev/null +++ b/ecp/en_US/monitor/monitor_cluster.md @@ -0,0 +1,15 @@ +# Monitor EMQX Cluster + +ECP provides a comprehensive operating status overview on the **Cluster Monitor** page. + +![cluster-monitor](./_assets/cluster-monitor.png) + +## Basic Statistics + +- Connection: The number of all connections and live connections of all clusters in the project. +- Rule: The number of total cluster rules, running rules and stopped rules in the project. +- Connector: The number of total cluster connectors, connected ones and disconnected ones in the project. + +### Cluster Rule and Connector Lists + +Underneath these cards, you'll find the details of stopped cluster rules and disconnected connectors lists. You can filter the lists by cluster name. Moreover, you can perform O&M actions per instance by clicking **Details** button from Action column. \ No newline at end of file diff --git a/ecp/en_US/monitor/rules.md b/ecp/en_US/monitor/rules.md index 3459a57..0542abf 100644 --- a/ecp/en_US/monitor/rules.md +++ b/ecp/en_US/monitor/rules.md @@ -9,4 +9,6 @@ See below for a list of alarms in ECP. | NeuronEX offline alarm | Critical | NeuronEX {{instance name}} Offline | From the same NeuronEX instance | | NeuronEX restart alarm | Critical | NeuronEX {{instance name}} Restarted | From the same NeuronEX instance | | Email send failed alarm | Normal | Email sending failed, please check mail server configuration. | | -| Webhook send failed alarm | Normal | Webhook sending failed, Webhook address: {{address}} | | +| Webhook send failed alarm | Normal | Webhook sending failed, Webhook address: {{address}}. | | +| EMQX rule alarm | Critical | EMQX {{instance name}} Rule {{rule name}} alarm. | From the same EMQX cluster | +| EMQX connector alarm | Critical | EMQX {{instance name}} Connector {{connector name}} alarm. | From the same EMQX cluster | diff --git a/ecp/zh_CN/cluster/_assets/cluster-alarm-notification.png b/ecp/zh_CN/cluster/_assets/cluster-alarm-notification.png new file mode 100644 index 0000000..555a9e9 Binary files /dev/null and b/ecp/zh_CN/cluster/_assets/cluster-alarm-notification.png differ diff --git a/ecp/zh_CN/cluster/_assets/cluster-existing-reg.png b/ecp/zh_CN/cluster/_assets/cluster-existing-reg.png index 48fd209..12a3a5b 100644 Binary files a/ecp/zh_CN/cluster/_assets/cluster-existing-reg.png and b/ecp/zh_CN/cluster/_assets/cluster-existing-reg.png differ diff --git a/ecp/zh_CN/cluster/_assets/cluster-list.png b/ecp/zh_CN/cluster/_assets/cluster-list.png index 9387c51..2275ada 100644 Binary files a/ecp/zh_CN/cluster/_assets/cluster-list.png and b/ecp/zh_CN/cluster/_assets/cluster-list.png differ diff --git a/ecp/zh_CN/cluster/add_manage.md b/ecp/zh_CN/cluster/add_manage.md index ab2e0ef..a22c056 100644 --- a/ecp/zh_CN/cluster/add_manage.md +++ b/ecp/zh_CN/cluster/add_manage.md @@ -1,22 +1,27 @@ # 添加集群 -ECP 支持通过两种方式添加集群：通过 ECP 一键部署 EMQX 集群（即托管方式）或纳管已有集群。 +ECP 支持通过两种方式添加集群：通过 ECP 一键部署 EMQX 集群（即托管方式）或纳管已有集群： -ECP 推荐通过 ECP 一键部署 EMQX 集群，以便体验更加丰富的集群管理功能，同时享受共享许可证和连接数等高级特性。 +- 通过 ECP 一键部署 EMQX 集群，您可以体验更加丰富的集群管理功能，同时享受共享许可证和连接数等高级特性。 +- 如果您已经部署了一套或几套 EMQX 集群，可以通过 ECP 的集群纳管功能管理已有集群。ECP 目前支持 EMQX v4 企业版（4.4.6 及以上）及 v5 企业版（5.6.0 及以上）的纳管。 下表为由 ECP 托管集群和纳管集群在集群管理方面的功能差异： -|功能名称|ECP **托管**集群|ECP **纳管**集群| -|:--------:|:----:|:----:| -|启停|✅|❌| -|水平扩展|✅|❌| -|垂直扩展|✅|❌| -|修改网络类型|✅|❌| -|修改连接数|✅|❌| -|升降级|✅|❌| -|集群转移|✅|✅| -|删除|✅|✅| -|集群日志|✅|✅| +|功能名称|ECP 托管 v4 集群|ECP 纳管 v4 集群|ECP 纳管 v5 集群| +|:--------:|:----:|:----:|:----:| +|启停|✅|❌|❌| +|删除|✅|✅|✅| +|水平扩展|✅|❌|❌| +|垂直扩展|✅|❌|❌| +|修改网络类型|✅|❌|❌| +|修改连接数|✅|❌|✅*| +|升降级|✅|❌|❌| +|集群日志|✅|✅|✅| +|集群监控|❌|❌|✅| +|集群告警|❌|❌|✅| +|集群转移|✅|✅|✅| + +\* 针对纳管的集群，**修改连接数**功能适用于 EMQX 企业版 5.7.0 及以上版本。 ## ECP 托管集群 @@ -35,21 +40,41 @@ ECP 推荐通过 ECP 一键部署 EMQX 集群，以便体验更加丰富的集 cluster-running -## ECP 纳管现有集群 +## 托管集群状态 + +根据您业务场景的变化，您可对集群进行启停操作。 + +1. 以系统/组织/项目管理员的身份登录 ECP。 +2. 在目标集群上，点击停止/启动。 + +此外，EMQX 集群状态除了上一节说到的**更新中**和**运行中**，还有如下状态： + +| 状态 | 说明 | +| :--------: | :----------------------------------------------------------- | +| 创建中 | 新建集群过程的中间状态 | +| 更新中 | 水平、垂直扩容，修改网络类型，修改连接数，集群升降级 | +| 启动中 | 点击启动服务 | +| 运行中 | 集群正常运行状态 | +| 停止中 | 点击停止服务，或者删除集群后的中间状态 | +| 已停止 | 停止完成，删除 | +| 状态同步中 | 水平、垂直扩容，集群升降级，修改网络类型，修改连接数 | +| 降级运行中 | 集群一个或多个节点不可用， 但集群整体依然可用 | +| 异常 | 集群最近的一个任务执行失败（可自动恢复），或者集群发生故障或者脏数据（极少出现该状态） | +| 不存在 | 集群创建任务没有下发成功， | -如果您已经部署了一套或几套 EMQX 集群，也可通过 ECP 的集群纳管功能管理已有集群。ECP 支持 EMQX v4（4.4.6 及以上版本） 和 EMQX v5 （5.6.0 及以上版本）的纳管。 +如果集群状态显示为**异常**，可以进行尝试**修复**，如果修复成功，集群状态显示**运行中**；如果修复失败，请删除集群或联系 EMQ 技术支持。 -### ECP 纳管 v4 版本 EMQX 集群 +## ECP 纳管现有集群 1. 以系统/组织/项目管理员的身份登录 ECP。在**工作台** -> **云端集群**页面，在集群列表页点击**添加集群**。 2. 集群类型选择**现有集群**。 -3. 集群版本选择**v4**。 +3. 按集群命名规则填写**集群名称**；1-200 个字符，并支持 空格、"-"、"_" -4. 按集群命名规则填写**集群名称**；1-200 个字符，并支持 空格、"-"、"_" +4. 如果纳管的是 EMQX v5 集群，需要填写集群服务地址，即 EMQX dashboard 访问地址。也可以稍后通过“编辑”集群来设置集群服务地址。 -5. 最后，点击**确认**。此时集群列表会新增一个纳管的集群。 +5. 点击**确认**。此时集群列表会新增一个纳管的集群。 6. 在集群卡片或集群列表中，点击**注册节点**，将弹出集群注册引导页。 @@ -63,7 +88,7 @@ ECP 推荐通过 ECP 一键部署 EMQX 集群，以便体验更加丰富的集 - + @@ -96,50 +121,26 @@ ECP 推荐通过 ECP 一键部署 EMQX 集群，以便体验更加丰富的集 sudo /usr/local/bin/emqxee-agent start # 注册到 ECP - sudo /usr/local/bin/emqxee-agent register --url https://[emqxee-agent] --registration-token bf2779e5176446cd8e18fde81d826497 + sudo /usr/local/bin/emqxee-agent register --url https://[ecp] --registration-token bf2779e5176446cd8e18fde81d826497 ``` 10. 回到 ECP **云端集群**页，查看集群列表，可以看到被纳管的 EMQX 集群已被注册到 ECP 中，状态显示为**运行中**； - - - ![纳管集群](./_assets/cluster-existing.png) +![纳管集群](./_assets/cluster-existing.png) -### ECP 纳管 v5 版本 EMQX 集群 +11. 如果纳管的是 v4 版本集群，集群正常运行后，进入集群详情页面，在操作列将出现 **进入Dashboard** 按钮，点击后可访问集群的 dashboard。如果没有出现该按钮，请检查 ECP 配置文件中的 `cluster.agent` 是否配置正确并可被 agent 访问。 +12. 如果纳管的是 v5 版本集群，正确设置集群服务地址后，在集群详情页面的操作列将出现 **进入Dashboard** 按钮，点击即可在新窗口中直接查看集群的 dashboard。 -1. 以系统/组织/项目管理员的身份登录 ECP。在**工作台** -> **云端集群**页面，在集群列表页点击**添加集群**。 -2. 集群类型选择**现有集群**。 -3. 集群版本选择**v5**。 -4. 按集群命名规则填写**集群名称**；1-200 个字符，并支持 空格、"-"、"_" -5. 填写集群服务地址（即 EMQX dashboard 访问地址）和 dashbaord 登录用户名及密码 -6. 最后，点击**确认**。此时集群列表会新增一个纳管的集群。 - -![cluster-v5](./_assets/cluster-v5.png) - -点击操作列的**详情**按钮，进入集群详情，然后点击**进入Dashboard**按钮，您将在新窗口中直接查看 EMQX v5 的 dashboard。 - -![cluster-v5-dashboard](./_assets/cluster-v5-dashboard.png) - -## 集群状态 - -根据您业务场景的变化，您可对集群进行启停操作。 - -1. 以系统/组织/项目管理员的身份登录 ECP。 -2. 在目标集群上，点击停止/启动。 +## 纳管集群状态 -此外，EMQX 集群状态除了上一节说到的**更新中**和**运行中**，还有如下状态： +纳管的 EMQX 集群的状态如下： -| 状态 | 说明 | -| :--------: | :----------------------------------------------------------- | -| 创建中 | 新建集群过程的中间状态 | -| 更新中 | 水平、垂直扩容，修改网络类型，修改连接数，集群升降级 | -| 启动中 | 点击启动服务 | -| 运行中 | 集群正常运行状态 | -| 停止中 | 点击停止服务，或者删除集群后的中间状态 | -| 已停止 | 停止完成，删除 | -| 状态同步中 | 水平、垂直扩容，集群升降级，修改网络类型，修改连接数 | -| 降级运行中 | 集群一个或多个节点不可用， 但集群整体依然可用 | -| 异常 | 集群最近的一个任务执行失败（可自动恢复），或者集群发生故障或者脏数据（极少出现该状态） | -| 不存在 | 集群创建任务没有下发成功， | +| 状态 | 说明 | +| :----: | :----------------------------------------------------------- | +| 已创建 | 新建集群，还未注册节点时的状态 | +| 注册中 | 注册节点过程中的中间状态 | +| 运行中 | 集群正常运行状态 | +| 删除中 | 删除集群后的中间状态 | +| 异常 | 集群未正常运行，或者 agent 无法访问集群，或者 agent 无法与 ECP 正常通信 | -如果集群状态显示为**异常**，可以进行尝试**修复**，如果修复成功，集群状态显示**运行中**；如果修复失败，请删除集群或联系 EMQ 技术支持。 \ No newline at end of file +如果集群状态显示为**异常**，可以点击**异常**状态查看原因。 \ No newline at end of file diff --git a/ecp/zh_CN/cluster/cluster_details.md b/ecp/zh_CN/cluster/cluster_details.md index f41f27b..663c9d5 100644 --- a/ecp/zh_CN/cluster/cluster_details.md +++ b/ecp/zh_CN/cluster/cluster_details.md @@ -1,6 +1,6 @@ # EMQX 集群详情 -在**云端集群**页面的**集群列表**中，您可选择以卡片（默认）或列表的形式查看集群详情。此外，您还可点击**集群名称**或**详情**可以进入到集群详情页，集群详情页提供了集群状态监控、集群基本信息和网络信息。 +在**云端集群**页面的**集群列表**中，您可选择以卡片（默认）或列表的形式查看集群详情。此外，您还可点击**集群名称**或**详情**进入到集群详情页，集群详情页提供了集群状态监控、集群基本信息和网络信息。 ![detail](./_assets/cluster-detail.png) @@ -13,7 +13,7 @@ - **节点数**：每个集群中配置的 EMQX 节点的数量。 - **创建时间**：集群的创建时间。 - **连接总数**：允许建立的最大连接数。 -- **集群规格**：集群的规格。对于由 ECP 创建的集群，系统管理员可更改集群规格。详情请参见[资源设置](../system_admin/resource_config.md#集群资源配额)。 +- **节点规格**：集群中节点的规格。对于由 ECP 创建的集群，系统管理员可更改集群规格。详情请参见[资源设置](../system_admin/resource_config.md#集群资源配额)。 - **类型**：当前集群是托管集群（由 ECP 创建）还是托管集群（由用户自行创建）。 - **版本**：EMQX 集群版本。 @@ -21,7 +21,7 @@ ## 通过 EMQX Dashboard 查看集群详情 -在**集群/详情**页，用户可点击右上角的**进入 Dashboard** 通过 EMQX Dashboard 查看集群详情。 +在**集群/详情**页，用户可点击右上角的 **进入 Dashboard** 通过 EMQX Dashboard 查看集群详情。 Dashboard 是 EMQX 提供的一个 Web 端控制台，用户可通过 EMQX Dashboard 查看服务器节点和集群的运行状态、统计指标，客户端的在线情况和订阅关系等信息，并进行插件配置与停启，HTTP API 密钥管理，EMQX 集群的热配置管理和 MQTT 连接测试等操作。关于 EMQX 企业版的管理控制请参考 [EMQX 企业版产品手册](https://docs.emqx.com/zh/enterprise/v4.4/)。 diff --git a/ecp/zh_CN/cluster/introduction.md b/ecp/zh_CN/cluster/introduction.md index 0a8f5b6..68f0840 100644 --- a/ecp/zh_CN/cluster/introduction.md +++ b/ecp/zh_CN/cluster/introduction.md @@ -4,11 +4,11 @@ EMQX 是一款基于 MQTT 协议开发的开源物联网消息服务器。MQTT 是一种轻量级消息协议，用于在物联网设备之间进行通信。它具有小巧、可靠、可扩展、易于实现等优点。而 EMQX 就是将 MQTT 协议实现为一个实时高可用的消息服务器。关于 EMQX 详细介绍请参考 [EMQX 企业版](https://docs.emqx.com/zh/enterprise/v4.4/)。 -EMQX 集群管理是 ECP 平台核心功能之一，集群管理在分租户分项目的基础上实现多集群管理，可以创建新集群或纳管已有集群，并对管理的集群进行修复、水平扩展、修改网络类型、修改连接数、升降级、集群转让、垂直扩展、删除等操作，并可视化提供集群信息概览和集群日志。 +EMQX 集群管理是 ECP 平台核心功能之一，集群管理在分租户分项目的基础上实现多集群管理，可以创建新集群或纳管已有集群，并对管理的集群进行修复、水平扩展、修改网络类型、修改连接数、升降级、集群转让、垂直扩展、删除等操作，并可视化提供集群信息概览、集群监控、集群告警和集群日志功能。 -## 访问EMQX 集群页面 +## 访问 EMQX 集群页面 -用户登陆后，点击工具栏的**工作台**按钮进入**工作台**界面，即可进入**云端集群**页面。您可在此查看由 ECP 创建或纳管的 EMQX 集群数、项目成员数。 +用户登陆后，点击工具栏的**工作台**按钮进入**工作台**界面，即可进入**云端集群**页面。您可在此查看由 ECP 创建或纳管的 EMQX 集群数。 :::tip 系统管理员、组织管理员、项目管理员和该项目的普通用户均可访问此页面。对于普通项目用户，登录 ECP 后将直接进入**工作台**的**云端集群**页面。 @@ -31,14 +31,18 @@ EMQX 集群管理是 ECP 平台核心功能之一，集群管理在分租户分 托管与纳管的 EMQX 集群在功能上存在差异，具体如下： -|功能名称|ECP **托管**集群|ECP **纳管**集群| -|:--------:|:----:|:----:| -|启停|✅|❌| -|水平扩展|✅|❌| -|垂直扩展|✅|❌| -|修改网络类型|✅|❌| -|修改连接数|✅|❌| -|升降级|✅|❌| -|集群转移|✅|✅| -|删除|✅|✅| -|集群日志|✅|✅| +|功能名称|ECP **托管** v4 集群|ECP **纳管 **v4 集群|ECP **纳管 **v5 集群| +|:--------:|:----:|:----:|:----:| +|启停|✅|❌|❌| +|删除|✅|✅|✅| +|水平扩展|✅|❌|❌| +|垂直扩展|✅|❌|❌| +|修改网络类型|✅|❌|❌| +|修改连接数|✅|❌|✅*| +|升降级|✅|❌|❌| +|集群日志|✅|✅|✅| +|集群监控|❌|❌|✅| +|集群告警|❌|❌|✅| +|集群转移|✅|✅|✅| + +\* 针对纳管的集群，**修改连接数**功能适用于 EMQX 企业版 5.7.0 及以上版本。 \ No newline at end of file diff --git a/ecp/zh_CN/cluster/ops.md b/ecp/zh_CN/cluster/ops.md index 5b65eb9..d3c6e55 100644 --- a/ecp/zh_CN/cluster/ops.md +++ b/ecp/zh_CN/cluster/ops.md @@ -84,19 +84,22 @@ LoadBalancer 一般为公有云环境使用。如希望通过 LoadBalancer 访 ::: -## 修改连接数（托管 - Kubernetes 部署） +## 修改连接数 您可根据业务需求动态修改集群的连接数。 1. 以系统/组织/项目管理员的身份登录 ECP。 2. 在目标集群，点击更多图标并选择**修改连接数**，所做更改将即刻生效。 -3. :::tip + - 在托管集群中，使用 LoadBalancer 网络类型，如无必要请不要修改连接数，否则可能会因 IP 地址的变化而造成访问异常。 + + - 在纳管集群中，5.7.0 及以上版本的纳管集群支持修改连接数，您需要提前获得包含 v5 集群的 ECP 许可证。取消注册节点，或成功删除集群后，将释放集群使用的连接数，您可以通过在 EMQX dashboard 中 **重置License** 来恢复集群的默认连接数。 + - 连接数受许可证总连接数的限制，请注意所有集群的总连接数不要超过许可证限额。 - - 使用 LoadBalancer 网络类型，如无必要请不要修改连接数，否则可能会因 IP 地址的变化而造成访问异常。 -::: + + ::: ## 升级（托管 - Kubernetes 部署） @@ -127,7 +130,10 @@ ECP 提供了 EMQX 集群的升级服务，支持不宕机升级 EMQX 集群。 ECP 提供了统一日志服务。 1. 以系统/组织/项目管理员的身份登录 ECP。 -2. 在目标集群，点击更多图标并选择**日志**。 +2. 如果是通过纳管方式管理集群，您需要在注册节点时开启日志并指定集群日志位置。 + - 开启日志收集参数：`--emqx-log-collection-enabled` + - 指定集群日志所在文件夹路径参数：`--emqx-log-collection-dir /opt/emqx/log `。如果集群是使用 docker 方式安装的，需要提前将日志文件夹映射到宿主机上。 +3. 在目标集群，点击更多图标并选择**日志**。 您随即将进入集群日志页，您可在此查看集群名称、类别、创建时间、日志级别及日志内容，并可通过筛选功能快速定位某条日志。有关日志功能的详细解释，请参考[统一日志](../log/introduction.md)。 @@ -140,4 +146,30 @@ ECP 提供了统一日志服务。 1. 以系统/组织/项目管理员的身份登录 ECP。 2. 在目标集群，点击更多图标并选择**删除**。在弹出的对话框中再次确认删除操作。ECP 会首先停止集群，然后进行删除。 -drop \ No newline at end of file +drop + +## 集群监控 + +ECP 为纳管集群提供了监控功能。进入**集群监控**页面，可以查看纳管集群的运行状态概览。详情请参考[EMQX 集群监控](../monitor/monitor_cluster.md)。 + +:::tip + +仅 EMQX v5 版本的纳管集群支持监控功能。 + +::: + +## 集群告警 + +ECP 为纳管集群支持规则及连接器的异常告警，进入**告警**页面可以查看。 + +如果您需要对集群中发生的告警设置邮件或 Webhook 通知，在创建告警推送时请启用“EMQX 告警推送”。 + + + +有关告警功能的其他详细解释，请参考[告警](../monitor/alarm_rules.md)。 + +:::tip + +仅 EMQX v5 版本的纳管集群支持监控功能。 + +::: \ No newline at end of file diff --git a/ecp/zh_CN/monitor/_assets/alert-notification.png b/ecp/zh_CN/monitor/_assets/alert-notification.png index e82f260..70087af 100644 Binary files a/ecp/zh_CN/monitor/_assets/alert-notification.png and b/ecp/zh_CN/monitor/_assets/alert-notification.png differ diff --git a/ecp/zh_CN/monitor/_assets/alert-rules.png b/ecp/zh_CN/monitor/_assets/alert-rules.png index b44998d..f277b67 100644 Binary files a/ecp/zh_CN/monitor/_assets/alert-rules.png and b/ecp/zh_CN/monitor/_assets/alert-rules.png differ diff --git a/ecp/zh_CN/monitor/_assets/cluster-monitor.png b/ecp/zh_CN/monitor/_assets/cluster-monitor.png new file mode 100644 index 0000000..47a553f Binary files /dev/null and b/ecp/zh_CN/monitor/_assets/cluster-monitor.png differ diff --git a/ecp/zh_CN/monitor/alarm_rules.md b/ecp/zh_CN/monitor/alarm_rules.md index ae011ce..3f795e1 100644 --- a/ecp/zh_CN/monitor/alarm_rules.md +++ b/ecp/zh_CN/monitor/alarm_rules.md @@ -50,7 +50,7 @@ ECP 支持对历史告警的清理，在**历史告警**选项卡中点击 **历 如果沉默时效对象设置为“单条告警级别”，在沉默时效时间范围内，ECP 不会就同一条告警反复发送通知；超过沉默时效后，将会继续推送告警通知。 -如果沉默时效对象设置为“边缘服务实例级别”，在沉默时效时间范围内，同一个边缘服务上产生的任何告警都不会触发反复通知；只有超过沉默时效后，ECP 才会继续推送告警通知。 +如果沉默时效对象设置为“边缘服务/集群实例级别”，在沉默时效时间范围内，同一个边缘服务或同一个集群上产生的任何告警都不会触发反复通知；只有超过沉默时效后，ECP 才会继续推送告警通知。 通知沉默时效只影响邮件及 Webhook 的告警推送，不论如何选择，所有的告警事件仍将展示在当前/历史告警选项卡中。 @@ -60,9 +60,9 @@ ECP 支持对历史告警的清理，在**历史告警**选项卡中点击 **历 ![alert_rules](./_assets/alert-rules.png) -ECP 目前支持的告警规则包括边缘服务触发的规则，及 ECP 触发的规则两类。由边缘服务触发的规则包括：驱动异常、规则异常、NeuronEX 重启；由 ECP 触发的规则包括：NeuronEX 离线、邮件发送失败、Webhook 发送失败。规则的详情请参见[统一运维服务 - 告警规则列表](../monitor/rules.md)。 +ECP 目前支持的告警规则包括边缘服务触发的规则，云端集群触发的规则，及 ECP 端通用规则三类。由边缘服务触发的规则包括：驱动异常、规则异常、NeuronEX 离线、NeuronEX 重启；由云端集群触发的规则包括：EMQX 规则异常、EMQX 连接器异常；ECP 端通用规则包括：邮件发送失败、Webhook 发送失败。规则的详情请参见[统一运维服务 - 告警规则列表](../monitor/rules.md)。 -除 **NeuronEX 重启**告警规则外，您可以对告警规则的触发条件和恢复条件进行设置。如果希望告警更为敏锐，您可以设置较小的触发值；如果希望告警不要过于频繁地触发，您可以设置较大的触发值。触发值和恢复值目前可设置的上限为10。 +除 **NeuronEX 重启**告警规则外，您可以对其他告警规则的触发条件和恢复条件进行设置。如果希望告警更为敏锐，您可以设置较小的触发值；如果希望告警不要过于频繁地触发，您可以设置较大的触发值。触发值和恢复值目前可设置的上限为10。 您也可以对所有的告警规则设置“严重”或“一般”的告警级别用于标识严重程度。如果通知范围指定为“仅通知严重告警事件”，那么一般级别的告警将只会显示在当前/历史告警选项卡中，不会推送到邮件及 Webhook 中。 @@ -72,9 +72,9 @@ ECP 目前支持的告警规则包括边缘服务触发的规则，及 ECP 触 ![alarm-notification-config](./_assets/alarm-notification-config.png) -ECP 支持设置一个或多个告警推送，不同的告警推送通过指定标签关联到边缘服务上，当这些关联的边缘服务上产生告警时，告警将发送到相应的邮件及 Webhook 上。 +ECP 支持设置一个或多个告警推送，不同的告警推送通过指定标签关联到边缘服务上，或者在打开“EMQX 告警推送”的前提下关联到集群上。当这些关联的边缘服务或 EMQX 集群产生告警时，告警将发送到相应的邮件及 Webhook 上。 - + ### 被告警的边缘服务标签 @@ -82,6 +82,10 @@ ECP 支持设置一个或多个告警推送，不同的告警推送通过指定 请注意：如果告警是项目级别的，如邮件发送失败告警、Webhook 发送失败告警，则所有的告警推送中配置的邮件及 Webhook 都将收到通知。 +### EMQX 告警推送 + +如果开启 EMQX 告警推送，项目中任何集群上产生的告警都将被发送到当前告警推送设置的邮件及 Webhook 上。 + ### 邮件通知 1. 滑动**邮件通知**开关为启用状态。 @@ -159,3 +163,4 @@ Content-Type: application/json "uuid": "of9MHKAj" } ``` + diff --git a/ecp/zh_CN/monitor/monitor_cluster.md b/ecp/zh_CN/monitor/monitor_cluster.md new file mode 100644 index 0000000..890bd78 --- /dev/null +++ b/ecp/zh_CN/monitor/monitor_cluster.md @@ -0,0 +1,15 @@ +# EMQX 集群监控 + +ECP 在 **集群监控** 页面提供了项目级别的 EMQX 纳管集群的运行状态统计信息。 + +![cluster-monitor](./_assets/cluster-monitor.png) + +## 基础统计信息 + +- 连接数：项目内所有纳管集群的总连接数量、在线连接数量。 +- 规则：项目内所有纳管集群的规则总数、运行中规则数量及停止的规则数量。 +- 连接器：项目内所有纳管集群的连接器总数、已连接的连接器数量及断开连接的连接器数量。 + +### 规则和连接器列表 + +您还可在统计卡片下查看目前项目 ECP 纳管的 EMQX 集群中，停止运行的规则和断开连接的连接器的详细信息。您可以通过集群的名称对列表内容进行筛选。此外，您也可以通过点击操作栏中的“详情”按钮，进入该集群的 Dashboard 进行查看和操作。 \ No newline at end of file diff --git a/ecp/zh_CN/monitor/rules.md b/ecp/zh_CN/monitor/rules.md index 2a6c727..21052b0 100644 --- a/ecp/zh_CN/monitor/rules.md +++ b/ecp/zh_CN/monitor/rules.md @@ -7,4 +7,6 @@ | NeuronEX 离线告警 | 严重 |NeuronEX {{实例名称}} 离线 | 同一个 NeuronEX | | NeuronEX 重启告警 | 严重 |NeuronEX {{实例名称}} 重启 | 同一个 NeuronEX | | 邮件发送失败告警 | 一般 |邮件发送失败， 请检查邮件服务器配置。 | | -| Webhook 发送失败告警 | 一般 |Webhook 发送失败，Webhook 地址： {{Webhook地址}} | | \ No newline at end of file +| Webhook 发送失败告警 | 一般 |Webhook 发送失败，Webhook 地址： {{Webhook地址}} | | +| EMQX 规则异常 | 严重 |EMQX {{实例名称}} 规则 {{规则名称}} 异常 | 同一个 EMQX 集群 | +| EMQX 连接器异常 | 严重 |EMQX {{实例名称}} 连接器 {{连接器名称}} 异常 | 同一个 EMQX 集群 | \ No newline at end of file