Skip to content

Commit c465cdf

Browse files
foesa-yangcooper-lzy
authored andcommitted
Update dashboard ent (vesoft-inc#1182)
* Update dashboard ent * update * Update 8.faq.md * update * Update 2.deploy-connect-dashboard-ent.md * update-1109 * Update 2.deploy-connect-dashboard-ent.md
1 parent a6e531e commit c465cdf

File tree

8 files changed

+83
-40
lines changed

8 files changed

+83
-40
lines changed

docs-2.0/20.appendix/6.eco-tool-version.md

+9-2
Original file line numberDiff line numberDiff line change
@@ -39,8 +39,7 @@ Nebula Graph Studio(简称 Studio)是一款可以通过Web访问的图数据
3939
|:---|:---|
4040
| {{ nebula.release }} | {{studio.release}}(3754219)|
4141

42-
<!--
43-
## Nebula Dashboard
42+
## Nebula Dashboard(社区版)
4443

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

@@ -50,6 +49,14 @@ Nebula Dashboard(简称Dashboard)是一款用于监控Nebula Graph集群中
5049
-->
5150

5251

52+
## Nebula Dashboard(企业版)
53+
54+
Nebula Dashboard(简称Dashboard)是一款用于监控和管理Nebula Graph多集群中机器和服务状态的可视化工具,支持在可视化界面进行集群创建、集群导入、数据平衡、扩容缩容等操作。详情参见[什么是Nebula Dashboard](../nebula-dashboard-ent/1.what-is-dashboard-ent.md)
55+
56+
|Nebula Graph版本|Dashboard企业版本(commit id)|
57+
|:---|:---|
58+
| {{ nebula.release }} | {{dashboard-ent.release}} |
59+
5360
## Nebula Explorer
5461

5562
Nebula Explorer(简称Explorer)是一款可以通过Web访问的图探索可视化工具,搭配Nebula Graph内核使用,用于与图数据进行可视化交互。即使没有图数据操作经验,用户也可以快速成为图专家。详情参见[什么是Nebula Explorer](../nebula-explorer/about-explorer/ex-ug-what-is-explorer.md)

docs-2.0/nebula-dashboard-ent/1.what-is-dashboard-ent.md

+1
Original file line numberDiff line numberDiff line change
@@ -26,6 +26,7 @@ Nebula Dashboard(简称Dashboard)是一款用于监控和管理Nebula Graph
2626
- 监控数据默认保留14天,即只能查询最近14天内的监控数据。
2727
- 只支持2.0.1及以上版本的Nebula Graph。
2828
- 建议使用最新版本的Chrome访问Dashboard。
29+
- 建议使用官方提供的安装包进行集群创建或导入。
2930

3031
!!! note
3132

docs-2.0/nebula-dashboard-ent/2.deploy-connect-dashboard-ent.md

+62-25
Original file line numberDiff line numberDiff line change
@@ -1,29 +1,26 @@
11
# 部署Dashboard
22

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

5-
## Nebula Graph版本
5+
## 前提条件
66

7-
Dashboard版本和Nebula Graph的版本对应关系如下。
8-
9-
|Dashboard版本|Nebula Graph版本|
10-
|:---|:---|
11-
|{{ dashboard_ent.release }}|2.x|
7+
在部署Dashboard之前,用户需要确认以下信息:
128

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

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

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

21-
| 端口号 | 说明 |
22-
| ---- | ---- |
23-
| 7005 | Dashboard提供web服务的端口。 |
24-
| 8090 | nebula-http-gateway提供HTTP服务的端口。 |
25-
| 9090 | prometheus服务的端口。 |
26-
| 9200 | nebula-stats-exporter服务的端口。 |
18+
| 端口号 | 说明 |
19+
| ------ | --------------------------------- |
20+
| 7005 | Dashboard提供web服务的端口。 |
21+
| 8090 | nebula-http-gateway服务的端口。 |
22+
| 9090 | prometheus服务的端口。 |
23+
| 9200 | nebula-stats-exporter服务的端口。 |
2724

2825
- 准备License。
2926

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

3431

35-
### 安装及启动
32+
## 安装及启动
3633

3734
1. 根据需要下载tar包,建议选择最新版本。
38-
35+
3936
!!! enterpriseonly
4037

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

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

8481
5. 启动Dashboard。
8582

83+
可以使用以下命令一键启动Dashboard。
84+
```bash
85+
$ cd scripts
86+
$ sudo ./dashboard.service start all
87+
```
88+
或是执行以下命令,分别启动prometheus、webserver、exporter和gateway服务以启动Dashboard。
8689
```bash
87-
$ bash ./scripts/start.sh
90+
$ cd scripts
91+
$ sudo ./dashboard.server start prometheus # 启动prometheus服务
92+
$ sudo ./dashboard.server start webserver #启动webserver服务
93+
$ sudo ./dashboard.server start exporter #启动exporter服务
94+
$ sudo ./dashboard.server start gateway #启动gateway服务
8895
```
8996

90-
### 停止服务
97+
## 管理Dashboard服务
9198

99+
Dashboard使用脚本`dashboard.service`管理服务,包括启动、停止和查看。
100+
101+
### 语法
102+
103+
```bash
104+
$ sudo <dashboard_path>/dashboard/scripts/dashboard.service
105+
[-v] [-h]
106+
<start|stop|status> <prometheus|webserver|exporter|gateway|all>
107+
```
108+
109+
| 参数 | 说明 |
110+
| :------------------------- | :------------------- |
111+
| `dashboard_path` | Dashboard安装路径。 |
112+
| `-v` | 显示详细调试信息。 |
113+
| `-h` | 显示帮助信息。 |
114+
| `start` | 启动服务。 |
115+
| `stop` | 停止服务。 |
116+
| `status` | 查看服务状态。 |
117+
| `prometheus` | 管理prometheus服务。 |
118+
| `webserver` | 管理webserver服务。 |
119+
| `exporter` | 管理exporter服务。 |
120+
| `gateway` | 管理gateway服务。 |
121+
| `all` | 管理所有服务。 |
122+
123+
### 示例
124+
125+
Dashboard的安装在当前目录下,用户可以用以下命令管理服务。
92126
```bash
93-
$ bash ./scripts/stop.sh
127+
$ sudo /dashboard/scripts/dashboard.service start all #启动Dashboard所有服务
128+
$ sudo /dashboard/scripts/dashboard.service stop all #停止Dashboard所有服务
129+
$ sudo /dashboard/scripts/dashboard.service status all #查看Dashboard所有服务状态
94130
```
95131

96132
## 后续操作
97133

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

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

docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/1.create-cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -10,7 +10,7 @@
1010
2. 在创建集群页面,完成以下配置:
1111
- 输入 **集群名称**,最大可输入15个字符,本示例设置为`test_foesa`
1212
- 选择Nebula Graph安装版本,本示例设置为`v2.6.1`
13-
- **添加节点**如果是多节点的集群,需要添加每个节点的相关信息。
13+
- **添加节点**,需要添加每个节点的相关信息。
1414

1515
1. 配置每个Host的IP信息,本示例设置为`192.168.8.144`
1616
2. 配置 SSH 信息,本示例设置如下:SSH端口号为`22`,SSH用户名为 `vesoft`,SSH 密码为`nebula`

docs-2.0/nebula-dashboard-ent/3.create-import-dashboard/2.import-cluster.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
# 导入集群
22

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

55
## 操作步骤
66

docs-2.0/nebula-dashboard-ent/4.cluster-operator/3.cluster-information.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -11,7 +11,7 @@
1111

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

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

1616
!!! caution
1717

docs-2.0/nebula-dashboard-ent/8.faq.md

+6-8
Original file line numberDiff line numberDiff line change
@@ -5,9 +5,7 @@
55
## 什么是集群、节点和服务?
66

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

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

2523
## 什么是扩缩容?
2624

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

29-
## 为什么不能操作Metad
27+
## 为什么不能操作Meta服务
3028

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

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

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

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

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

44-
用户也可以在Dashboard目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件,仍无法启动Dashboard请前往 [Nebula Graph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 Nebula Graph 官方论坛") 咨询。
42+
用户也可以在Dashboard目录中执行`cat logs/webserver.log`查看各个模块的启动信息。如果满足以上条件,仍无法启动Dashboard请前往 [Nebula Graph 官方论坛](https://discuss.nebula-graph.com.cn/ "点击前往 Nebula Graph 官方论坛") 咨询。

mkdocs.yml

+2-2
Original file line numberDiff line numberDiff line change
@@ -385,14 +385,14 @@ nav:
385385
- Studio 常见问题: nebula-studio/troubleshooting/st-ug-faq.md
386386

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

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

0 commit comments

Comments
 (0)