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.

Sign up for GitHub

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

optimize studio #1678

Merged
merged 3 commits into from
Apr 21, 2022
Merged

optimize studio #1678

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
cbdbe1f
optimize studio
cooper-lzy Apr 19, 2022
25972ea
update
cooper-lzy Apr 20, 2022
48b7fda
update
cooper-lzy Apr 20, 2022
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
3 changes: 2 additions & 1 deletion docs-2.0/nebula-studio/about-studio/st-ug-limitations.md
View file
Open in desktop
Original file line number Diff line number Diff line change
@@ -1,6 +1,6 @@
# 使用限制

本文描述了在使用 Studio 时可能会受到的限制。
本文描述使用 Studio 的限制。

## Nebula Graph 版本支持

Expand All @@ -15,6 +15,7 @@
| 2.5.x | 3.0.0 |
| 2.6.x | 3.1.x |
| 3.0.0 | 3.2.x |
|{{nebula.release}}| {{studio.release}}|

## 系统架构

Expand Down
10 changes: 5 additions & 5 deletions docs-2.0/nebula-studio/about-studio/st-ug-what-is-graph-studio.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -17,7 +17,7 @@ Nebula Studio（简称 Studio）是一款可以通过 Web 访问的开源图数

## 产品功能

Studio 可以方便管理管理 Nebula Graph 图数据，具备以下功能：
Studio 可以方便管理 Nebula Graph 图数据，具备以下功能：

- 使用 **Schema** 管理功能，用户可以使用图形界面完成图空间、Tag（标签）、Edge Type（边类型）、索引的创建，查看图空间的统计数据，快速上手 Nebula Graph。

Expand All @@ -38,13 +38,13 @@ Studio 可以方便管理管理 Nebula Graph 图数据，具备以下功能：
对于云服务版 Studio，只有操作权限为 **ROOT** 和 **USER** 的 Nebula Graph Cloud 用户可以登录 Studio。详细信息参考 [配套的应用（Dashboard/Studio/Explorer）](../../nebula-cloud/5.solution/5.1.supporting-application.md)。
-->

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

当 Nebula Graph 启用了身份验证后，用户只能使用指定的账号和密码登录 Studio。关于 Nebula Graph 的身份验证功能，参考 [Nebula Graph 用户手册](../../7.data-security/1.authentication/1.authentication.md "点击前往 Nebula Graph 官网")。
当 Nebula Graph 启用了身份验证后，用户只能使用指定的账号和密码登录 Studio。关于 Nebula Graph 的身份验证功能，参考 [身份验证](../../7.data-security/1.authentication/1.authentication.md "点击前往 Nebula Graph 官网")。

## 版本更新

Studio 处于持续开发状态中。用户可以通过 [Studio 发布版本更新](../about-studio/st-ug-release-note.md)查看最新发布的功能。
Studio 处于持续开发状态中。用户可以通过 [Studio 版本更新说明](../about-studio/st-ug-release-note.md)查看最新发布的功能。

<!--

Expand All @@ -54,6 +54,6 @@ Studio 处于持续开发状态中。用户可以通过 [Studio 发布版本更

-->

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

![在页面右上角点击头像，并在弹出菜单里点击“新发布”](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-001-cn.png)
14 changes: 7 additions & 7 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-connect.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -25,7 +25,7 @@

1. 在 Studio 的 **配置数据库** 页面上，输入以下信息：

- **Host**：填写 Nebula Graph 的 Graph 服务本机 IP 地址及端口。格式为 `ip:port`。如果端口未修改，则使用默认端口 `9669`。
- **Host**：填写 Nebula Graph 的 Graph 服务本机 IP 地址及端口。格式为`ip:port`。默认端口为`9669`。

!!! Note

Expand All @@ -50,21 +50,21 @@

成功连接 Nebula Graph 数据库后，根据账号的权限，用户可以选择执行以下操作：

- 如果已拥有 GOD 或者 ADMIN 权限的账号登录，可以使用 [**控制台**](../quick-start/st-ug-create-schema.md)或者 [**Schema**](../manage-schema/st-ug-crud-space.md) 页面管理 Schema。
- 如果已拥有 GOD、ADMIN、DBA 或者 USER 权限的账号登录，可以[批量导入数据](../quick-start/st-ug-import-data.md)或者在 **控制台** 页面上运行 nGQL 语句插入数据。
- 如果已拥有 GOD、ADMIN、DBA、USER 或者 GUEST 权限的账号登录，可以在 **控制台** 页面上运行 nGQL 语句读取数据。
- 拥有 GOD 或者 ADMIN 权限的账号，可以使用[**控制台**](../quick-start/st-ug-create-schema.md)或者 [**Schema**](../manage-schema/st-ug-crud-space.md) 页面管理 Schema、[批量导入数据](../quick-start/st-ug-import-data.md)、在**控制台**页面上执行 nGQL 语句。
- 拥有 DBA 或者 USER 权限的账号，可以[批量导入数据](../quick-start/st-ug-import-data.md)、在**控制台**页面上执行 nGQL 语句。
- 拥有 GUEST 权限的账号，仅可以在 **控制台** 页面上执行 nGQL 语句查询数据。

!!! note

账号权限参见 [内置角色权限](../../7.data-security/1.authentication/3.role-list.md)。

### 清除连接
### 登出
<!--
使用云服务版 Studio 时，用户不能清除连接。
-->

如果需要重新连接 Nebula Graph 数据库，可以清除当前连接后再重新配置数据库。
如果需要重新连接 Nebula Graph 数据库，可以登出后重新配置数据库。

当 Studio 还连接在某个 Nebula Graph 数据库时，在工具栏中，选择 **设置** > **清除连接**。之后，如果浏览器上显示 **配置数据库** 页面，表示 Studio 已经成功断开了与 Nebula Graph 数据库的连接。
在页面右上角单击用户头像，单击 **登出**，如果浏览器上显示 **配置数据库** 页面，表示 Studio 已经成功断开了与 Nebula Graph 数据库的连接。

![reset](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png)
2 changes: 1 addition & 1 deletion docs-2.0/nebula-studio/deploy-connect/st-ug-deploy-by-helm.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -31,7 +31,7 @@
$ helm upgrade --install my-studio --set service.type=NodePort --set service.port={30070} deployment/helm
```

4. 启动成功后，在浏览器地址栏输入`http://{address-of-node}:{30070}/`。
4. 启动成功后，在浏览器地址栏输入`http://<node_address>:30070`。
如果在浏览器窗口中能看到以下登录界面，表示已经成功部署并启动 Studio。

![Nebula Graph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "Nebula Graph Studio 登录界面")
Expand Down
116 changes: 58 additions & 58 deletions docs-2.0/nebula-studio/deploy-connect/st-ug-deploy.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -3,11 +3,11 @@
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、DEB 和 tar 包部署 Studio。
本文介绍如何在本地通过 RPM、DEB、tar 包和 Docker 部署 Studio。

!!! Note

用户也可以在 [Studio](https://playground.nebula-graph.com.cn/explore) 在线试用部分功能。
用户也可以[在线试用](https://playground.nebula-graph.com.cn/explore)部分 Studio 功能。

## RPM 部署 Studio

Expand All @@ -17,9 +17,9 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云

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

- 使用的 Linux 发行版为 CentOS ，安装有 lsof。
- 使用的 Linux 发行版为 CentOS ，已安装 lsof。

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

| 端口号 | 说明 |
| ---- | ---- |
Expand All @@ -29,11 +29,11 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云

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

| 安装包 | 检验和 | Nebula 版本 |
| 安装包 | 检验和 | 适用 Nebula 版本 |
| ----- | ----- | ----- |
| [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 }} |

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

例如，安装 Studio {{studio.release}} 版本需要运行以下命令，默认安装路径为`/usr/local/nebula-graph-studio`：

Expand All @@ -53,7 +53,7 @@ Nebula Graph Studio（ 以下简称 Studio ）支持云端或本地部署。云
Nebula Studio started automatically.
```

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

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

Expand All @@ -74,7 +74,7 @@ Nebula Studio removed, bye~

### 异常处理

如果在安装过程中自动启动失败或是需要手动启动或停止服务，请使用以下命令
如果在安装过程中自动启动失败或是需要手动启动或停止服务，请使用以下命令：

- 手动启动服务
```bash
Expand All @@ -86,7 +86,7 @@ $ bash /usr/local/nebula-graph-studio/scripts/rpm/start.sh
$ bash /usr/local/nebula-graph-studio/scripts/rpm/stop.sh
```

如果启动服务时遇到报错报错 ERROR: bind EADDRINUSE 0.0.0.0:7001，用户可以通过以下命令查看端口 7001 是否被占用。
如果启动服务时遇到报错报错 `ERROR: bind EADDRINUSE 0.0.0.0:7001`，用户可以通过以下命令查看端口 7001 是否被占用。
```bash
$ lsof -i:7001
```
Expand All @@ -109,103 +109,103 @@ web:
$ systemctl restart nebula-graph-studio.service
```

## tar 包部署 Studio
## DEB 部署 Studio

### 前提条件

在部署 tar 包安装的 Studio 之前，用户需要确认以下信息：
在通过 DEB 部署安装 Studio 之前，用户需要确认以下信息：

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

- 确保在安装开始前，以下端口处于未被使用状态。
- 使用的 Linux 发行版为 Ubuntu。

- 确保以下端口未被占用。

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

### 安装部署
- 确保系统中存在`/usr/lib/systemd/system`目录。如没有该目录，需手动创建。

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

| 安装包 | Studio 版本 |
| --- | --- |
| [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}} |
1. 根据需要选择并下载 DEB 包，建议选择最新版本。常用下载链接如下：

2. 使用 `tar -xvf` 解压 tar 包。
| 安装包 | 检验和 | 适用 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 }} |

```bash
tar -xvf nebula-graph-studio-{{studio.release}}.x86_64.tar.gz
```
2. 使用`sudo dpkg -i <deb_name>`命令安装 DEB 包。

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

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

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

!!! caution

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

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

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

![Nebula Graph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "Nebula Graph Studio 登录界面")
### 停止服务

用户可以采用 `kill pid` 的方式来关停服务：
### 卸载

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

```bash
$ kill $(lsof -t -i :7001) # stop nebula-graph-studio
$ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64
```

## DEB 部署 Studio
## tar 包部署 Studio

### 前提条件

在通过 DEB 部署安装 Studio 之前，用户需要确认以下信息：
在部署 tar 包安装的 Studio 之前，用户需要确认以下信息：

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

- 使用的 Linux 发行版为 Ubuntu。

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

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

- 确保系统中存在`/usr/lib/systemd/system`目录。如没有该目录，需手动创建。

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

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

| 安装包 | 检验和 | 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 }} |
| 安装包 | Studio 版本 |适用 Nebula 版本 |
| --- | --- |---|
| [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}} | {{ nebula.release }} |

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

例如，安装 Studio {{studio.release}} 版本需要运行以下命令：
```bash
tar -xvf nebula-graph-studio-{{studio.release}}.x86_64.tar.gz
```

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

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

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

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

4. 启动成功后，在浏览器地址栏输入 `http://<ip address>:7001`。

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

![Nebula Graph Studio 登录界面](https://docs-cdn.nebula-graph.com.cn/figures/st-ug-000-cn.png "Nebula Graph Studio 登录界面")
### 停止服务

### 卸载

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

用户可以采用 `kill <pid>` 的方式来关停服务：
```bash
$ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64
$ kill $(lsof -t -i :7001) # stop nebula-graph-studio
```

## Docker 部署 Studio
Expand All @@ -216,7 +216,7 @@ $ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64
- Nebula Graph 服务已经部署并启动。详细信息，参考 [Nebula Graph 安装部署](../../4.deployment-and-installation/1.resource-preparations.md "点击前往 Nebula Graph 安装部署")。

- 在即将运行 Docker 版 Studio 的机器上安装并启动 Docker Compose。详细信息参考 [Docker Compose 文档](https://docs.docker.com/compose/install/ "点击前往 Docker 文档中心")。
- 确保在安装开始前，以下端口处于未被使用状态。
- 确保以下端口未被占用。

| 端口号 | 说明 |
| ---- | ---- |
Expand All @@ -238,11 +238,11 @@ $ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64

### 操作步骤

在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用 Nebula Graph 版本为 2.5 的进行演示：
在命令行工具中按以下步骤依次运行命令，部署并启动 Docker 版 Studio，这里我们用 Nebula Graph 版本为 {{nebula.release}} 的进行演示：

1. 下载 Studio 的部署配置文件。

| 安装包 | Nebula Graph 版本 |
| 安装包 | 适用 Nebula 版本 |
| ----- | ----- |
| [nebula-graph-studio-v{{studio.release}}.tar.gz](https://oss-cdn.nebula-graph.com.cn/nebula-graph-studio/{{studio.release}}/nebula-graph-studio-v{{studio.release}}.tar.gz) | {{nebula.release}} |

Expand Down Expand Up @@ -276,7 +276,7 @@ $ sudo dpkg -r nebula-graph-studio-{{studio.release}}.x86_64
Creating docker_web_1 ... done
```

6. 启动成功后，在浏览器地址栏输入 `http://ip address:7001`。
6. 启动成功后，在浏览器地址栏输入 `http://<ip address>:7001`。

!!! Note

Expand Down
Loading