Skip to content

Commit e6f9c73

Browse files
foesa-yangfoesa-yang
authored
update studio (#1069)
* [WIP]update studio * Update st-ug-deploy.md * Create st-ug-deploy-by-helm.md * Update st-ug-deploy-by-helm.md * Update st-ug-deploy-by-helm.md * Update st-ug-release-note.md * Update st-ug-deploy-by-helm.md * Update mkdocs.yml * update * update
1 parent e847c6d commit e6f9c73

10 files changed

+165
-68
lines changed

‎docs-2.0/nebula-studio/about-studio/st-ug-check-updates.md

+1-1
Original file line numberDiff line numberDiff line change
@@ -12,5 +12,5 @@ Studio 处于持续开发状态中。用户可以通过 [Studio 发布版本更
1212

1313
成功连接 Studio 后，用户可以在页面右上角点击版本号，再点击 **新发布**，前往查看 Studio 的版本更新记录。
1414

15-
![在页面右上角点击版本号，并在弹出菜单里点击“新发布”](../figs/st-ug-014-2.png "查看 Studio 版本更新记录")
15+
![在页面右上角点击版本号，并在弹出菜单里点击“新发布”](../figs/st-ug-014.png "查看 Studio 版本更新记录")
1616

‎docs-2.0/nebula-studio/about-studio/st-ug-limitations.md

+1
Original file line numberDiff line numberDiff line change
@@ -13,6 +13,7 @@
1313
| 1.x | 1.x|
1414
| 2.0 & 2.0.1 | 2.x |
1515
| 2.5.0 & 2.5.1 | 3.0.0 |
16+
| 2.6.0 | 3.1.0 |
1617

1718
## 系统架构
1819

‎docs-2.0/nebula-studio/about-studio/st-ug-release-note.md

+20-2
Original file line numberDiff line numberDiff line change
@@ -1,7 +1,25 @@
11
# Studio版本更新说明
2+
3+
## v3.1.0(2021.10.29)
4+
5+
- 功能增强：
6+
- 适配 Nebula 2.6.0。
7+
- 新增在 Kubernetes 集群里使用 Helm 部署并启动 Studio。
8+
- 新增 GEO 数据类型。
9+
- 图探索
10+
- 新增配置节点图标功能。
11+
12+
- 修复：
13+
- Schema
14+
- 修复以关键字命名的 Tag/Edge 或其下属性时会报错的问题。
15+
- 修复数据类型不完善的问题，补充 date/time/datetime/int32/int16/int8 等类型枚举。
16+
17+
- 兼容：
18+
- 去除 Studio 对 nebula-importer 的依赖，用 http-gateway 兼容相关功能。
19+
220
## v3.0.0（2021.08.13）
321

422
- 功能增强：
523

6-
- 适配 Nebula 2.5.0
7-
- 配置 Schema 中支持给 Space、Tag、Edge Type、Index 添加 COMMENT
24+
- 适配 Nebula 2.5.0。
25+
- 配置 Schema 中支持给 Space、Tag、Edge Type、Index 添加 COMMENT。

‎docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md

+2-1
Original file line numberDiff line numberDiff line change
@@ -4,11 +4,12 @@ Nebula Graph Studio（简称 Studio）是一款可以通过 Web 访问的图数
44

55
## 发行版本
66

7-
Studio 目前有三个发行版本：
7+
可以使用以下四种方式安装部署 Studio：
88

99
- Docker 版本：用户可以使用 Docker 服务部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [Docker 部署 Studio](../deploy-connect/st-ug-deploy.md)。
1010
- RPM 版本：用户可以使用 RPM 服务部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [RPM 部署 Studio](../deploy-connect/st-ug-deploy.md)。
1111
- tar 包安装部署：用户可以使用 tar 包安装并部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [tar 包部署 Studio](../deploy-connect/st-ug-deploy.md)。
12+
- 使用 Helm 安装部署：在 Kubernetes 集群里使用 Helm 安装并部署 Studio，并连接到 Nebula Graph 数据库。详细信息参考 [使用 Helm 部署 Nebula Graph Studio](../deploy-connect/st-ug-deploy-by-helm.md)。
1213

1314
<!--
1415
- 云服务版本：用户可以在 Nebula Graph Cloud Service 上创建 Nebula Graph 数据库实例，并一键直连云服务版 Studio。详细信息参考 [Nebula Graph Cloud Service 用户手册](https://cloud-docs.nebula-graph.com.cn/cn/posts/manage-instances/dbaas-ug-connect-nebulastudio/ "点击前往 Nebula Graph Cloud Service 用户手册")。

‎docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md

+65
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,65 @@
1+
# 使用 Helm 部署 Studio
2+
3+
本文介绍如何在通过 Kubernetes 集群里用 Helm 来部署并启动 Studio。
4+
5+
## 前提条件
6+
7+
安装 Studio 前，用户需要安装以下软件并确保安装版本的正确性：
8+
| 软件 | 版本要求 |
9+
| ------------------------------------------------------------ | --------- |
10+
| [Kubernetes](https://kubernetes.io) | \>= 1.14 |
11+
| [Helm](https://helm.sh) | \>= 3.2.0 |
12+
13+
## 安装
14+
15+
1. 克隆 Studio 的源代码到主机。
16+
17+
```bash
18+
$ git clone https://github.com/vesoft-inc/nebula-studio.git
19+
```
20+
21+
2. 进入`nebula-studio`目录。
22+
23+
```bash
24+
$ cd nebula-studio
25+
```
26+
27+
3. 安装 Studio 到 Helm Chart，命名为 `my-studio`。
28+
29+
```bash
30+
$ helm upgrade --install my-studio --set service.type=NodePort --set service.port=30070 deployment/helm
31+
```
32+
33+
4. 启动成功后，在浏览器地址栏输入 `http://address-of-node:30070/`。
34+
如果在浏览器窗口中能看到以下登录界面，表示已经成功部署并启动 Studio。
35+
36+
![Nebula Graph Studio 登录界面](../figs/st-ug-001-1.png "Nebula Graph Studio 登录界面")
37+
38+
## 卸载
39+
40+
```bash
41+
$ helm uninstall my-studio
42+
```
43+
44+
## 后续操作
45+
46+
进入 Studio 登录界面后，用户需要连接 Nebula Graph。详细信息，参考[连接数据库](st-ug-connect.md)。
47+
48+
## Nebula Graph Studio Chart配置参数说明
49+
50+
| 参数 | 默认值 | 描述 |
51+
|:---|:---|:---|
52+
| replicaCount | 0 | Deployment的副本数。 |
53+
| image.httpGateway.name | vesoft/nebula-http-gateway | nebula-http-gateway 镜像的仓库地址。 |
54+
| image.nebulaStudio.name | vesoft/nebula-graph-studio | nebula-graph-studio 镜像的仓库地址。 |
55+
| image.nginx.name | nginx | nginx 镜像的仓库地址。 |
56+
| image.httpGateway.version | v2.1.1 | nebula-http-gateway 的版本。 |
57+
| image.nebulaStudio.version | v3.1.0 | nebula-graph-studio 的版本。 |
58+
| image.nginx.version | alpine | nginx 的版本。 |
59+
| service.type | ClusterIP | 服务类型，必须为`NodePort`，`ClusterIP`或`LoadBalancer`其中之一。 |
60+
| service.port | 7001 | nebula-graph-studio 中 web 服务的端口。 |
61+
| resources.httpGateway | {} | nebula-http-gateway 的资源限制/请求。 |
62+
| resources.nebulaStudio | {} | nebula-studio的资源限制/请求。 |
63+
| resources.nginx | {} | nginx 的资源限制/请求。 |
64+
| persistent.storageClassName | "" | storageClass名称，如果不指定就使用默认值。 |
65+
| persistent.size | 5Gi | 存储盘大小。 |

‎docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md

+20-30
Original file line numberDiff line numberDiff line change
@@ -35,31 +35,28 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云
3535
| ---- | ---- |
3636
| 7001 | Studio提供web服务使用。 |
3737
| 8080 | Nebula HTTP Gateway Client进行HTTP通信使用。 |
38-
| 5699 | Nebula Importer导入数据导入使用。 |
3938

4039
### 安装
4140

4241
1. 根据需要选择并下载RPM包，建议选择最新版本。常用下载链接如下：
4342

4443
| 安装包 | 检验和 | Nebula版本 |
4544
| ----- | ----- | ----- |
46-
| [nebula-graph-studio-{{studio.release}}-1.x86_64.rpm](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.rpm) | [nebula-graph-studio-{{studio.release}}-1.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.rpm.sha256) | {{ nebula.release }} |
45+
| [nebula-graph-studio-{{studio.release}}.x86_64.rpm](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.rpm) | [nebula-graph-studio-{{studio.release}}.x86_64.rpm.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.rpm.sha256) | {{ nebula.release }} |
4746

4847
2. 使用`sudo rpm -i <rpm>`命令安装RPM包。
4948

5049
例如，安装Studio {{studio.release}} 版本需要运行以下命令：
5150

5251
```bash
53-
$ sudo rpm -i nebula-graph-studio-{{studio.release}}-1.x86_64.rpm
52+
$ sudo rpm -i nebula-graph-studio-{{studio.release}}.x86_64.rpm
5453
```
5554

5655
当屏幕返回以下信息时，表示 PRM 版 Studio 已经成功启动。
5756

5857
```bash
5958
egg started on http://0.0.0.0:7001
6059
nohup: 把输出追加到"nohup.out"
61-
--- START OF NEBULA IMPORTER ---
62-
[INFO] httpserver.go:80: Starting http server on 5699
6360
```
6461

6562

@@ -74,7 +71,7 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云
7471
用户可以使用以下的命令卸载 Studio。
7572

7673
```bash
77-
$ sudo rpm -e nebula-graph-studio-{{studio.release}}-1.x86_64
74+
$ sudo rpm -e nebula-graph-studio-{{studio.release}}.x86_64
7875
```
7976

8077
### 异常处理
@@ -83,12 +80,12 @@ $ sudo rpm -e nebula-graph-studio-{{studio.release}}-1.x86_64
8380

8481
- 手动启动服务
8582
```bash
86-
$ bash /usr/local/nebula-graph-studio/scripts/start.sh
83+
$ bash /usr/local/nebula-graph-studio/scripts/rpm/start.sh
8784
```
8885

8986
- 手动停止服务
9087
```bash
91-
$ bash /usr/local/nebula-graph-studio/scripts/stop.sh
88+
$ bash /usr/local/nebula-graph-studio/scripts/rpm/stop.sh
9289
```
9390

9491
如果启动服务时遇到报错报错 ERROR: bind EADDRINUSE 0.0.0.0:7001，用户可以通过以下命令查看端口7001是否被占用。
@@ -131,50 +128,46 @@ $ npm run start
131128
| ---- | ---- |
132129
| 7001 | Studio提供的web服务 |
133130
| 8080 | Nebula-http-gateway，Client的HTTP服务 |
134-
| 5699 | Nebula importer文件导入工具，数据导入服务 |
135131

136132
### 安装
137133

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

140136
| 安装包 | Studio 版本 |
141137
| --- | --- |
142-
| [nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz) | {{studio.release}} |
138+
| [nebula-graph-studio-{{studio.release}}.x86_64.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.tar.gz) | {{studio.release}} |
143139

144140
2. 使用 `tar -xvf` 解压 tar 包。
145141

146142
```bash
147-
tar -xvf nebula-graph-studio-{{studio.release}}-1.x86_64.tar.gz
143+
tar -xvf nebula-graph-studio-{{studio.release}}.x86_64.tar.gz
148144
```
149145

150146
### 部署
151147

152148
!!! Note
153149

154-
根目录 nebula-graph-studio 下一共有三安装包：nebula-graph-studio，nebula-importer 和 nebula-http-gateway。用户需要在同一台机器上分别部署并启动服务，才能完成 Studio 的部署。
150+
根目录 nebula-graph-studio 下一共有两个安装包：nebula-graph-studio 和 nebula-http-gateway。用户需要在同一台机器上分别部署并启动服务，才能完成 Studio 的部署。
155151

156-
1. 部署 nebula-importer 并启动。
157-
158-
```bash
159-
$ cd nebula-importer
160-
$ ./nebula-importer --port 5699 --callback "http://0.0.0.0:7001/api/import/finish" &
161-
```
162-
163-
2. 部署 nebula-http-gateway 并启动。
152+
1. 部署 nebula-http-gateway 并启动。
164153

165154
```bash
166155
$ cd nebula-http-gateway
167156
$ nohup ./nebula-httpd &
168157
```
169158

170-
3. 部署 nebula-graph-studio 并启动。
159+
2. 部署 nebula-graph-studio 并启动。
171160

172161
```bash
173162
$ cd nebula-graph-studio
174163
$ npm run start
175164
```
176165

177-
4.启动成功后，在浏览器地址栏输入 `http://ip address:7001`。
166+
!!! caution
167+
168+
Studio {{studio.release}} 版本不需要依赖于 nebula-importer，故安装部署方式与 Studio v3.0.0 不同。
169+
170+
3. 启动成功后，在浏览器地址栏输入 `http://ip address:7001`。
178171

179172
如果在浏览器窗口中能看到以下登录界面，表示已经成功部署并启动 Studio。
180173

@@ -185,7 +178,6 @@ $ npm run start
185178

186179
用户可以采用 `kill pid` 的方式来关停服务：
187180
```bash
188-
$ kill $(lsof -t -i :5699) # stop nebula-importer
189181
$ kill $(lsof -t -i :8080) # stop nebula-http-gateway
190182
$ cd nebula-graph-studio
191183
$ npm run stop # stop nebula-graph-studio
@@ -205,7 +197,6 @@ $ npm run stop # stop nebula-graph-studio
205197
| ---- | ---- |
206198
| 7001 | Studio提供的web服务 |
207199
| 8080 | Nebula-http-gateway，Client的HTTP服务 |
208-
| 5699 | Nebula importer文件导入工具，数据导入服务 |
209200

210201
- （可选）在中国大陆从 Docker Hub 拉取 Docker 镜像的速度可能比较慢，用户可以使用 `registry-mirrors` 参数配置加速镜像。例如，如果要使用 Docker 中国区官方镜像、网易镜像和中国科技大学的镜像，则按以下格式配置 `registry-mirrors` 参数：
211202

@@ -229,18 +220,18 @@ $ npm run stop # stop nebula-graph-studio
229220

230221
| 安装包 | Nebula Graph版本 |
231222
| ----- | ----- |
232-
| [nebula-graph-studio-v3.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/nebula-graph-studio-v3.tar.gz) | {{nebula.release}} |
223+
| [nebula-graph-studio-v{{studio.release}}.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/nebula-graph-studio-v{{studio.release}}.tar.gz) | {{nebula.release}} |
233224

234-
2. 创建`nebula-graph-studio-v3`目录，并将安装包解压至目录中。
225+
2. 创建`nebula-graph-studio-v{{studio.release}}`目录，并将安装包解压至目录中。
235226

236227
```bash
237-
mkdir nebula-graph-studio-v3 && tar -zxvf nebula-graph-studio-v3.tar.gz -C nebula-graph-studio-v3
228+
mkdir nebula-graph-studio-v{{studio.release}} && tar -zxvf nebula-graph-studio-v{{studio.release}}.tar.gz -C nebula-graph-studio-v{{studio.release}}
238229
```
239230

240-
3. 解压后进入 `nebula-graph-studio-v3` 目录。
231+
3. 解压后进入 `nebula-graph-studio-v{{studio.release}}` 目录。
241232

242233
```bash
243-
cd nebula-graph-studio-v3
234+
cd nebula-graph-studio-v{{studio.release}}
244235
```
245236

246237
4. 拉取 Studio 的 Docker 镜像。
@@ -258,7 +249,6 @@ $ npm run stop # stop nebula-graph-studio
258249
当屏幕返回以下信息时，表示 Docker 版 Studio 已经成功启动。
259250

260251
```bash
261-
Creating docker_importer_1 ... done
262252
Creating docker_client_1 ... done
263253
Creating docker_web_1 ... done
264254
Creating docker_nginx_1 ... done

‎docs-2.0/nebula-studio/figs/st-ug-014.png

15.4 KB
Loading

‎docs-2.0/nebula-studio/figs/st-ug-046.png

328 KB
Loading

‎docs-2.0/nebula-studio/use-console/st-ug-visualize-subgraph.md

+2-2
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,9 @@ Studio v{{ studio.release }} 及以后版本。请更新版本，详细操作参
4848

4949
- **清除插入**：清除画图板上原来的数据后，再插入新的数据。
5050

51-
数据插入成功后，用户可以看到查询结果的可视化表现。
51+
数据插入成功后，用户可以看到查询结果的可视化表现。并支持在页面中，完成点的拓展、移动画布、修改点的颜色及icon、显示点边属性等操作。
5252

53-
![在画布上显示返回的路径结果](../figs/st-ug-046-1.png "路径结果的可视化表现")
53+
![在画布上显示返回的路径结果](../figs/st-ug-046.png "路径结果的可视化表现")
5454

5555
## 后续操作
5656

0 commit comments

Comments
 (0)