Skip to content

Commit

Permalink
update: cluster management
Browse files Browse the repository at this point in the history
  • Loading branch information
@chongyuanyin
chongyuanyin committed Aug 2, 2024
1 parent 9909a8e commit eef6f66
Showing 1 changed file with 58 additions and 57 deletions.
115 changes: 58 additions & 57 deletions ecp/zh_CN/cluster/add_manage.md
View file
Original file line number Diff line number Diff line change
@@ -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 托管集群

Expand All @@ -35,21 +40,41 @@ ECP 推荐通过 ECP 一键部署 EMQX 集群，以便体验更加丰富的集

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

## 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. 在集群卡片或集群列表中，点击**注册节点**，将弹出集群注册引导页。

Expand Down Expand Up @@ -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 技术支持。
如果集群状态显示为**异常**，可以点击**异常**状态查看原因。

0 comments on commit eef6f66

Please sign in to comment.