Skip to content

Commit

Permalink
update-1104
Browse files Browse the repository at this point in the history
  • Loading branch information
foesa-yang committed Nov 4, 2021
1 parent 1fcc242 commit 586b83b
Show file tree
Hide file tree
Showing 14 changed files with 60 additions and 29 deletions.
7 changes: 4 additions & 3 deletions docs-2.0/nebula-dashboard-en/1.what-is-dashboard-en.md
Original file line number Diff line number Diff line change
@@ -1,11 +1,12 @@
# 什么是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集群,支持批量导入节点、一键添加服务等功能。
- 轻松修改当前集群中的 Storage 及 Garph 服务的配置并重启服务。
- 轻松修改当前集群中Storage及Garph服务的配置并重启服务。
- 快速进行扩缩容操作并修改服务端口号。
- 监控集群中所有服务的信息,包括服务IP地址、版本和监控指标(例如查询数量、查询延迟、心跳延迟等)。
- 监控集群中所有机器的状态,包括CPU、内存、负载、磁盘和流量。
- 监控集群本身的信息,包括集群的服务信息、分区信息、配置和长时任务。
Expand All @@ -21,7 +22,7 @@ Nebula Dashboard(简称Dashboard)是一款用于监控Nebula Graph集群中
- 监控数据默认更新频率约为7秒。
- 监控数据默认保留14天,即只能查询最近14天内的监控数据。
- 只查看指定集群的监控信息。
- 只支持 2.0.1 及以上版本的 Nebula Graph。
- 只支持 2.0.1 及以上版本的Nebula Graph。

!!! note

Expand Down
6 changes: 3 additions & 3 deletions docs-2.0/nebula-dashboard-en/2.deploy-connect-dashboard-en.md
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 部署Dashboard

安装部署 Dashboard 涉及5种服务,本文将详细介绍如何通过 RPM 包安装部署。
安装部署Dashboard涉及5种服务,本文将详细介绍如何通过 RPM 包安装部署。

## Nebula Graph版本

Expand All @@ -13,9 +13,9 @@ Dashboard 版本和 Nebula Graph 的版本对应关系如下。
## RPM 部署
### 前提条件

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

- 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 安装部署")

- 确保以下端口未被使用:
- 9200
Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 创建集群

本文介绍如何通过 Dashboard 创建集群
本文介绍如何通过Dashboard创建集群

## 操作步骤

Expand All @@ -9,19 +9,19 @@
1. 在集群列表页面,点击 **创建集群** 标签。
2. 在创建集群页面,完成以下配置:
- 输入 **集群名称**,最大可输入15个字符,本示例设置为`test_foesa`
- 选择 Nebula Graph 安装版本,本示例设置为 `v2.6.0`
- 选择Nebula Graph安装版本,本示例设置为`v2.6.0`
- 添加节点或者批量导入节点。

1. 配置每个节点的 Host 信息,本示例设置为 `192.168.8.144`
2. 配置 SSH 信息,本示例设置如下:SSH 端口号为`22`SSH 用户名为 `vesoft`,SSH 密码为`nebula`
1. 配置每个节点的Host信息,本示例设置为`192.168.8.144`
2. 配置 SSH 信息,本示例设置如下:SSH端口号为`22`SSH用户名为 `vesoft`,SSH 密码为`nebula`
3. 选择 Nebula Graph 安装包,本示例为`nebula-graph-2.6.0.el7.x86_64rpm`
4. (可选)输入节点名。本示例设置为`Noed_1`

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

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

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

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

Expand Down
Original file line number Diff line number Diff line change
@@ -1,15 +1,21 @@
# 导入集群

本文介绍如何通过 Dashboard 导入集群,暂不支持导入使用 Docker 和 Kubernetes 方式部署的集群
本文介绍如何通过Dashboard导入集群,暂不支持导入使用Docker和Kubernetes方式部署的集群

## 操作步骤

1. 在集群列表页面,点击 **导入集群** 标签。
2. 在导入集群页面输入 **Graphd Host**,本示例设置为 `192.168.8.157:9669`
3. 输入 **用户名****密码**,本示例设置为`vesoft``nebula`

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

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

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

## 后续操作
Expand Down
4 changes: 2 additions & 2 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 @@ -24,15 +24,15 @@ Dashboard 的集群总览页面分为五个部分:

!!! note

这里的版本信息为用户安装的 Nebula Graph 版本,而非 Dashboard 版本
这里的版本信息为用户安装的Nebula Graph版本,而非Dashboard版本

!!! caution

如果用户导入的 Nebula Graph 版本低于2.5,默认显示为v2.0.1。

### 节点监控

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

### 状态列表

Expand Down
4 changes: 2 additions & 2 deletions docs-2.0/nebula-dashboard-en/4.cluster-operator/2.monitor.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

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

快速查看 CPU、Memory、Load、Disk 和 Network In/Out 变化情况
快速查看CPU、Memory、Load、Disk和Network In/Out变化情况

- 如果需要设置基线,作为参考标准线,可以单击模块右上角的![setup](../figs/Setup.png)按钮。
- 如果需要查看某一项更详细的监控指标,可以单击模块右上角的![watch](../figs/watch.png)按钮,在示例中选择`Load`查看详情信息,如下图。
Expand All @@ -19,7 +19,7 @@

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

快速查看 Graph、Meta、Storage 服务的信息,右上角显示正常服务和异常服务的数量。
快速查看Graph、Meta、Storage服务的信息,右上角显示正常服务和异常服务的数量。

!!! note

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -20,19 +20,19 @@

![版本](../figs/ds-014.png)

显示所有服务及对应的 Nebula 版本
显示所有服务及对应的Nebula版本

## Leader

![Leader](../figs/ds-013.png)

显示 Leader 数量及 Leader 的分布,点击右上角的 **Balance Leader** 按钮可以快速在 Nebula Graph 集群中均衡分布 Leader。
显示Leader数量及Leader的分布,点击右上角的 **Balance Leader** 按钮可以快速在Nebula Graph集群中均衡分布 Leader。

## Partition

![partition](../figs/ds-012.png)

选择指定图空间,查看指定图空间的 Partition 分布情况
选择指定图空间,查看指定图空间的Partition分布情况

## 服务信息

Expand Down
14 changes: 7 additions & 7 deletions docs-2.0/nebula-dashboard-en/4.cluster-operator/4.manage.md
Original file line number Diff line number Diff line change
Expand Up @@ -12,35 +12,35 @@

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

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

- 点击 ![plus](../figs/Plus.png) 按钮,查看对应节点服务名、服务类型、服务状态、运行路径等信息。

- 点击 **节点监控** 可快速跳转至节点监控页面,详情信息见 [集群监控](../4.cluster-operator/2.monitor.md)

- 点击 **编辑节点** 可修改 SSH端口号、用户名、密码。
- 点击 **编辑节点** 可修改SSH端口号、用户名、密码。

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

## 服务管理

![服务管理](../figs/ds-015.png)

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

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

## 扩缩容

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

在扩缩容页面,用户可以快速**添加节点****批量导入节点**,并对已存在的节点添加 **Graph 服务****Storage 服务**
在扩缩容页面,用户可以快速**添加节点****批量导入节点**,并对已存在的节点添加 **Graph服务****Storage服务**

!!! caution

目前仅支持对 graphd 和 storaged 进行扩缩容,不支持移除或添加 metad 服务
目前仅支持对graphd和storaged进行扩缩容,不支持移除或添加metad服务

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

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

Expand All @@ -52,6 +52,6 @@

![更新配置](../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服务的配置文件,具体参数及描述见 [Storage服务配置](../../5.configurations-and-logs/1.configurations/4.storage-config.md)[Graph服务配置](../../5.configurations-and-logs/1.configurations/3.graph-config.md)

点击保存后,在下一次服务重启后配置即生效。点击 **保存并重启** 可直接重启服务使配置立即生效。
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 操作记录

本文主要介绍 Dashboard 的操作记录
本文主要介绍Dashboard的操作记录

![操作记录](../figs/ds-018.png)

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 其他设置

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

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

Expand Down
24 changes: 24 additions & 0 deletions docs-2.0/nebula-dashboard-en/8.faq.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,24 @@
# 常见问题FAQ

本文列出了使用Dashboard时可能遇到的常见问题,用户可以使用文档中心或者浏览器的搜索功能查找相应问题。

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



## 什么是集群的状态?

集群的状态有以下几种:

- installing:集群正在创建中,过程大约需要等待3~10分钟。
- healthy:集群中所有服务正常运行。
- unhealthy:集群中存在服务为异常状态。

## 为什么要授权节点?

## 什么是扩缩容?

## 为什么不能操作Metad?

## 扩缩容之后对数据有什么影响?

Binary file added docs-2.0/nebula-dashboard-en/figs/ds-025.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-026.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-027.png
Loading
Sorry, something went wrong. Reload?
Sorry, we cannot display this file.
Sorry, this file is invalid so it cannot be displayed.

0 comments on commit 586b83b

Please sign in to comment.