Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

full-doc review for dashboard-ent #1662

Merged
merged 9 commits into from
Apr 21, 2022
Merged
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
14 changes: 8 additions & 6 deletions docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,7 +2,7 @@

Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Graph 多集群中机器和服务状态的可视化工具。本文主要介绍企业版 Dashboard,社区版详情参见[什么是 Nebula Dashboard(社区版)](../nebula-dashboard/1.what-is-dashboard.md)。

![intro-overview](https://docs-cdn.nebula-graph.com.cn/figures/intro-overview_cn.gif)
![intro-overview](https://docs-cdn.nebula-graph.com.cn/figures/intro-overview-2022-4-14_cn.gif)
## 产品功能

- 创建指定版本的 Nebula Graph 集群,支持批量导入节点、一键添加服务等功能。
Expand All @@ -25,7 +25,7 @@ Nebula Dashboard(简称 Dashboard)是一款用于监控和管理 Nebula Grap

- 监控数据默认更新频率约为 7 秒。
- 监控数据默认保留 14 天,即只能查询最近 14 天内的监控数据。
- 只支持 2.5.1 及以上版本的 Nebula Graph。
- 只支持 2.5.0 及以上版本的 Nebula Graph。
- 建议使用最新版本的 Chrome 访问 Dashboard。
- 建议使用官方提供的安装包进行集群创建或导入。

Expand All @@ -39,7 +39,9 @@ Nebula Graph 的版本和 Dashboard 企业版的版本对应关系如下。

|Nebula Graph 版本|Dashboard 版本|
|:---|:---|
|2.5.1~3.0.0|1.1.0|
|2.0.1~2.6.1|1.0.2|
|2.0.1~2.6.1|1.0.1|
|2.0.1~2.6.1|1.0.0|
|2.5.x ~ 3.1.x|3.0.0|
|2.5.1 ~ 3.0.0|1.1.0|
|2.0.1 ~ 2.6.1|1.0.2|
|2.0.1 ~ 2.6.1|1.0.1|
|2.0.1 ~ 2.6.1|1.0.0|

Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

在部署 Dashboard 之前,用户需要确认以下信息:

- 选择并下载符合版本的 Dashboard。关于 Dashboard 版本和 Nebula Graph 的版本对应关系,参见 [版本兼容性](1.what-is-dashboard-ent.md)。
- 选择并下载符合版本的 Dashboard。关于 Dashboard Nebula Graph 的版本对应关系,参见[版本兼容性](1.what-is-dashboard-ent.md)。

- 准备版本为 5.7 以上的 [MySQL](https://www.mysql.com/cn/) 环境,创建名称为`dashboard`的数据库。

Expand Down Expand Up @@ -369,4 +369,4 @@ sudo dpkg -r <package_name>

首次登录企业版 Nebula Dashboard 的时候,页面显示*最终用户许可协议*的内容,请仔细阅读并单击**同意**。

用户可以使用初始化用户名`nebula`和密码`nebula`登录 Dashboard。登录 Dashboard 后可创建 LDAP 账户和普通账户,然后使用不同的账户登录 Dashboard。关于账户的详情,参见 [权限管理](../nebula-dashboard-ent/5.account-management.md)。
用户可以使用初始化用户名`nebula`和密码`nebula`登录 Dashboard。登录 Dashboard 后可创建 LDAP 账户和普通账户,然后使用不同的账户登录 Dashboard。关于账户的详情,参见[权限管理](../nebula-dashboard-ent/5.account-management.md)。
4 changes: 2 additions & 2 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/2.monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -41,9 +41,9 @@

图空间的监控指标记录不同图空间的数据。目前,只有 Graph 服务支持基于图空间的监控指标。

只有当图空间指标的行为被触发后,用户才能指定图空间查看对应的图空间指标的信息。Dashboard 支持的图空间指标,参见[图空间](../7.monitor-parameter.md)。
**只有当图空间指标的行为被触发后,用户才能指定图空间查看对应的图空间指标的信息**。Dashboard 支持的图空间指标,参见[图空间](../7.monitor-parameter.md)。

![](https://docs-cdn.nebula-graph.com.cn/figures/space_level_metrics_cn.png)
![graph-metrics](https://docs-cdn.nebula-graph.com.cn/figures/space_level_metrics_cn.png)

## 可视化监控大屏

Expand Down
27 changes: 14 additions & 13 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,16 +16,6 @@

- 当节点上无服务时,可单击**删除节点**。

## 服务管理

- 在服务管理页面,用户可以选择服务类型、服务状态、Host 对展示的数据进行筛选,快速选中一个或多个服务,一键启动/停止/重启服务。

- 单击 ![nav](https://docs-cdn.nebula-graph.com.cn/figures/nav-dashboard_cn.png) 图标,可快速查看[服务监控](../4.cluster-operator/2.monitor.md)。

!!! danger

单击**停止**/**重启**,会立即中断进行中的任务,可能会导致数据不一致,请在业务低峰期执行该操作。

## 扩缩容

!!! enterpriseonly
Expand All @@ -37,15 +27,25 @@

!!! caution

目前仅支持对 graphd 和 storaged 进行扩缩容,不支持移除或添加 metad 服务。扩缩容集群时,建议提前备份数据,以便故障发生时回滚数据。关于扩缩容,详情参见[如何扩缩容](../../20.appendix/0.FAQ.md#_11)。
- 目前仅支持对 graphd 和 storaged 进行扩缩容,不支持移除或添加 metad 服务。扩缩容集群时,建议提前备份数据,以便故障发生时回滚数据。关于扩缩容,详情参见[如何扩缩容](../../20.appendix/0.FAQ.md#_11)。

- 集群中每种类型的服务至少要有一个,且单个节点上仅能部署一个同类型服务。

在该示例中,新增了节点为`192.168.8.143`和`192.168.8.167`的 Storage 服务,删除了节点为`192.168.8.169`的 Graph 服务。虚线框并置灰服务名表示移除的服务,实线框表示添加的服务。

在下方的**服务**中,绿色表示即将新增的服务,红色表示即将移除的服务。可以修改新增服务的端口号、HTTP 端口号、HTTP2 端口号信息。
在下方的**服务**中,绿色表示即将新增的服务,红色表示即将移除的服务。可以修改新增服务的端口号和 HTTP 端口号信息。

![扩缩容](https://docs-cdn.nebula-graph.com.cn/figures/scaling-ds-2022_4-14_cn.png)

## 服务管理

- 在服务管理页面,用户可以选择服务类型、服务状态、Host 对展示的数据进行筛选,快速选中一个或多个服务,一键启动/停止/重启服务。

![扩缩容](https://docs-cdn.nebula-graph.com.cn/figures/scaling-ds_cn.png)
- 单击 ![nav](https://docs-cdn.nebula-graph.com.cn/figures/nav-dashboard_cn.png) 图标,可快速查看[服务监控](../4.cluster-operator/2.monitor.md)。

!!! danger

单击**停止**/**重启**,会立即中断进行中的任务,可能会导致数据不一致,请在业务低峰期执行该操作。
## 更新配置

更新配置页面可以修改 Storage 及 Graph 服务的配置文件,具体参数及说明见 [Storage 服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md)和 [Graph 服务配置](../../5.configurations-and-logs/1.configurations/3.graph-config.md)。更新配置文件为批量操作,将会修改每一个 Storage/Graph 的配置文件。
Expand All @@ -63,6 +63,7 @@
所有角色为`admin`的账户和角色为`user`的集群创建者可以为集群添加管理员。默认集群创建者为集群的`owner`角色,并显示在**成员管理**页面。添加的集群管理员为集群的`operator`角色。

关于账户的角色详情,参见[权限管理](../5.account-management.md)。

### 添加集群管理员

集群管理员必需是用户创建的 Dashboard 企业版账户。关于如何创建账户,参见[权限管理](../5.account-management.md)。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,9 +2,9 @@

本文主要介绍 Dashboard 的其他设置。

在 Dashboard 顶部导航栏,单击**集群管理**,然后在左侧导航栏,单击**其他设置**进入其他设置页面。
在 Dashboard 顶部导航栏,单击**集群管理**,单击目标集群右侧**详情**,然后在左侧导航栏,单击**其他设置**进入其他设置页面。

- 集群信息:显示集群名称、创建时间、创建用户信息。
- 集群信息:显示集群名称、创建时间、创建用户信息、集群所有者名称

- 解除绑定:解除绑定后从平台移除该集群的信息,对集群的服务和 Nebula 数据不做任何操作。

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@
## 创建诊断


1. 选择诊断的时间范围。支持自定义诊断时间和通过时间区间设置集群诊断的范围,包括:`1 小时`、`6 小时`、`12 小时``1 天`、`3 天`、`7 天`、`14 天`。
1. 选择诊断的时间范围。支持自定义诊断时间和通过时间区间设置集群诊断的范围,包括:`1 小时`、`6 小时`、`12 小时``1 天`、`3 天`、`7 天`、`14 天`。

!!! caution

Expand Down Expand Up @@ -154,10 +154,10 @@
| ------------- | ------------------------------------------------------------ |
| `TOTAL` | 该项监控执行的总次数。 |
| `ERROR` | 发生错误的个数。 |
| `P75` | P75周期内响应耗时从小到大排列,顺序处于 75% 位置的分位数值。 |
| `P95` | P95周期内响应耗时从小到大排列,顺序处于 95% 位置的分位数值。 |
| `P99` | P99周期内响应耗时从小到大排列,顺序处于 99% 位置的分位数值。 |
| `P999` | P999周期内响应耗时从小到大排列,顺序处于 99.9% 位置的分位数值。 |
| `P75` | P75 周期内响应耗时从小到大排列,顺序处于 75% 位置的分位数值。 |
| `P95` | P95 周期内响应耗时从小到大排列,顺序处于 95% 位置的分位数值。 |
| `P99` | P99 周期内响应耗时从小到大排列,顺序处于 99% 位置的分位数值。 |
| `P999` | P999 周期内响应耗时从小到大排列,顺序处于 99.9% 位置的分位数值。 |

### 配置信息

Expand Down
5 changes: 3 additions & 2 deletions docs-2.0/nebula-dashboard-ent/8.faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -34,7 +34,6 @@ Meta 服务主要存储 Nebula Graph 数据库中的元数据。一旦 Meta 服
- 缩容 Storage,Dashboard 会自动执行`Balance Data Remove`语句,确保被指定的服务上的数据分片迁移完成后,停止服务。
- 扩缩容 Graph 对数据不会有影响。


## 为什么无法启动 Dashboard(企业版)?

- 确保 License 已拷贝至 Dashboard 目录中,且执行了`sudo ./dashboard.service start all`命令。
Expand All @@ -46,9 +45,11 @@ Meta 服务主要存储 Nebula Graph 数据库中的元数据。一旦 Meta 服

Dashboard 支持手动添加安装包,可以点击[如何获取 Nebula Graph](https://nebula-graph.com.cn/download/) 下载所需系统和版本的 RPM 包或 DEB 包,添加到`nebula-dashboard-ent/download/nebula-graph`路径下。在创建、扩容集群时,可选择添加的包进行部署。

<!-- 集群操作中已提供sudo操作选项,用户可以直接在导入集群的时候选择是否执行sudo.

## 为什么导入集群时,提示“权限不足”?

导入集群的时候,需要访问服务安装的路径。如果操作服务的账号没有访问权限的话,无法成功导入集群。用户可授予操作账号访问服务的权限(例如`sudo chown -R tom:tom nebula`),然后使用操作账号重启服务。
导入集群的时候,需要访问服务安装的路径。如果操作服务的账号没有访问权限的话,无法成功导入集群。用户可授予操作账号访问服务的权限(例如`sudo chown -R tom:tom nebula`),然后使用操作账号重启服务。 -->

## 为什么导入集群时,提示 “ssh 连接失败”?

Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@

| Nebula Graph 版本 | Explorer 版本 |
| --- | --- |
| 3.x | 3.0.0 |
| 3.0.0 ~ 3.1.x | 3.0.0 |
| 2.5.x ~ 3.0.0| 2.2.0|
| 2.6.x | 2.1.0 |
| 2.5.x | 2.0.0 |
Expand Down