Skip to content

Commit

Permalink
explorer/studio compatibility (#3048)
Browse files Browse the repository at this point in the history
* explorer/studio compatibility

* Update dbuser_management.md

* Update ex-ug-deploy.md

* Update ex-ug-deploy.md

* Update ex-ug-deploy.md

* Update studio-release-note.md

* Update st-ug-what-is-graph-studio.md
  • Loading branch information
cooper-lzy authored Oct 17, 2023
1 parent abdf136 commit 3e791f2
Show file tree
Hide file tree
Showing 6 changed files with 99 additions and 19 deletions.
25 changes: 25 additions & 0 deletions docs-2.0/20.appendix/release-notes/explorer-release-note.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,30 @@
# {{explorer.name}}版本更新说明

## v3.6.0

- 功能
- 增强
- 兼容性
由于数据库表结构变更,需要在配置文件内将`DB.AutoMigrate`设置为`true`,系统会自动对已有历史数据进行升级适配。

如果是咨询售后工作人员手动创建的库表,请手动修改这些表:`task_infos``task_effects``sketches``schema_snapshots``favorites``files``datasources``snapshots``templates``icon_groups``icon_items`

示例如下:

```mysql
ALTER TABLE `task_infos` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
UPDATE TABLE `task_infos` SET `b_id` = `id`;
CREATE UNIQUE INDEX `idx_task_infos_id` ON `task_infos`(`b_id`);

ALTER TABLE `task_effects` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
UPDATE TABLE `task_effects` SET `b_id` = `id`;
CREATE UNIQUE INDEX `idx_task_effects_id` ON `task_effects`(`b_id`);
...
```

- 缺陷修复
- 弃用

## v3.5.1

- 缺陷修复
Expand Down
33 changes: 33 additions & 0 deletions docs-2.0/20.appendix/release-notes/studio-release-note.md
Original file line number Diff line number Diff line change
@@ -1,5 +1,38 @@
# NebulaGraph Studio 版本更新说明

<!--
## v3.8.0
- 增强
- 兼容性
由于数据库表结构变更,需要在配置文件内将`DB.AutoMigrate`设置为`true`,系统会自动对已有历史数据进行升级适配。
如果是自己手动创建的库表,请手动修改这些表:`task_infos`、`task_effects`、`sketches`、`schema_snapshots`、`favorites`、`files`、`datasources`。
示例如下:
```mysql
ALTER TABLE `task_infos` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
UPDATE TABLE `task_infos` SET `b_id` = `id`;
CREATE UNIQUE INDEX `idx_task_infos_id` ON `task_infos`(`b_id`);
ALTER TABLE `task_effects` ADD COLUMN `b_id` CHAR(32) NOT NULL DEFAULT '';
UPDATE TABLE `task_effects` SET `b_id` = `id`;
CREATE UNIQUE INDEX `idx_task_effects_id` ON `task_effects`(`b_id`);
...
```
-->

## v3.7.0

- 增强

- 支持导入 SFTP、Amazon S3 的数据文件。
- 导入页面支持配置更多导入参数,如并发数、重试次数等。
- 支持重跑任务。
- 支持任务保存为草稿。
- 支持 ARM 架构。

## v3.6.0

- 功能
Expand Down
5 changes: 3 additions & 2 deletions docs-2.0/nebula-explorer/db-management/dbuser_management.md
Original file line number Diff line number Diff line change
Expand Up @@ -47,10 +47,11 @@

!!! note

仅`root`用户可以查看**用户列表**。
- 仅`root`用户可以查看**用户列表**。
- 由于 nGQL 语法兼容问题,连接 3.5.x 及以下版本的图数据库时禁用修改 IP 白名单功能。您可以执行对应数据库版本的 nGQL 语句修改 IP 白名单。

- 查看:查看用户在各个空间内的权限。
- 编辑:修改用户对应的密码和 IP 白名单。修改时不需要提供旧密码。非`root`用户无法查看**用户列表**,可以在页面右上角的![clear_connection](https://docs-cdn.nebula-graph.com.cn/figures/session_221024.png)图标内修改密码。
- 编辑:修改用户对应的密码或 IP 白名单。修改时不需要提供旧密码。非`root`用户无法查看**用户列表**,可以在页面右上角的![clear_connection](https://docs-cdn.nebula-graph.com.cn/figures/session_221024.png)图标内修改密码。
- 删除用户:仅`root`用户可以删除其他用户。
- 搜索账号:通过关键字搜索账号。

Expand Down
50 changes: 35 additions & 15 deletions docs-2.0/nebula-explorer/deploy-connect/ex-ug-deploy.md
Original file line number Diff line number Diff line change
Expand Up @@ -348,7 +348,8 @@ Auth:
File:
UploadDir: "./data/upload/" # 导入数据时的上传文件存储路径。
TasksDir: "./data/tasks" # 任务文件存储路径。包括导入任务、工作流任务等。
TaskIdPath: "./data/taskId.data" # 任务 ID 存储路径。
# SqliteDbFilePath # 弃用配置。
# TaskIdPath: "./data/taskId.data" # 弃用配置。请改用 DB.SqliteDbFilePath。
DB:
Enable: true
LogLevel: 4 # 数据库运行日志级别。1、2、3、4 分别对应 Silent、ERROR、Warn、INFO。
Expand All @@ -365,20 +366,39 @@ DB:
Analytics:
Host: "http://127.0.0.1:9002" # 工作流的 DAG 服务地址。
# RPC_HDFS_PASSWORD: "passward" # HDFS RPC 服务的密码。
OAuth:
Enable: false
ClientID: "10274xxxx-v2kn8oe6xxxxx.apps.googleusercontent.com" # OAuth 服务的 客户端 ID。
ClientSecret: "GOCSPX-8Enxxxxx" # OAuth 服务的 客户端密钥。
AuthURL: "https://accounts.google.com/o/oauth2/v2/auth" # OAuth 服务的 URL。
TokenURL: "https://oauth2.googleapis.com/token" # 获取访问 token 的 URL。
Scopes: "https://www.googleapis.com/auth/userinfo.email" # OAuth 服务的 scope。

UserInfoURL: "https://www.googleapis.com/oauth2/v1/userinfo" # 获取用户信息的 URL。
UsernameKey: "email" # 用户名字段。
Organization: "vesoft" # OAuth 供应商名称。
TokenName: "oauth_token" # cookie 里的 token 名称。
RedirectURL: "http://127.0.0.1:7002/login" # OAuth 服务的重定向 URL。
AvatarKey: "picture" # 用户信息中头像的密钥。
# OAuth: # 弃用配置,但是在 3.x 版本中继续保持兼容。请改用 SSO。
# Enable: false
# ClientID: "10274xxxx-v2kn8oe6xxxxx.apps.googleusercontent.com" # OAuth 服务的 客户端 ID。
# ClientSecret: "GOCSPX-8Enxxxxx" # OAuth 服务的 客户端密钥。
# AuthURL: "https://accounts.google.com/o/oauth2/v2/auth" # OAuth 服务的 URL。
# TokenURL: "https://oauth2.googleapis.com/token" # 获取访问 token 的 URL。
# Scopes: "https://www.googleapis.com/auth/userinfo.email" # OAuth 服务的 scope。
# UserInfoURL: "https://www.googleapis.com/oauth2/v1/userinfo" # 获取用户信息的 URL。
# UsernameKey: "email" # 用户名字段。
# Organization: "vesoft" # OAuth 供应商名称。
# TokenName: "oauth_token" # cookie 里的 token 名称。
# RedirectURL: "http://127.0.0.1:7002/login" # OAuth 服务的重定向 URL。
# AvatarKey: "picture" # 用户信息中头像的密钥。
SSO:
Enable: false # 是否开启单点登录。
Type: "CAS" # 单点登录服务类型。可选值为 OAuth2 和 CAS。配置该参数后再在下方配置对应的 OAuthConfig 或 CASConfig。
OAuthConfig:
ClientID: "1039194xxxxx-taufdxxxxx.apps.googleusercontent.com" # OAuth 服务的 客户端 ID。
ClientSecret: "GOCSPX-F_xBzfitifMU7acySxxxxx" # OAuth 服务的 客户端密钥。
AuthURL: "https://accounts.google.com/o/oauth2/v2/auth" # OAuth 服务的 URL。
TokenURL: "https://oauth2.googleapis.com/token" # 获取访问 token 的 URL。
Scopes: "https://www.googleapis.com/auth/userinfo.email" # OAuth 服务的 scope。
UserInfoURL: "https://www.googleapis.com/oauth2/v1/userinfo" # 获取用户信息的 URL。
UsernameKey: "email" # 用户名字段。
Organization: "vesoft" # OAuth 供应商名称。会在登录页面展示。
TokenName: "oauth_token" # cookie 里的 token 名称。
RedirectURL: "http://127.0.0.1:7002/login" # OAuth 服务的重定向 URL。
AvatarKey: "picture" # 用户信息中头像的密钥。
CASConfig:
Address: "" # CAS 服务的地址。
Organization: "vesoft" # CAS 供应商名称。会在登录页面展示。
AvatarKey: "avatar" # 用户信息中头像的密钥。
TokenName: "cas_token" # cookie 里的 token 名称。
IframeMode:
Enable: false # 是否开启内联框架模式。
# Origins: # 内联框架来源白名单。默认允许任何来源。
Expand Down
2 changes: 1 addition & 1 deletion docs-2.0/nebula-explorer/iframe.md
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@
// 登录
iframeEle.contentWindow.postMessage(
{
// `NebulaGraphExploreLogin` type has been deprecated
// `NebulaGraphExploreLogin` 类型已经弃用,使用 `ExplorerLogin` 代替,但是在 3.x 版本中继续保持兼容。
type: 'ExplorerLogin',
data: {
authorization: 'WyJyb290IiwibmVidWxhIl0=', //{{nebula.name}}账号和密码组成数组并序列化,然后进行 Base64 编码。数组格式为`['账号', '密码']`,示例为`['root', 'nebula']`,编码后为`WyJyb290IiwibmVidWxhIl0=`。
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -44,7 +44,8 @@ Studio 可以方便管理{{nebula.name}}数据,具备以下功能:

|{{nebula.name}}版本 | Studio 版本 |
| --- | --- |
| 3.5.0 | 3.7.0 |
| 3.6.0 | 3.7.0 |
| 3.5.x | 3.7.0 |
| 3.4.0 ~ 3.4.1| 3.7.0、3.6.0、3.5.1、3.5.0 |
| 3.3.0 | 3.5.1、3.5.0 |
| 3.0.0 ~ 3.2.x| 3.4.1、3.4.0|
Expand Down

0 comments on commit 3e791f2

Please sign in to comment.