Skip to content

Commit

Permalink
[WIP]update Studio (#1419)
Browse files Browse the repository at this point in the history
* [WIP]update Studio

* update-0124

* Update st-ug-deploy.md
  • Loading branch information
foesa-yang authored Jan 24, 2022
1 parent 1e07dde commit c9ba105
Show file tree
Hide file tree
Showing 33 changed files with 79 additions and 59 deletions.
13 changes: 1 addition & 12 deletions docs-2.0/nebula-studio/about-studio/st-ug-limitations.md
Original file line number Diff line number Diff line change
Expand Up @@ -22,16 +22,6 @@ Studio 目前仅支持 x86_64 架构。

## 数据上传

<!--
使用云服务版 Studio 上传数据有以下限制:
- 目前仅支持上传没有表头行的 CSV 文件,而且仅支持英文逗号(,)作为分隔符。
- 单个文件不得超过 100 MB。
- 单个实例上传文件总量不得超过 1 GB。
- 单个文件仅能保存 1 天。
-->

Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文件大小及保存时间不受限制,而且数据总量以本地存储容量为准。

## 数据备份
Expand All @@ -44,7 +34,7 @@ Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文

- `USE <space_name>`:只能在 **Space** 下拉列表中选择图空间,不能运行这个语句选择图空间。
- **控制台** 上使用 nGQL 语句时,用户可以直接回车换行,不能使用换行符。
<!--

使用云服务版 Studio 时,除以上限制外,用户也不能在 **控制台** 上执行用户管理和角色管理相关的语句,包括:

- `CREATE USER`
Expand All @@ -55,7 +45,6 @@ Studio 上传数据仅支持上传无表头的 CSV 文件,但是,单个文
- `REVOKE ROLE`

关于语句的详细信息,参考[用户管理](../../7.data-security/1.authentication/2.management-user.md "点击前往用户管理")
-->

## 浏览器支持

Expand Down
13 changes: 9 additions & 4 deletions docs-2.0/nebula-studio/about-studio/st-ug-release-note.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,12 @@
## v3.2.0()

- 功能增强:

- 修复:

- 兼容:
- 适配 Nebula 3.0.0,优化用户体验。
- 新增 DEB 部署并启动 Studio。
- 导入:
- 导入时需要输入密码确认,以增强安全性。
- 控制台:
- 支持保存参数,用于参数化查询。

- 兼容:
- 移除 Node 环境,去除 Studio 对 Node.js 的依赖。
4 changes: 1 addition & 3 deletions docs-2.0/nebula-studio/about-studio/st-ug-terms.md
Original file line number Diff line number Diff line change
Expand Up @@ -6,6 +6,4 @@

- Nebula Graph:一款开源图数据库管理系统(Graph Database Management System),擅长处理千亿个点和万亿条边的超大规模数据集。详细信息,参考 [Nebula Graph 用户手册](../../README.md "点击前往 Nebula Graph 用户手册")

<!--
- Nebula Graph Cloud Service:Nebula Graph 图数据库的云服务平台(Database-as-a-Service,DBaaS),按需付费,支持一键部署 Nebula Graph,集成了 Nebula Graph Studio,并内置资源监控工具。详细信息,参考 [Nebula Graph Cloud Service 用户手册](https://cloud-docs.nebula-cloud.io/en/posts/toc/dbaas-ug-toc/ "点击前往 Nebula Graph Cloud Service 用户手册")。
-->
- Nebula Graph Cloud:一款支持 Azure 平台,在云上搭建 Nebula Graph 数据库的产品,支持一键部署 Nebula Graph,集成了可视化图数据库管理工具 Nebula Graph Studio、Nebula Dashboard、Nebula Explorer。详细信息,参考 [什么是 Nebula Graph Cloud](../../nebula-cloud/1.what-is-cloud.md)
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,12 @@ Nebula Graph Studio(简称 Studio)是一款可以通过 Web 访问的开源

## 发行版本

可以使用以下四种方式安装部署 Studio:
可以使用以下五种方式安装部署 Studio:

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

<!--
Expand All @@ -31,15 +32,13 @@ Studio 具备以下功能:

如果有以下任一需求,都可以使用 Studio:

- 有一份数据集,想进行可视化图探索或者数据分析。用户可以使用 Docker Compose 包部署 Nebula Graph,再使用 Studio 完成可视化操作。
- 有一份数据集,想进行可视化图探索或者数据分析。用户可以使用 Docker Compose 部署 Nebula Graph,再使用 Studio 完成可视化操作。
- 已经安装部署了 Nebula Graph 数据库,并且已经导入数据集,想使用 GUI 工具执行 nGQL 语句查询、可视化图探索或者数据分析。
- 刚开始学习 nGQL(Nebula Graph Query Language),但是不习惯用命令行工具,更希望使用 GUI 工具查看语句输出的结果。

## 身份验证

<!--
对于云服务版 Studio,只有 Nebula Graph 实例的创建者以及被授予操作权限的 Nebula Graph Cloud Service 用户可以登录 Studio。详细信息参考 [Nebula Graph Cloud Service 用户手册](https://cloud-docs.nebula-graph.com.cn/cn/posts/manage-instances/dbaas-ug-connect-nebulastudio/ "点击前往 Nebula Graph Cloud Service 用户手册")。
-->
对于云服务版 Studio,只有操作权限为 **ROOT****USER** 的 Nebula Graph Cloud 用户可以登录 Studio。详细信息参考 [配套的应用(Dashboard/Studio/Explorer)](../../nebula-cloud/5.solution/5.1.supporting-application.md)

因为 Nebula Graph 默认不启用身份验证,所以,一般情况下用户可以使用 `root` 账号和任意密码登录 Studio。

Expand Down
80 changes: 54 additions & 26 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -3,7 +3,7 @@
Nebula Graph Studio( 以下简称 Studio )支持云端或本地部署。云服务版 Studio 只能在 Nebula Graph Cloud Service 上使用。当在 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 用户手册")。
-->

本文介绍如何在本地通过 Docker、RPM 和 tar 包部署 Studio。
本文介绍如何在本地通过 Docker、RPM、DEB 和 tar 包部署 Studio。

!!! Note

Expand Down Expand Up @@ -107,16 +107,13 @@ $ npm run start

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

- 使用的 Linux 上安装有版本为 v10.12.0 以上的 Node.js。

- 确保在安装开始前,以下端口处于未被使用状态。

| 端口号 | 说明 |
| ---- | ---- |
| 7001 | Studio 提供的 web 服务 |
| 8080 | Nebula-http-gateway,Client 的 HTTP 服务 |

### 安装
### 安装部署

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

Expand All @@ -130,31 +127,18 @@ $ npm run start
tar -xvf nebula-graph-studio-{{studio.release}}.x86_64.tar.gz
```

### 部署

!!! Note

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

1. 部署 nebula-http-gateway 并启动。

```bash
$ cd nebula-http-gateway
$ nohup ./nebula-httpd &
```

2. 部署 nebula-graph-studio 并启动。
3. 部署 nebula-graph-studio 并启动。

```bash
$ cd nebula-graph-studio
$ npm run start
$ ./server
```

!!! caution

Studio {{studio.release}} 版本不需要依赖于 nebula-importer,故安装部署方式与 Studio v3.0.0 不同。
Studio {{studio.release}} 版本不需要依赖于 nebula-importer 和 nebula-http-gateway,故安装部署方式与 Studio v3.1.0 不同。

3. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`
4. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`

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

Expand All @@ -164,9 +148,54 @@ $ npm run start

用户可以采用 `kill pid` 的方式来关停服务:
```bash
$ kill $(lsof -t -i :8080) # stop nebula-http-gateway
$ cd nebula-graph-studio
$ npm run stop # stop nebula-graph-studio
$ kill $(lsof -t -i :7001) # stop nebula-graph-studio
```

## DEB 部署 Studio

### 前提条件

在通过 DEB 部署安装 Studio 之前,用户需要确认以下信息:

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

- 使用的 Linux 发行版为 Ubuntu。

- 确保在安装开始前,以下端口处于未被使用状态。

| 端口号 | 说明 |
| ---- | ---- |
| 7001 | Studio 提供的 web 服务 |


### 安装

1. 根据需要选择并下载 DEB 包,建议选择最新版本。常用下载链接如下:

| 安装包 | 检验和 | Nebula 版本 |
| ----- | ----- | ----- |
| [nebula-graph-studio-{{studio.release}}.x86_64.deb](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb) | [nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-{{studio.release}}.x86_64.deb.sha256) | {{ nebula.release }} |

2. 使用`sudo dpkg -i <deb>`命令安装 DEB 包。

例如,安装 Studio {{studio.release}} 版本需要运行以下命令:

```bash
$ sudo dpkg -i nebula-graph-studio-{{studio.release}}.x86_64.deb
```

3. 启动成功后,在浏览器地址栏输入 `http://ip address:7001`

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

![Nebula Graph Studio 登录界面](../figs/st-ug-001-1.png "Nebula Graph Studio 登录界面")

### 卸载

用户可以使用以下的命令卸载 Studio。

```bash
$ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64
```

## Docker 部署 Studio
Expand All @@ -182,7 +211,6 @@ $ npm run stop # stop nebula-graph-studio
| 端口号 | 说明 |
| ---- | ---- |
| 7001 | Studio 提供的 web 服务 |
| 8080 | Nebula-http-gateway,Client 的 HTTP 服务 |

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

Expand Down
Binary file added docs-2.0/nebula-studio/figs/chaxun.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 removed docs-2.0/nebula-studio/figs/st-ug-001.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-003-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-004.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-005.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-006.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-007.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-009.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-010.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-011.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-012.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-013.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-015-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-016-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-022-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-022.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-023-1.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-040.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-041.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-042.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-043.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-044.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-045.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-046.png
Binary file not shown.
Binary file removed docs-2.0/nebula-studio/figs/st-ug-055-1.png
Binary file not shown.
Binary file added docs-2.0/nebula-studio/figs/st-ug-055-2.png
Binary file removed docs-2.0/nebula-studio/figs/st-ug-055.png
Diff not rendered.
19 changes: 10 additions & 9 deletions docs-2.0/nebula-studio/use-console/st-ug-console.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,19 +2,20 @@

Studio 的控制台界面如下图所示。

![控制台界面截图](../figs/st-ug-055-1.png "控制台")
![控制台界面截图](../figs/st-ug-055-2.png "控制台")

下表列出了控制台界面上的各种功能。

| 编号 | 功能 | 说明 |
| :-- | :--| :-- |
| 1 | 工具栏 | 点击 **控制台** 页签进入控制台页面。 |
| 2 | 选择图空间 |**当前图空间** 列表中选择一个图空间。 <br/> **说明**:Studio 不支持直接在输入框中运行 `USE <space_name>` 语句。 |
| 3 | 输入框 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮运行语句。用户可以同时输入多个语句同时运行,语句之间以 `;` 分隔。
| 4 | 清空输入框 | 点击 ![表示清空的图标](../figs/st-ug-056.png "清空按钮") 按钮,清空输入框中已经输入的内容。 |
| 5 | 历史清单 | 点击 ![表示语句记录的图标](../figs/st-ug-057.png "查看语句记录") 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。 |
| 6 | 运行 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮即开始运行语句。 |
| 7 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 |
| 8 | 结果窗口 | 显示语句运行结果。如果语句会返回结果,结果窗口会以表格形式呈现返回的结果。 |
| 9 | 导出 CSV 文件 | 运行 nGQL 语句返回结果后,点击 **导出 CSV 文件** 按钮即能将结果以 CSV 文件的形式导出。 |
| 10 | 图探索功能键 | 根据运行的 nGQL 语句,用户可以点击图探索功能键将返回的结果导入 **图探索** 进行可视化展现,例如[导入图探索](st-ug-open-in-explore.md)[查看子图](st-ug-visualize-subgraph.md)|
| 3 | 自定义参数展示 | 点击 ![查询](../figs/chaxun.png)按钮可展开自定义参数,用于参数化查询,详情信息可见[管理参数](../../nebula-console.md)|
| 4 | 输入框 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮运行语句。用户可以同时输入多个语句同时运行,语句之间以 `;` 分隔。
| 5 | 清空输入框 | 点击 ![表示清空的图标](../figs/st-ug-056.png "清空按钮") 按钮,清空输入框中已经输入的内容。 |
| 6 | 历史清单 | 点击 ![表示语句记录的图标](../figs/st-ug-057.png "查看语句记录") 按钮,在语句运行记录列表里,点击其中一个语句,输入框中即自动输入该语句。列表里提供最近 15 次语句运行记录。 |
| 7 | 运行 | 在输入框中输入 nGQL 语句后,点击 ![表示运行的图标](../figs/st-ug-008.png "运行按钮") 按钮即开始运行语句。 |
| 8 | 语句运行状态 | 运行 nGQL 语句后,这里显示语句运行状态。如果语句运行成功,语句以绿色显示。如果语句运行失败,语句以红色显示。 |
| 9 | 结果窗口 | 显示语句运行结果。如果语句会返回结果,结果窗口会以表格形式呈现返回的结果。 |
| 10 | 导出 CSV 文件 | 运行 nGQL 语句返回结果后,点击 **导出 CSV 文件** 按钮即能将结果以 CSV 文件的形式导出。 |
| 11 | 图探索功能键 | 根据运行的 nGQL 语句,用户可以点击图探索功能键将返回的结果导入 **图探索** 进行可视化展现,例如[导入图探索](st-ug-open-in-explore.md)[查看子图](st-ug-visualize-subgraph.md)|

0 comments on commit c9ba105

Please sign in to comment.