Skip to content

Commit

Permalink
update: cluster management
Browse files Browse the repository at this point in the history
  • Loading branch information
chongyuanyin committed Jul 10, 2024
1 parent dc064ef commit 1d5dce0
Show file tree
Hide file tree
Showing 29 changed files with 169 additions and 286 deletions.
4 changes: 2 additions & 2 deletions ecp/directory.json
Original file line number Diff line number Diff line change
Expand Up @@ -115,7 +115,7 @@
"path": "cluster/introduction",
"children": [
{
"title": "添加集群和启停服务",
"title": "添加集群",
"path": "cluster/add_manage"
},
{
Expand All @@ -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": "边缘服务监控",
Expand Down
Binary file modified ecp/en_US/cluster/_assets/cluster-existing-init.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-existing.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 added ecp/zh_CN/cluster/_assets/cluster-delete.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-detail.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-existing-init.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-existing.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.
Binary file modified ecp/zh_CN/cluster/_assets/cluster-log.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-ops.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.
135 changes: 25 additions & 110 deletions ecp/zh_CN/cluster/add_manage.md
Original file line number Diff line number Diff line change
@@ -1,89 +1,28 @@
# 添加集群
# 纳管集群

ECP 支持通过两种方式添加集群:通过 ECP 一键部署 EMQX 集群(即托管方式)或纳管已有集群
如果您已经部署了一套或几套 EMQX 集群,可以通过 ECP 的集群纳管功能管理已有集群。ECP 目前支持 EMQX v4 企业版(4.4.6 及以上)及 v5 企业版(5.6.0 及以上)的纳管

ECP 推荐通过 ECP 一键部署 EMQX 集群,以便体验更加丰富的集群管理功能,同时享受共享许可证和连接数等高级特性。
## ECP 纳管 EMQX 集群

下表为由 ECP 托管集群和纳管集群在集群管理方面的功能差异:
1. 以系统/组织/项目管理员的身份登录 ECP。在**工作台** -> **数据集成** -> **数据接入**页面,在集群列表页点击**纳管集群**

|功能名称|ECP **托管**集群|ECP **纳管**集群|
|:--------:|:----:|:----:|
|启停|||
|水平扩展|||
|垂直扩展|||
|修改网络类型|||
|修改连接数|||
|升降级|||
|集群转移|||
|删除|||
|集群日志|||
2. 按集群命名规则填写**集群名称**;1-200 个字符,并支持 空格、"-"、"_"。

## ECP 托管集群
3. 如果纳管的是 EMQX v5 集群,需要填写集群服务地址,即 EMQX dashboard 访问地址。也可以稍后通过“编辑”集群来设置集群服务地址。

1. 以系统/组织/项目管理员的身份登录 ECP。在**工作台** -> **云端集群**页面,在集群列表页点击**添加集群**
2. 集群类型选择**新建集群**
3. 按集群命名规则填写**集群名称**;1-200 个字符,并支持 "-"、"_" 和空格。
4. 填写**连接数**,请注意连接数受许可和[集群资源配额](../system_admin/resource_config.md#集群资源配额)限制。
5. 选择**规格**,规格设置在请参考[集群资源配额](../system_admin/resource_config.md#集群资源配额)
6. 选择**节点数**,当前单集群最多支持 7 个节点。
7. 选择**镜像**,镜像可以动态添加,方便用户升级,请参考 [EMQX 容器镜像列表](../system_admin/resource_config.md#emqx-容器镜像列表)[镜像服务信息](../system_admin/resource_config.md#配置镜像服务信息)
8. 最后,点击**确认**
4. 点击**确认**。此时集群列表会新增一个纳管的集群。

![cluster-new](./_assets/cluster-new.png)
![cluster-running](./_assets/cluster-existing-init.png)

新建集群将出现在**云端集群****集群列表**区域。集群状态为**更新中**,集群创建完成后,状态将变成**运行中**,即可投入生产使用。

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

## ECP 纳管现有集群
5. 在集群卡片或集群列表中,点击**注册节点**,将弹出集群注册引导页。

如果您已经部署了一套或几套 EMQX 集群,也可通过 ECP 的集群纳管功能管理已有集群。ECP 支持 EMQX v4(4.4.6 及以上版本) 和 EMQX v5 (5.6.0 及以上版本)的纳管。

### ECP 纳管 v4 版本 EMQX 集群

1. 以系统/组织/项目管理员的身份登录 ECP。在**工作台** -> **云端集群**页面,在集群列表页点击**添加集群**

2. 集群类型选择**现有集群**

3. 集群版本选择**v4**

4. 按集群命名规则填写**集群名称**;1-200 个字符,并支持 空格、"-"、"_"

5. 最后,点击**确认**。此时集群列表会新增一个纳管的集群。

6. 在集群卡片或集群列表中,点击**注册节点**,将弹出集群注册引导页。



![cluster-running](./_assets/cluster-existing-init.png)



7. 在注册引导页,选择 CPU 架构,当前支持 AMD64、ARM、ARM64 三种架构;按照注册引导页的提示完成注册。


6. 在注册引导页,选择 CPU 架构,当前支持 AMD64、ARM、ARM64 三种架构;按照注册引导页的提示完成注册。

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



8. 登录到 EMQX 集群安装的虚机或容器环境,例:登录到命名空间 `emqx-69f4249c` 中名称为 `emqx-69f4249c-emqx-ee-0` 的容器中;

```bash
# 查看 Pod 名称
$ kubectl -n emqx-69f4249c get pod

NAME READY STATUS RESTARTS AGE
emqx-69f4249c-emax-ee-0 3/3 Running 0 28d

# 进入 Pod
$ kubectl -n emqx-69f4249c exec -it emqx-69f4249c-emqx-ee-0 -c emqx -- sh

# 下载 EMQX Agent
$ sudo curl -L -f --output /usr/local/bin/emqxee-agent https://[emqxee-agent]
```

9. 按顺序执行注册引导页中的命令;
7. 登录到 EMQX 集群安装的虚机环境,按顺序执行注册引导页中的命令;

```bash
# 下载 EMQX Agent
Expand All @@ -96,50 +35,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 中,状态显示为**运行中**
8. 回到 ECP **数据接入**页,查看集群列表,可以看到被纳管的 EMQX 集群已被注册到 ECP 中,状态显示为**运行中**
![纳管集群](./_assets/cluster-existing.png)



![纳管集群](./_assets/cluster-existing.png)

### ECP 纳管 v5 版本 EMQX 集群

1. 以系统/组织/项目管理员的身份登录 ECP。在**工作台** -> **云端集群**页面,在集群列表页点击**添加集群**
2. 集群类型选择**现有集群**
3. 集群版本选择**v5**
4. 按集群命名规则填写**集群名称**;1-200 个字符,并支持 空格、"-"、"_"
5. 填写集群服务地址(即 EMQX dashboard 访问地址)和 dashbaord 登录用户名及密码
6. 最后,点击**确认**。此时集群列表会新增一个纳管的集群。
9. 如果纳管的是 v4 版本集群,集群正常运行后,在操作列将出现 **进入Dashboard** 按钮,点击后可访问集群的 dashboard。如果没有出现该按钮,请检查 ECP 配置文件中的 `cluster.agent` 是否配置正确并可被 agent 访问。

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

点击操作列的**详情**按钮,进入集群详情,然后点击**进入Dashboard**按钮,您将在新窗口中直接查看 EMQX v5 的 dashboard。

![cluster-v5-dashboard](./_assets/cluster-v5-dashboard.png)
10. 如果纳管的是 v5 版本集群,正确设置集群服务地址后,在操作列将出现 **进入Dashboard** 按钮,点击即可在新窗口中直接查看集群的 dashboard。

## 集群状态

根据您业务场景的变化,您可对集群进行启停操作。

1. 以系统/组织/项目管理员的身份登录 ECP。
2. 在目标集群上,点击停止/启动。

此外,EMQX 集群状态除了上一节说到的**更新中****运行中**,还有如下状态:
纳管的 EMQX 集群的状态如下:

| 状态 | 说明 |
| :--------: | :----------------------------------------------------------- |
| 创建中 | 新建集群过程的中间状态 |
| 更新中 | 水平、垂直扩容,修改网络类型,修改连接数,集群升降级 |
| 启动中 | 点击启动服务 |
| 运行中 | 集群正常运行状态 |
| 停止中 | 点击停止服务,或者删除集群后的中间状态 |
| 已停止 | 停止完成,删除 |
| 状态同步中 | 水平、垂直扩容,集群升降级,修改网络类型,修改连接数 |
| 降级运行中 | 集群一个或多个节点不可用, 但集群整体依然可用 |
| 异常 | 集群最近的一个任务执行失败(可自动恢复),或者集群发生故障或者脏数据(极少出现该状态) |
| 不存在 | 集群创建任务没有下发成功, |
| 状态 | 说明 |
| :----: | :----------------------------------------------------------- |
| 已创建 | 新建集群,还未注册节点时的状态 |
| 注册中 | 注册节点过程中的中间状态 |
| 运行中 | 集群正常运行状态 |
| 删除中 | 删除集群后的中间状态 |
| 异常 | 集群未正常运行,或者 agent 无法访问集群,或者 agent 无法与 ECP 正常通信 |

如果集群状态显示为**异常**可以进行尝试**修复**,如果修复成功,集群状态显示**运行中**;如果修复失败,请删除集群或联系 EMQ 技术支持
如果集群状态显示为**异常**可以点击**异常**状态查看原因
17 changes: 7 additions & 10 deletions ecp/zh_CN/cluster/cluster_details.md
Original file line number Diff line number Diff line change
@@ -1,27 +1,24 @@
# EMQX 集群详情

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

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

以下为页面每个字段的详细解释:

- **集群名称**:您可单击集群名称(或列表视图中的**集群 ID**)进入集群详情页并获取网络信息。
- **状态**:集群的运行状态,可以是**创建中****运行中****已创建** (针对纳管集群,通常与注册节点一起出现)、**停止中****已停止****启动中****错误**
- **注册节点**:将已有 EMQX 集群注册到 ECP。
- **启动时间**:集群启动的时间。
- **集群名称**:您可通过“编辑”操作修改集群名称。
- **版本**:EMQX 集群版本。
- **节点数**:每个集群中配置的 EMQX 节点的数量。
- **状态**:集群的运行状态,可以是**已创建**(与注册节点一起出现)、**注册中****运行中****删除中****异常**
- **连接总数**:已建立的连接数及允许建立的最大连接数。
- **运行时长**:集群已运行的时间。
- **创建时间**:集群的创建时间。
- **连接总数**:允许建立的最大连接数。
- **集群规格**:集群的规格。对于由 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
39 changes: 17 additions & 22 deletions ecp/zh_CN/cluster/introduction.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,41 +4,36 @@

EMQX 是一款基于 MQTT 协议开发的开源物联网消息服务器。MQTT 是一种轻量级消息协议,用于在物联网设备之间进行通信。它具有小巧、可靠、可扩展、易于实现等优点。而 EMQX 就是将 MQTT 协议实现为一个实时高可用的消息服务器。关于 EMQX 详细介绍请参考 [EMQX 企业版](https://docs.emqx.com/zh/enterprise/v4.4/)

EMQX 集群管理是 ECP 平台核心功能之一,集群管理在分租户分项目的基础上实现多集群管理,可以创建新集群或纳管已有集群,并对管理的集群进行修复、水平扩展、修改网络类型、修改连接数、升降级、集群转让、垂直扩展、删除等操作,并可视化提供集群信息概览和集群日志
ECP 平台提供 EMQX 集群管理功能,集群管理在分租户分项目的基础上实现多集群管理,可以纳管已有集群,并对管理的集群进行修改连接数、集群转移、删除等操作,并可视化提供集群信息概览、集群监控、集群告警和集群日志功能

## 访问EMQX 集群页面
## 访问 EMQX 集群页面

用户登陆后,点击工具栏的**工作台**按钮进入**工作台**界面,即可进入**云端集群**页面。您可在此查看由 ECP 创建或纳管的 EMQX 集群数、项目成员数
用户登陆后,点击工具栏的**工作台**按钮进入**工作台**界面,然后进入**数据集成**下的**数据接入**页面。您可在此查看 ECP 纳管的 EMQX 集群

:::tip
系统管理员、组织管理员、项目管理员和该项目的普通用户均可访问此页面。对于普通项目用户,登录 ECP 后将直接进入**工作台****云端集群**页面。
系统管理员、组织管理员、项目管理员和该项目的普通用户均可访问此页面。

有关不同用户角色的权限说明,见[角色权限一览表](../acl/authorize.md#角色权限一览表)
:::


![集群列表](./_assets/cluster-list.png)

系统管理员、组织管理员、项目管理员可在云端集群页面执行新建集群操作或者纳管已有集群,具体操作步骤,见[添加集群](./add_manage.md)
系统管理员、组织管理员、项目管理员可在云端集群页面执行纳管已有集群的操作,具体操作步骤,见[添加集群](./add_manage.md)

所添加集群将出现在**云端集群**页面的**集群列表**,您可选择以卡片(默认)或列表的形式查看集群详情,具体操作,见[查看集群详情](./cluster_details.md)
所添加集群将出现在**数据接入**页面的集群列表中,您可选择以卡片(默认)或列表的形式查看集群详情,具体操作,见[查看集群详情](./cluster_details.md)

## 托管与纳管EMQX集群的功能差异
## 不同版本 EMQX 纳管集群的功能差异

**托管EMQX集群**:托管 EMQX 集群是指由 ECP 平台通过Kubernetes的方式创建部署的 EMQX 集群,称之为托管 EMQX 集群。
被纳管的 v4 和 v5 版本的 EMQX 集群,在功能上存在差异,具体如下:

**纳管EMQX集群**:纳管 EMQX 集群是指由用户创建部署的 EMQX 集群,并在 ECP 平台添加纳入管理,称之为纳管 EMQX 集群。
| 功能名称 | ECP 纳管 v4 集群 | ECP 纳管 v5 集群 |
| :--------: | :--------------: | :--------------: |
| 修改连接数 || ✅ * |
| 集群日志 |||
| 集群监控 |||
| 集群告警 |||
| 集群转移 |||
| 删除 |||

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

|功能名称|ECP **托管**集群|ECP **纳管**集群|
|:--------:|:----:|:----:|
|启停|||
|水平扩展|||
|垂直扩展|||
|修改网络类型|||
|修改连接数|||
|升降级|||
|集群转移|||
|删除|||
|集群日志|||
\* **修改连接数**功能适用于 EMQX v5.7.0 及以上版本。
Loading

0 comments on commit 1d5dce0

Please sign in to comment.