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

Update dashboard ent #1182

Merged
merged 7 commits into from
Nov 10, 2021
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
10 changes: 9 additions & 1 deletion docs-2.0/20.appendix/6.eco-tool-version.md
Original file line number Diff line number Diff line change
Expand Up @@ -38,14 +38,22 @@ Nebula Graph Studio(简称 Studio)是一款可以通过Web访问的图数据
|:---|:---|
| {{ nebula.release }} | {{studio.base300}}(9e2a120)|

## Nebula Dashboard
## Nebula Dashboard(社区版)

Nebula Dashboard(简称Dashboard)是一款用于监控Nebula Graph集群中机器和服务状态的可视化工具。详情参见[什么是Nebula Dashboard](../nebula-dashboard/1.what-is-dashboard.md)。

|Nebula Graph版本|Dashboard版本(commit id)|
|:---|:---|
| {{ nebula.release }} | {{dashboard.release}}(49ab1bc) |

## Nebula Dashboard(企业版)

Nebula Dashboard(简称Dashboard)是一款用于监控和管理Nebula Graph多集群中机器和服务状态的可视化工具,支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)。

|Nebula Graph版本|Dashboard企业版本(commit id)|
|:---|:---|
| {{ nebula.release }} | {{dashboard-ent.release}} |

## Nebula Explorer

Nebula Explorer(简称Explorer)是一款可以通过Web访问的图探索可视化工具,搭配Nebula Graph内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。详情参见[什么是Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)。
Expand Down
1 change: 1 addition & 0 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 @@ -26,6 +26,7 @@ Nebula Dashboard(简称Dashboard)是一款用于监控和管理Nebula Graph
- 监控数据默认保留14天,即只能查询最近14天内的监控数据。
- 只支持2.0.1及以上版本的Nebula Graph。
- 建议使用最新版本的Chrome访问Dashboard。
- 建议使用官方提供的安装包进行集群创建或导入。

!!! note

Expand Down
87 changes: 62 additions & 25 deletions docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
Original file line number Diff line number Diff line change
@@ -1,29 +1,26 @@
# 部署Dashboard

安装部署Dashboard,本文将详细介绍如何通过tar包安装部署
本文将详细介绍如何安装并部署Dashboard

## Nebula Graph版本
## 前提条件

Dashboard版本和Nebula Graph的版本对应关系如下。

|Dashboard版本|Nebula Graph版本|
|:---|:---|
|{{ dashboard_ent.release }}|2.x|
在部署Dashboard之前,用户需要确认以下信息:

## tar 包部署
### 前提条件
- 选择并下载符合版本的Dashboard,Dashboard版本和Nebula Graph的版本对应关系如下。

在部署Dashboard之前,用户需要确认以下信息:
| Dashboard版本 | Nebula Graph版本 |
| :-------------------------- | :--------------- |
| {{ dashboard_ent.release }} | 2.x |

- 准备[MySql](https://www.mysql.com/cn/)环境,创建名称为`dashboard`的数据库。
- 确保在安装开始前,以下端口处于未被使用状态。

| 端口号 | 说明 |
| ---- | ---- |
| 7005 | Dashboard提供web服务的端口。 |
| 8090 | nebula-http-gateway提供HTTP服务的端口。 |
| 9090 | prometheus服务的端口。 |
| 9200 | nebula-stats-exporter服务的端口。 |
| 端口号 | 说明 |
| ------ | --------------------------------- |
| 7005 | Dashboard提供web服务的端口。 |
| 8090 | nebula-http-gateway服务的端口。 |
| 9090 | prometheus服务的端口。 |
| 9200 | nebula-stats-exporter服务的端口。 |

- 准备License。

Expand All @@ -32,10 +29,10 @@ Dashboard版本和Nebula Graph的版本对应关系如下。
License仅在企业版提供,请发送邮件至[email protected]


### 安装及启动
## 安装及启动

1. 根据需要下载tar包,建议选择最新版本。

!!! enterpriseonly

Dashboard仅在企业版提供,点击 [定价](https://nebula-graph.com.cn/pricing/) 查看更多。
Expand Down Expand Up @@ -65,9 +62,9 @@ Dashboard版本和Nebula Graph的版本对应关系如下。
# 服务信息
proxy:
gateway:
target: "localhost:8090" # gateway服务的IP地址和端口
target: "127.0.0.1:8090" # gateway服务的IP地址和端口
prometheus:
target: "localhost:9090" # prometheus服务的IP地址和端口
target: "127.0.0.1:9090" # prometheus服务的IP地址和端口
```

4. 拷贝License至`nebula-dashboard`目录下。
Expand All @@ -83,19 +80,59 @@ Dashboard版本和Nebula Graph的版本对应关系如下。

5. 启动Dashboard。

可以使用以下命令一键启动Dashboard。
```bash
$ cd scripts
$ sudo ./dashboard.service start all
```
或是执行以下命令,分别启动prometheus、webserver、exporter和gateway服务以启动Dashboard。
```bash
$ bash ./scripts/start.sh
$ cd scripts
$ sudo ./dashboard.server start prometheus # 启动prometheus服务
$ sudo ./dashboard.server start webserver #启动webserver服务
$ sudo ./dashboard.server start exporter #启动exporter服务
$ sudo ./dashboard.server start gateway #启动gateway服务
```

### 停止服务
## 管理Dashboard服务

Dashboard使用脚本`dashboard.service`管理服务,包括启动、停止和查看。

### 语法

```bash
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service
[-v] [-h]
<start|stop|status> <prometheus|webserver|exporter|gateway|all>
```

| 参数 | 说明 |
| :------------------------- | :------------------- |
| `dashboard_path` | Dashboard安装路径。 |
| `-v` | 显示详细调试信息。 |
| `-h` | 显示帮助信息。 |
| `start` | 启动服务。 |
| `stop` | 停止服务。 |
| `status` | 查看服务状态。 |
| `prometheus` | 管理prometheus服务。 |
| `webserver` | 管理webserver服务。 |
| `exporter` | 管理exporter服务。 |
| `gateway` | 管理gateway服务。 |
| `all` | 管理所有服务。 |

### 示例

Dashboard的安装在当前目录下,用户可以用以下命令管理服务。
```bash
$ bash ./scripts/stop.sh
$ sudo /dashboard/scripts/dashboard.service start all #启动Dashboard所有服务
$ sudo /dashboard/scripts/dashboard.service stop all #停止Dashboard所有服务
$ sudo /dashboard/scripts/dashboard.service status all #查看Dashboard所有服务状态
```

## 后续操作

启动成功后,在浏览器地址栏输入`http://<ip_address>:7005`。
在浏览器窗口中看到以下登录界面表示已经成功部署并启动了Dashboard。

![start-page](../nebula-dashboard-ent/figs/ds-028.png)
在浏览器窗口中看到以下登录界面表示已经成功部署并启动了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 @@ -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 Down
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 导入集群

本文介绍如何通过Dashboard导入集群。当前版本仅支持官方下载的DEB、RPM包部署的集群导入,暂不支持导入使用Docker和Kubernetes方式部署的集群。
本文介绍如何通过Dashboard导入集群。当前版本仅支持官方下载的DEB、RPM包部署的集群和Dashboard创建的集群导入,暂不支持导入使用Docker和Kubernetes方式部署的集群。

## 操作步骤

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

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

多机部署时,用户可以任意选择一台虚机的HOST信息
多机部署时,用户可以选择任意一个在线的Graph服务地址

!!! caution

Expand Down
14 changes: 6 additions & 8 deletions docs-2.0/nebula-dashboard-ent/8.faq.md
Original file line number Diff line number Diff line change
Expand Up @@ -5,9 +5,7 @@
## 什么是集群、节点和服务?

- 集群:Dashboard集群特指由多个Nebula Graph服务所在的节点组成的一组系统。

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

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

## 什么是集群的状态?
Expand All @@ -24,21 +22,21 @@

## 什么是扩缩容?

Nebula Graph是分布式图数据库,可以支持运行时动态扩展和缩减服务,因此可以通过Dashboard动态的扩展Storage和Graph个服务(不可以扩缩容Metad)
Nebula Graph是分布式图数据库,可以支持运行时动态扩展和缩减服务。也可以通过Dashboard可视化的动态扩展或缩减Storage和Graph服务(不可以扩缩容Metad)

## 为什么不能操作Metad
## 为什么不能操作Meta服务

Meta服务主要存储Nebula-Graph数据库中的元数据。一旦Meta服务出现问题,整个集群会面临瘫痪风险。且Meta处理的数据量较少,一般不会出现扩缩容场景,因此我们直接在Dashboard中禁用了操作Meta,防止出现用户误操作导致集群不可用的情况。
Meta服务主要存储Nebula Graph数据库中的元数据。一旦Meta服务出现问题,整个集群会面临瘫痪风险。且Meta处理的数据量较少,一般不会出现扩缩容场景,因此我们直接在Dashboard中禁用了操作Meta,防止出现用户误操作导致集群不可用的情况。

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

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

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

- 确保License已拷贝至Dashboard目录中,且执行了`bash ./scripts/start.sh`命令。
- 确保License未过期。

用户也可以在Dashboard目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件,仍无法启动Dashboard请前往 [Nebula Graph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 Nebula Graph 官方论坛") 咨询。
用户也可以在Dashboard目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件,仍无法启动Dashboard请前往 [Nebula Graph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 Nebula Graph 官方论坛") 咨询。
4 changes: 2 additions & 2 deletions mkdocs.yml
Original file line number Diff line number Diff line change
Expand Up @@ -381,14 +381,14 @@ nav:
- Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md

- Nebula Dashboard(社区版):
- 什么是Nebula Dashboard(社区版): nebula-dashboard/1.what-is-dashboard.md
- 什么是Nebula Dashboard: nebula-dashboard/1.what-is-dashboard.md
- 部署Dashboard: nebula-dashboard/2.deploy-dashboard.md
- 连接Dashboard: nebula-dashboard/3.connect-dashboard.md
- Dashboard页面介绍: nebula-dashboard/4.use-dashboard.md
- 监控指标说明: nebula-dashboard/6.monitor-parameter.md

- Nebula Dashboard(企业版):
- 什么是Nebula Dashboard(企业版): nebula-dashboard-ent/1.what-is-dashboard-ent.md
- 什么是Nebula Dashboard: nebula-dashboard-ent/1.what-is-dashboard-ent.md
- 部署Dashboard: nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md
- 创建及导入集群:
- 创建集群: nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md
Expand Down