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

modify dashboard ent #1175

Merged
merged 7 commits into from
Nov 9, 2021
Merged
Show file tree
Hide file tree
Changes from 5 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
9 changes: 5 additions & 4 deletions docs-2.0/nebula-dashboard-en/1.what-is-dashboard-en.md
Original file line number Diff line number Diff line change
@@ -1,14 +1,14 @@
# 什么是Nebula Dashboard(企业版)

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

## 产品功能

- 创建指定版本的Nebula Graph集群,支持批量导入节点、一键添加服务等功能。
- 支持集群导入,集群balance leader、balance data。
- 支持可视化页面快速进行扩缩容操作。
- 支持快速修改指定集群中Storage及Graph服务的配置并重启服务。
- 支持在可视化界面进行集群导入、数据平衡、扩容缩容等操作。
- 支持管理多集群并可以查看最近14天內集群的操作记录。
- 支持在可视化页面进行服务启动、停止、重启操作。
- 支持快速更新集群中Storage及Graph服务的配置。
- 监控集群中所有服务的信息,包括服务IP地址、版本和监控指标(例如查询数量、查询延迟、心跳延迟等)。
- 监控集群中所有机器的状态,包括CPU、内存、负载、磁盘和流量。
- 监控集群本身的信息,包括集群的服务信息、分区信息、配置和长时任务。
Expand All @@ -25,6 +25,7 @@ Nebula Dashboard(简称Dashboard)是一款用于监控和管理Nebula Graph
- 监控数据默认更新频率约为7秒。
- 监控数据默认保留14天,即只能查询最近14天内的监控数据。
- 只支持2.0.1及以上版本的Nebula Graph。
- 建议使用最新版本的Chrome访问Dashboard。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

!!! note

Expand Down
15 changes: 8 additions & 7 deletions docs-2.0/nebula-dashboard-en/2.deploy-connect-dashboard-en.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,7 +8,7 @@ Dashboard版本和Nebula Graph的版本对应关系如下。

|Dashboard版本|Nebula Graph版本|
|:---|:---|
|{{ dashboard_ent.release }}|2.x|
|{{ dashboard-en.release }}|2.x|
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

## tar 包部署
### 前提条件
Expand All @@ -22,10 +22,15 @@ Dashboard版本和Nebula Graph的版本对应关系如下。
| ---- | ---- |
| 7005 | Dashboard提供web服务的端口。 |
| 8090 | nebula-http-gateway提供HTTP服务的端口。 |
| 9100 | node-exporter服务的端口。 |
| 9090 | prometheus服务的端口。 |
| 9200 | nebula-stats-exporter服务的端口。 |

- 准备License。License仅在企业版提供,请发送邮件至inquiry@vesoft.com获取。
- 准备License。

!!! enterpriseonly

License仅在企业版提供,请发送邮件至inquiry@vesoft.com。


### 安装及启动

Expand Down Expand Up @@ -76,10 +81,6 @@ Dashboard版本和Nebula Graph的版本对应关系如下。
$ cp -r nebula.license /usr/local/nebula-dashboard
```

!!! enterpriseonly

License仅在企业版提供,请发送邮件至inquiry@vesoft.com。

5. 启动Dashboard。

```bash
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -10,7 +10,7 @@
2. 在创建集群页面,完成以下配置:
- 输入 **集群名称**,最大可输入15个字符,本示例设置为`test_foesa`。
- 选择Nebula Graph安装版本,本示例设置为`v2.6.1`。
- 添加节点或者批量导入节点,如果是多节点的集群,需要添加每个节点的相关信息。
- **添加节点**,如果是多节点的集群,需要添加每个节点的相关信息。

1. 配置每个Host的IP信息,本示例设置为`192.168.8.144`。
2. 配置 SSH 信息,本示例设置如下:SSH端口号为`22`,SSH用户名为 `vesoft`,SSH 密码为`nebula`。
Expand All @@ -19,21 +19,24 @@

![cluster](../figs/ds-021.png)

- **批量导入节点**,需要添加每个节点的相关信息。批量导入需要先选择安装包后点击**下载CSV模版**。按照模版填写后上传,尽量确保节点信息正确,否则容易造成上传失败。

![batch-import](../figs/ds-030.png)

3. 勾选节点并在节点右上方,点击需要添加的服务。创建集群需要给节点添加3种类型的服务,如果不熟悉Nebula Graph架构,建议点击 **自动添加服务** 按钮。

![add-service](../figs/ds-029.png)

4. (可选)在下方的服务中,选择编辑meta、graph、storage服务的端口号、HTTP端口号、HTTP2端口号,点击确认保存。

![install](../figs/ds-021.png)

5. 点击**创建集群**,确定配置信息无误且节点无冲突后,点击**确认**。

![check](../figs/ds-023.png)

6. 在集群管理页面中的列表中出现状态为`installing`的集群,需等待3-10分钟,状态变为`healthy`即集群创建成功。如果服务状态为`unhealthy`,表示集群服务中存在非正常运行的服务,请点击详情进行查看。

![installing](../figs/ds-024.png)

## 后续操作

成功创建集群后,用户可以对集群进行操作,详情见[总览](../4.cluster-operator/1.overview.md)。
成功创建集群后,用户可以对集群进行操作,详情见[总览](../4.cluster-operator/1.overview.md)。
Original file line number Diff line number Diff line change
Expand Up @@ -11,25 +11,25 @@
1. 在集群列表页面,点击 **导入集群** 标签。
2. 在导入集群页面,输入连接Nebula Graph的信息:
- Graphd Host:<其中一个Graphd进程的虚机IP>:<端口号>。本示例设置为 `192.168.8.157:9669`。
- 用户名:连接Nebula Graph的账号。
- 密码:连接Nebula Graph的密码。
- 用户名:连接Nebula Graph的账号,本示例设置为`vesoft`
- 密码:连接Nebula Graph的密码,本示例设置为`nebula`

!!! note

因为 Nebula Graph 默认不启用身份验证,所以,一般情况下用户可以使用 `root` 账号和任意密码连接 Nebula。
当 Nebula Graph 启用了身份验证后,用户只能使用指定的账号和密码连接 Nebula。关于 Nebula Graph 的身份验证功能,参考 [Nebula Graph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往 Nebula Graph 官网")。

3. 输入 **用户名** 及 **密码**,本示例设置为`vesoft`和`nebula`。


![connect](../figs/ds-025.png)

4. 在连接服务节点页面完成以下配置:
3. 在连接服务节点页面完成以下配置:
- 输入集群的名称,最大可输入15个字符,本示例设置为`create_1027`。
![connect](../figs/ds-026.png)
- 对节点进行 **授权** 或 **批量授权** 。授权需输入每个节点的 SSH 用户名及密码;批量授权需要上传CSV文件。请根据下载的CSV文件,编辑每个节点授权信息,尽量确保节点信息正确,否则容易造成上传失败。页面中节点状变为 **已授权**,则该节点授权成功。
- 对节点进行 **授权**,授权需输入每个节点的 SSH 用户名及密码。
- **批量授权**需要上传CSV文件。请根据下载的CSV文件,编辑每个节点授权信息,尽量确保节点信息正确,否则容易造成上传失败。
![批量授权](../figs/ds-026.png)
- 页面中节点状变为 **已授权**,则该节点授权成功。
![授权](../figs/ds-027.png)

5. 确保所有节点都授权成功,点击 **导入集群**。
4. 确保所有节点都授权成功,点击 **导入集群**。

## 后续操作

Expand Down
14 changes: 10 additions & 4 deletions docs-2.0/nebula-dashboard-en/4.cluster-operator/1.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -16,7 +16,7 @@ Dashboard 的集群总览页面分为五个部分:

### 集群概况

在集群概况中,显示了节点数量,Graphd、Storaged、Metad正在运行服务及异常服务数量。在本示例中,Storaged存在异常服务为 **1**,可以点击 **查看** 按钮,快速查看异常服务。
在集群概况中,显示了节点数量,Graphd、Storaged、Metad正在运行服务及异常服务数量。在本示例中,Graphd存在异常服务为 **1**,可以点击 **查看** 按钮,快速查看异常服务。

### 集群信息

Expand All @@ -28,16 +28,22 @@ Dashboard 的集群总览页面分为五个部分:

!!! caution

如果用户导入的Nebula Graph版本低于2.5或版本未知的情况下,默认显示为v2.0.1。
如果用户导入的Nebula Graph版本低于v2.5.0或版本未知的情况下,默认显示为v2.0.1。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

### 节点监控

支持快速查看节点监控信息,如cpu、memory等信息,支持在页面上点击![setup](../figs/Setup.png)插入基准线。并且用户也可以点击![watch](../figs/watch.png)快速跳转至节点监控页面,查看详情信息。
- 支持快速查看节点监控信息,可点击切换展示的信息,默认显示cpu信息。
- 支持在页面上点击![setup](../figs/Setup.png)插入基准线。
- 点击![watch](../figs/watch.png)快速跳转至节点监控页面,查看详情信息。

### 状态列表

用饼图的方式形象的展示节点运行服务状态。

### 服务监控

默认显示`query_latency_us`(查询平均延迟)和`slow_query_latency_us`(慢查询平均延迟)的信息,支持在页面上点击![setup](../figs/Setup.png)设置插入基准线。并且用户也可以点击![watch](../figs/watch.png)快速跳转至服务监控页面,查看详情信息。
- 默认显示`query_latency_us`(查询平均延迟)和`slow_query_latency_us`(慢查询平均延迟)的信息。

- 点击![setup](../figs/Setup.png)**设置** 插入基准线。

- 点击![watch](../figs/watch.png)快速跳转至服务监控页面,查看详情信息。
Original file line number Diff line number Diff line change
@@ -1,18 +1,21 @@
# 集群信息

本文主要介绍 Dashboard 的集群信息,主要为以下六个部分:

- 版本
- Leader
- Partition
- 服务信息
- 分片信息
- 长时任务

在查看集群信息之前,用户需要选择Host信息,输入登录Nebula Graph的账号(非Dashboard登录账号)和对应密码。多机部署时,用户可以任意选择一台虚机的HOST信息。
在查看集群信息之前,用户需要选择Host信息,输入登录Nebula Graph的账号(非Dashboard登录账号)和对应密码。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

多机部署时,用户可以任意选择一台虚机的HOST信息。

!!! caution

Nebula Graph 服务已经部署并启动。详细信息,参考[Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。
用户需要保证Nebula Graph服务已经部署并启动。详细信息,参考[Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。

![information](../figs/ds-006.png)

Expand Down
29 changes: 13 additions & 16 deletions docs-2.0/nebula-dashboard-en/4.cluster-operator/4.manage.md
Original file line number Diff line number Diff line change
@@ -1,15 +1,14 @@
# 集群操作

本文主要介绍 Dashboard 的集群操作,主要为以下四个部分:

- 节点管理
- 服务管理
- 扩缩容
- 更新配置

## 节点管理

![vertex manage](../figs/ds-008.png)

在节点管理页面中,展示所有的节点详情信息,包括节点名称、Host及SSH用户名称、CPU核等信息。

- 点击 **添加节点** 输入Host信息、SSH端口号、用户、密码信息,选择Nebula Graph安装包,可快速添加节点。
Expand All @@ -22,40 +21,36 @@

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

![vertex manage](../figs/ds-008.png)
## 服务管理

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

在服务管理页面,用户可以选择服务类型、服务状态、Host对展示的数据进行筛选,快速选中一个或多个服务,一键启动/停止/重启服务
- 点击 ![nav](../figs/nav-dashboard.png)图标,可快速查看 [服务监控](../4.cluster-operator/2.monitor.md)

!!! danger

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

点击 ![nav](../figs/nav-dashboard.png)图标,可快速查看 [服务监控](../4.cluster-operator/2.monitor.md)。
![服务管理](../figs/ds-015.png)

## 扩缩容

![扩缩容](../figs/ds-016.png)

在扩缩容页面,用户可以快速**添加节点**、**批量导入节点**,并对已存在的节点添加 **Graph服务** 及 **Storage服务**。点击 **重置** 按钮,可以恢复到初始状态。
- 在扩缩容页面,用户可以快速**添加节点**、**批量导入节点**,并对已存在的节点添加 **Graph服务** 及 **Storage服务**。
- 点击 **重置** 按钮,可以恢复到初始状态。

!!! caution

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

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

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

!!! caution

扩缩容集群时,建议提前备份数据,以便故障发生时回滚数据。关于扩缩容,详情参见[如何扩缩容](../../20.appendix/0.FAQ.md#_11)。
![扩缩容](../figs/ds-016.png)

## 更新配置

![更新配置](../figs/ds-017.png)

更新配置页面可以修改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 @@ -64,4 +59,6 @@

!!! danger

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

![更新配置](../figs/ds-017.png)
4 changes: 2 additions & 2 deletions docs-2.0/nebula-dashboard-en/4.cluster-operator/6.settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -8,14 +8,14 @@

!!! note

在执行该操作时,你需要输入集群名称确定解除绑定
在执行该操作时,用户需要输入集群名称确定解除绑定

![解除绑定](../figs/ds-019.png)

- 删除集群:删除集群会停止集群服务同时保留Nebula数据,并解除与平台的信息绑定,请谨慎操作。

!!! note

在执行该操作时,你需要输入集群名称确定删除集群
在执行该操作时,用户需要输入集群名称确定删除集群

![删除集群](../figs/ds-020.png)
8 changes: 6 additions & 2 deletions docs-2.0/nebula-dashboard-en/5.account-management.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,9 @@
# 权限管理

用户使用默认GOD用户(默认账号为`nebula`,密码为`nebula`)登录,可在权限管理页面,创建或删除 ADMIN 账号
用户使用默认GOD用户(默认账号为`nebula`,密码为`nebula`)登录,可在权限管理页面,创建或删除ADMIN权限的账号。下图为GOD用户的权限管理页面

用户使用创建的 ADMIN 账号不能对其他的账号进行操作,仅能查看用户名、角色、创建时间。
![god](../nebula-dashboard-en/figs/ds-032.png)

用户使用创建的ADMIN账号登陆,不能对其他的账号进行操作,仅能查看用户名、角色、创建时间。下图为ADMIN用户的权限管理页面。

![admin](../nebula-dashboard-en/figs/ds-031.png))
9 changes: 8 additions & 1 deletion docs-2.0/nebula-dashboard-en/6.system-settings.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,14 +5,21 @@
## 平台设置

在标签栏中点击**平台设置**,用户可以完成以下修改:

- 修改标题、Logo图片、封面图。
- 快速修改语言,目前仅支持中文和英文。
- 开关帮助提示。

![settings](../nebula-dashboard-en/figs/ds-033.png)

## 帮助信息

点击帮助信息,可快速跳转至 Dashboard 文档页面、Nebula Graph文档、官网或论坛等页面。

![help](../nebula-dashboard-en/figs/ds-034.png)

## 用户信息

点击右上角 **个人信息** 可修改密码或登出账号。
点击右上角 **个人信息** 可修改密码或登出账号。

![information](../nebula-dashboard-en/figs/ds-035.png)
1 change: 0 additions & 1 deletion docs-2.0/nebula-dashboard-en/7.monitor-parameter.md
Original file line number Diff line number Diff line change
Expand Up @@ -101,5 +101,4 @@
|`add_vertices_latency_us`| 添加点的平均延迟|
|`delete_edges_latency_us`| 删除边的平均延迟|
|`delete_vertices_latency_us`| 删除点的平均延迟|
|`forward_tranx_latency_us`| 传输平均延迟|
|`get_neighbors_latency_us`| 查询邻居平均延迟|
17 changes: 13 additions & 4 deletions docs-2.0/nebula-dashboard-en/8.faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,9 +4,11 @@

## 什么是集群、节点和服务?

集群: Dashboard集群特指由多个Nebula Graph服务所在的节点组成的一组系统;
节点: 特指承载运行Nebula Graph服务的物理或虚拟机;
服务: 特指Nebula服务,包括Metad,Storaged和Graphd。
- 集群:Dashboard集群特指由多个Nebula Graph服务所在的节点组成的一组系统。

- 节点:特指承载运行Nebula Graph服务的物理或虚拟机。

- 服务:特指Nebula服务,包括Metad,Storaged和Graphd。

## 什么是集群的状态?

Expand All @@ -32,4 +34,11 @@ Meta服务主要存储Nebula-Graph数据库中的元数据。一旦Meta服务出

- 扩容Storage, Dashboard会在指定的机器上拉起Storage服务,对已有数据不会造成影响,可以在集群信息页根据自身需求选择进行balance data或者balance leader操作。
- 缩容Storage, Dashboard会自动执行balance data remove 语句,确保被指定的服务上的数据分片迁移完成后,停止服务。
- 扩缩容Graph对数据不会有影响。
- 扩缩容Graph对数据不会有影响。

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

- 确保License已拷贝至Dashboard目录中,且执行了`bash ./scripts/start.sh`命令。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved
- 确保License未过期。
foesa-yang marked this conversation as resolved.
Show resolved Hide resolved

如果满足以上条件,仍无法启动Dashboard,请前往 [Nebula Graph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 Nebula Graph 官方论坛") 咨询。
Binary file modified docs-2.0/nebula-dashboard-en/figs/ds-001.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 docs-2.0/nebula-dashboard-en/figs/ds-008.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 docs-2.0/nebula-dashboard-en/figs/ds-015.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 docs-2.0/nebula-dashboard-en/figs/ds-016.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 added docs-2.0/nebula-dashboard-en/figs/ds-030.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 added docs-2.0/nebula-dashboard-en/figs/ds-031.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 added docs-2.0/nebula-dashboard-en/figs/ds-032.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 added docs-2.0/nebula-dashboard-en/figs/ds-033.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 added docs-2.0/nebula-dashboard-en/figs/ds-034.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 added docs-2.0/nebula-dashboard-en/figs/ds-035.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.