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

Dashboard ent 1.1.0 new feature #1326

Merged
merged 16 commits into from
Jan 12, 2022
25 changes: 25 additions & 0 deletions docs-2.0/nebula-dashboard-ent/10.tasks.md
Original file line number Diff line number Diff line change
@@ -0,0 +1,25 @@
# 任务中心

Nebula Dashboard 企业版的任务中心功能展示正在进行的操作的进度及历史操作,用户可感知任务的运行状态及查看历史操作信息。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

用户对集群的操作在任务中心中被定义为任务。目前任务中心支持的任务类型包括集群创建和集群扩缩容。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

在 Nebula Dashboard 企业版顶部导航栏中,单击**任务中心**可查看相关任务信息。

## 运行中的任务

在**任务中心**页面中,单击**运行中任务**后,用户可看到创建中或扩缩容中的集群的进度。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

- 单击任务名称可查看正在进行中的任务的 ID、节点名称、操作类型、任务触发时间、操作人。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
- 单击**任务信息**查看任务详情。

## 历史任务

在**任务中心**页面的**历史任务**页签中,显示所有结束的任务。

- 用户可通过任务状态、类型、触发时间筛序历史任务。
- 在目标历史任务右侧,单击**任务信息**查看历史任务的详情;单击**任务日志**查看任务执行日志。

## 删除任务

目前不可取消正在进行中的任务,也不可删除历史任务。
14 changes: 9 additions & 5 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
Original file line number Diff line number Diff line change
Expand Up @@ -56,7 +56,7 @@
dialect: mysql # 使用的数据库类型,目前仅支持 MySql
host: 192.168.8.157 # 连接的 MySql 数据库的 ip 地址
port: 3306 # 连接的 MySql 数据库的端口号
username: root # 登陆 MySql 的账号
username: root # 登陆 MySql 的账户
password: nebula # 登陆 MySql 的密码
name: dashboard # 对应的数据库名称
autoMigrate: true # 自动创建数据库表,默认为 true
Expand Down Expand Up @@ -134,10 +134,14 @@ $ sudo /dashboard/scripts/dashboard.service stop all #停止 Dashboard 所有服
$ sudo /dashboard/scripts/dashboard.service status all #查看 Dashboard 所有服务状态
```

## 后续操作
## 连接 Dashboard

启动成功后,在浏览器地址栏输入`http://<ip_address>:7005`。
成功启动 Dashboard 后,在浏览器地址栏输入`http://<ip_address>:7005`。

如在浏览器窗口中看到以下登录界面,则表示已经成功部署并启动了 Dashboard。

![dashboard-login-cn](../nebula-dashboard-ent/figs/dashboard-login-cn.png)

用户可以使用初始化用户名`nebula`和密码`nebula`登录 Dashboard。登录 Dashboard 后可创建 LDAP 账户和普通账户,然后使用不同的账户登录 Dashboard。关于账户的详情,参见[权限管理](../nebula-dashboard-ent/5.account-management.md)。

在浏览器窗口中看到以下登录界面表示已经成功部署并启动了 Dashboard,用户可以通过默认用户名`nebula`和密码`nebula`登陆 Dashboard 的 GOD 用户。可以在[系统设置](../nebula-dashboard-ent/6.system-settings.md)中修改密码,也可以在[权限管理](../nebula-dashboard-ent/5.account-management.md)页面创建权限为 ADMIN 的账号用来登陆 Dashboard。

![start-page](../nebula-dashboard-ent/figs/ds-028.png)
Original file line number Diff line number Diff line change
Expand Up @@ -6,7 +6,7 @@

按以下方式创建集群:

1. 在集群管理页面,点击 **创建集群** 标签。
1. 在集群管理页面,单击 **创建集群** 标签。
2. 在创建集群页面,完成以下配置:
- 输入 **集群名称**,最大可输入 15 个字符,本示例设置为`test_foesa`。
- 选择 Nebula Graph 安装版本,本示例设置为`v2.6.1`。
Expand All @@ -19,21 +19,18 @@

![cluster](../figs/ds-021.png)
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

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

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

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

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

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

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

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

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

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

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

具体步骤,参见[配置管理](../../5.configurations-and-logs/1.configurations/1.configurations.md)和[管理服务](../../4.deployment-and-installation/manage-service.md)。

2. 在集群管理页面,点击 **导入集群** 标签。
2. 在集群管理页面,单击**导入集群** 标签。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
3. 在导入集群页面,输入连接 Nebula Graph 的信息:
- Graphd Host:<其中一个 Graphd 进程的虚机 IP>:<端口号>。本示例设置为 `192.168.8.157:9669`。
- 用户名:连接 Nebula Graph 的账号,本示例设置为`vesoft`。
Expand All @@ -22,22 +22,19 @@
!!! note

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

![connect](../figs/ds-025.png)
当 Nebula Graph 启用了身份验证后,用户只能使用指定的账号和密码连接 Nebula。关于 Nebula Graph 的身份验证功能,参考 [Nebula Graph 用户手册](../../7.data-security/1.authentication/1.authentication.md "单击前往 Nebula Graph 官网")。

3. 在连接服务节点页面完成以下配置:

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

![批量授权](../figs/ds-026.png)

- 页面中节点状态变为 **已授权**,则该节点授权成功。
- 页面中节点状态变为**已授权**,则该节点授权成功。

![授权](../figs/ds-027.png)

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

## 后续操作

Expand Down
21 changes: 12 additions & 9 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/1.overview.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,23 +4,26 @@

## 概览

![overview](../figs/ds-001.png)

Dashboard 的集群总览页面分为五个部分:

- 集群概况
- 告警
- 集群信息
- 节点监控
- 状态列表
- 服务监控

### 集群概况

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

### 告警

在**告警**区域,系统按照告警消息的严重级别(`emergency`>`critical`>`warning`)展示最近触发的 5 条告警消息。有关告警消息的设置,参见[监控告警](../9.alerts.md)。

### 集群信息

在集群信息中,显示了 **集群名称**、**创建时间**、**创建用户**、**版本** 的信息。
在集群信息中,显示了**集群名称**、**创建时间**、**创建用户**、**版本**的信息。

!!! note

Expand All @@ -32,9 +35,9 @@ Dashboard 的集群总览页面分为五个部分:

### 节点监控

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

### 状态列表

Expand All @@ -44,6 +47,6 @@ Dashboard 的集群总览页面分为五个部分:

- 默认显示`query_latency_us`(查询平均延迟)和`slow_query_latency_us`(慢查询平均延迟)的信息。

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

- 点击![watch](../figs/watch.png) 快速跳转至服务监控页面,查看详情信息。
- 单击![watch](../figs/watch.png) 快速跳转至服务监控页面,查看详情信息。
8 changes: 4 additions & 4 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 @@ -4,9 +4,9 @@

## 节点监控

![vertex](../figs/ds-002.png)
在 Dashboard 顶部导航栏,单击**集群管理**,然后单击**集群监控**->**节点监控**进入节点监控页面。

快速查看 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 @@ -17,9 +17,9 @@

## 服务监控

![service](../figs/ds-004.png)
在 Dashboard 顶部导航栏,单击**集群管理**,然后单击**集群监控**->**服务监控**进入服务监控页面。

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

!!! note

Expand Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,8 @@
# 集群信息

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

在 Dashboard 顶部导航栏,单击**集群管理**,然后在左侧导航栏,单击**集群信息**,看到以下六个部分:
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

- 版本
- Leader
Expand All @@ -9,6 +11,7 @@
- 分片信息
- 长时任务


在查看集群信息之前,用户需要选择任意一个在线的 Graph 服务地址,输入登录 Nebula Graph 的账号(非 Dashboard 登录账号)和对应密码。

多机部署时,用户可以选择任意一个在线的 Graph 服务地址。
Expand All @@ -17,30 +20,18 @@

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

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

## 版本

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

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

## Leader

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

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

## Partition

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

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

## 服务信息

![服务信息](../figs/ds-011.png)

展示 Storage 服务的基本信息。用户可以通过右上角的 **Balance Date** 按钮启动任务,均衡分布集群中的所有分片。参数说明如下:

| 参数 | 说明 |
Expand All @@ -55,8 +46,6 @@

## 分片信息

![分片信息](../figs/ds-010.png)

显示分片信息。用户需要在左上角选择图空间,查看分片信息。也可以通过右上角的输入框,输入分片 ID,筛选展示的数据。参数说明如下:

|参数|说明|
Expand All @@ -68,8 +57,6 @@

## 长时任务

![长时任务](../figs/ds-009.png)

展示所有作业的信息。查看作业信息之前,用户需要在右上角选择图空间。暂不支持在线管理作业,详情请参见[作业管理](../../3.ngql-guide/18.operation-and-maintenance-statements/4.job-statements.md)。参数说明如下:

| 参数 | 说明 |
Expand Down
58 changes: 36 additions & 22 deletions docs-2.0/nebula-dashboard-ent/4.cluster-operator/4.manage.md
Original file line number Diff line number Diff line change
@@ -1,43 +1,35 @@
# 集群操作

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

- 节点管理
- 服务管理
- 扩缩容
- 更新配置
本文主要介绍 Dashboard 企业版的集群操作,包括集群节点、集群服务、集群扩缩容、服务配置、集群成员管理。

## 节点管理

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

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

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

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

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

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

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

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

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

!!! danger

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

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

## 扩缩容

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

!!! caution

Expand All @@ -47,18 +39,40 @@

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

![扩缩容](../figs/ds-016.png)
![扩缩容](../figs/scaling-ds.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 及 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 的配置文件。

- 点击保存后,在下一次服务重启后配置即生效。
- 单击保存后,在下一次服务重启后配置即生效。

- 点击 **保存并重启** 可直接重启服务使配置立即生效。
- 单击**保存并重启** 可直接重启服务使配置立即生效。

!!! danger

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

![更新配置](../figs/ds-017.png)
## 成员管理

所有角色为`admin`的账户和角色为`user`的集群创建者可以为集群添加管理员。默认集群创建者为集群的`owner`角色,并显示在**成员管理**页面。添加的集群管理员为集群的`operator`角色。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

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

集群管理员必需为用户创建的 Dashboard 企业版账户。关于如何创建账户,参见[权限管理](../5.account-management.md)。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

添加集群管理员步骤如下:

1. 在 Dashboard 企业版顶部导航栏,单击**集群管理**,然后在目标集群右侧,单击**详情**。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved
2. 在左侧导航栏,单击**集群操作**->**成员管理**。
3. 在**成员管理**页面,单击左上方的搜索框,然后在下拉列表中,选择需要添加的账户,然后单击右侧的**添加**。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

### 其他操作

- 在**成员管理**页面右上方的搜索框中,搜索集群管理员。
- 单击![delete](../figs/alert_delete.png)删除集群管理员。




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

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

![操作记录](../figs/ds-018.png)
在 Dashboard 顶部导航栏,单击**集群管理**,然后在左侧导航栏,单击**操作记录**进入操作记录页面。
abby-cyber marked this conversation as resolved.
Show resolved Hide resolved

在操作页面可以看到 1 小时、6 小时、12 小时、1 天、3 天、7 天和 14 天的操作记录,操作人、操作、时间、集群的信息。
Loading