Skip to content

Commit

Permalink
update
Browse files Browse the repository at this point in the history
  • Loading branch information
chongyuanyin committed Aug 8, 2024
1 parent eef6f66 commit 0f470bd
Show file tree
Hide file tree
Showing 10 changed files with 61 additions and 25 deletions.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/en_US/cluster/_assets/cluster-existing-reg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/en_US/cluster/_assets/cluster-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/zh_CN/cluster/_assets/cluster-existing-reg.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
Binary file modified ecp/zh_CN/cluster/_assets/cluster-list.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
4 changes: 2 additions & 2 deletions ecp/zh_CN/cluster/add_manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,7 +21,7 @@ ECP 支持通过两种方式添加集群:通过 ECP 一键部署 EMQX 集群
|集群告警||||
|集群转移||||

\* **修改连接数**功能适用于 EMQX 企业版 5.7.0 及以上版本。
\* 针对纳管的集群,**修改连接数**功能适用于 EMQX 企业版 5.7.0 及以上版本。

## ECP 托管集群

Expand Down Expand Up @@ -88,7 +88,7 @@ ECP 支持通过两种方式添加集群:通过 ECP 一键部署 EMQX 集群



<img src="./_assets/cluster-existing-reg.png" style="zoom:50%;" align="middle">
<img src="./_assets/cluster-existing-reg.png" style="zoom:80%;" align="middle">



Expand Down
6 changes: 3 additions & 3 deletions ecp/zh_CN/cluster/cluster_details.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# EMQX 集群详情

**云端集群**页面的**集群列表**中,您可选择以卡片(默认)或列表的形式查看集群详情。此外,您还可点击**集群名称****详情**可以进入到集群详情页,集群详情页提供了集群状态监控、集群基本信息和网络信息。
**云端集群**页面的**集群列表**中,您可选择以卡片(默认)或列表的形式查看集群详情。此外,您还可点击**集群名称****详情**进入到集群详情页,集群详情页提供了集群状态监控、集群基本信息和网络信息。

![detail](./_assets/cluster-detail.png)

Expand All @@ -13,15 +13,15 @@
- **节点数**:每个集群中配置的 EMQX 节点的数量。
- **创建时间**:集群的创建时间。
- **连接总数**:允许建立的最大连接数。
- **集群规格**集群的规格。对于由 ECP 创建的集群,系统管理员可更改集群规格。详情请参见[资源设置](../system_admin/resource_config.md#集群资源配额)
- **节点规格**集群中节点的规格。对于由 ECP 创建的集群,系统管理员可更改集群规格。详情请参见[资源设置](../system_admin/resource_config.md#集群资源配额)
- **类型**:当前集群是托管集群(由 ECP 创建)还是托管集群(由用户自行创建)。
- **版本**:EMQX 集群版本。



## 通过 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/)

Expand Down
32 changes: 18 additions & 14 deletions ecp/zh_CN/cluster/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 后将直接进入**工作台****云端集群**页面。
Expand All @@ -31,14 +31,18 @@ EMQX 集群管理是 ECP 平台核心功能之一,集群管理在分租户分

托管与纳管的 EMQX 集群在功能上存在差异,具体如下:

|功能名称|ECP **托管**集群|ECP **纳管**集群|
|:--------:|:----:|:----:|
|启停|||
|水平扩展|||
|垂直扩展|||
|修改网络类型|||
|修改连接数|||
|升降级|||
|集群转移|||
|删除|||
|集群日志|||
|功能名称|ECP **托管** v4 集群|ECP **纳管 **v4 集群|ECP **纳管 **v5 集群|
|:--------:|:----:|:----:|:----:|
|启停||||
|删除||||
|水平扩展||||
|垂直扩展||||
|修改网络类型||||
|修改连接数|||*|
|升降级||||
|集群日志||||
|集群监控||||
|集群告警||||
|集群转移||||

\* 针对纳管的集群,**修改连接数**功能适用于 EMQX 企业版 5.7.0 及以上版本。
44 changes: 38 additions & 6 deletions ecp/zh_CN/cluster/ops.md
Original file line number Diff line number Diff line change
Expand Up @@ -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 部署)
Expand Down Expand Up @@ -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)

Expand All @@ -140,4 +146,30 @@ ECP 提供了统一日志服务。
1. 以系统/组织/项目管理员的身份登录 ECP。
2. 在目标集群,点击更多图标并选择**删除**。在弹出的对话框中再次确认删除操作。ECP 会首先停止集群,然后进行删除。

<img src="./_assets/cluster-drop.png" alt="drop" style="zoom:50%;" />
<img src="./_assets/cluster-drop.png" alt="drop" style="zoom:50%;" />

## 集群监控

ECP 为纳管集群提供了监控功能。进入**集群监控**页面,可以查看纳管集群的运行状态概览。详情请参考[EMQX 集群监控](../monitor/monitor_cluster.md)

:::tip

仅 EMQX v5 版本的纳管集群支持监控功能。

:::

## 集群告警

ECP 为纳管集群支持规则及连接器的异常告警,进入**告警**页面可以查看。

如果您需要对集群中发生的告警设置邮件或 Webhook 通知,在创建告警推送时请启用“EMQX 告警推送”。

<img src="./_assets/cluster-alarm-notification.png" style="zoom: 80%;" align="middle">

有关告警功能的其他详细解释,请参考[告警](../monitor/alarm_rules.md)

:::tip

仅 EMQX v5 版本的纳管集群支持监控功能。

:::

0 comments on commit 0f470bd

Please sign in to comment.