Skip to content

Commit

Permalink
fix: CJK related problem and other outdated related problem (#291)
Browse files Browse the repository at this point in the history
* doc: cn quickstart-server fold bug fix

* doc: cn quickstart-server fold bug fix

* doc: fix CJK related problem and other outdated related problem

* sync en version

---------

Co-authored-by: imbajin <jin@apache.org>
  • Loading branch information
aroundabout and imbajin authored Oct 9, 2023
1 parent 69c2009 commit db2b0e1
Show file tree
Hide file tree
Showing 4 changed files with 93 additions and 94 deletions.
79 changes: 39 additions & 40 deletions content/cn/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -4,11 +4,11 @@ linkTitle: "Visual with HugeGraph-Hubble"
weight: 3
---

### 1 HugeGraph-Hubble概述
### 1 HugeGraph-Hubble 概述

HugeGraph是一款面向分析型,支持批量操作的图数据库系统,它由百度安全团队自主研发,全面支持[Apache TinkerPop3](https://tinkerpop.apache.org)框架和[Gremlin](https://tinkerpop.apache.org/gremlin.html)图查询语言,提供导出、备份、恢复等完善的工具链生态,有效解决海量图数据的存储、查询和关联分析需求。HugeGraph广泛应用于银行券商的风控打击、保险理赔、推荐搜索、公安犯罪打击、知识图谱构建、网络安全、IT运维等领域,致力于让更多行业、组织及用户享受到更广泛的数据综合价值。
HugeGraph 是一款面向分析型,支持批量操作的图数据库系统,它由百度安全团队自主研发,全面支持[Apache TinkerPop3](https://tinkerpop.apache.org)框架和[Gremlin](https://tinkerpop.apache.org/gremlin.html)图查询语言,提供导出、备份、恢复等完善的工具链生态,有效解决海量图数据的存储、查询和关联分析需求。HugeGraph 广泛应用于银行券商的风控打击、保险理赔、推荐搜索、公安犯罪打击、知识图谱构建、网络安全、IT 运维等领域,致力于让更多行业、组织及用户享受到更广泛的数据综合价值。

**HugeGraph-Hubble** 是HugeGraph的一站式可视化分析平台,平台涵盖了从数据建模,到数据快速导入,再到数据的在线、离线分析、以及图的统一管理的全过程,实现了图应用的全流程向导式操作,旨在提升用户的使用流畅度,降低用户的使用门槛,提供更为高效易用的使用体验。
**HugeGraph-Hubble** 是 HugeGraph 的一站式可视化分析平台,平台涵盖了从数据建模,到数据快速导入,再到数据的在线、离线分析、以及图的统一管理的全过程,实现了图应用的全流程向导式操作,旨在提升用户的使用流畅度,降低用户的使用门槛,提供更为高效易用的使用体验。

平台主要包括以下模块:

Expand All @@ -26,26 +26,26 @@ HugeGraph是一款面向分析型,支持批量操作的图数据库系统,

##### 图分析

通过输入图遍历语言Gremlin可实现图数据的高性能通用分析,并提供顶点的定制化多维路径查询等功能,提供3种图结果展示方式,包括:图形式、表格形式、Json形式,多维度展示数据形态,满足用户使用的多种场景需求。提供运行记录及常用语句收藏等功能,实现图操作的可追溯,以及查询输入的复用共享,快捷高效。支持图数据的导出,导出格式为Json格式
通过输入图遍历语言 Gremlin 可实现图数据的高性能通用分析,并提供顶点的定制化多维路径查询等功能,提供 3 种图结果展示方式,包括:图形式、表格形式、Json 形式,多维度展示数据形态,满足用户使用的多种场景需求。提供运行记录及常用语句收藏等功能,实现图操作的可追溯,以及查询输入的复用共享,快捷高效。支持图数据的导出,导出格式为 Json 格式

##### 任务管理

对于需要遍历全图的Gremlin任务,索引的创建与重建等耗时较长的异步任务,平台提供相应的任务管理功能,实现异步任务的统一的管理与结果查看。
对于需要遍历全图的 Gremlin 任务,索引的创建与重建等耗时较长的异步任务,平台提供相应的任务管理功能,实现异步任务的统一的管理与结果查看。

### 2 部署

有三种方式可以部署`hugegraph-hubble`
- 使用docker (推荐)
- 使用 docker (推荐)
- 下载 toolchain 二进制包
- 源码编译

#### 2.1 使用Docker (推荐)
#### 2.1 使用 Docker (推荐)

> **特别注意**: 如果使用 docker 启动 hubble,且 hubble 和 server 位于同一宿主机,在后续 hubble 页面中设置 graph 的 hostname 的时候请不要直接设置 `localhost/127.0.0.1`,这将指向 hubble 容器内部而非宿主机,导致无法连接到 server
> **特别注意**: 如果使用 docker 启动 hubble,且 hubble 和 server 位于同一宿主机,在后续 hubble 页面中设置 graph 的 hostname 的时候请不要直接设置 `localhost/127.0.0.1`,这将指向 hubble 容器内部而非宿主机,导致无法连接到 server. 如果 hubble 和 server 在同一 docker 网络下,则可以直接使用`container_name`作为主机名,端口则为 8080. 或者也可以使用宿主机 ip 作为主机名,此时端口号为宿主机为 server 配置的端口
我们可以使用 `docker run -itd --name=hubble -p 8088:8088 hugegraph/hubble` 快速启动 [hubble](https://hub.docker.com/r/hugegraph/hubble).

或者使用docker-compose启动hubble,另外如果hubble和graph在同一个docker网络下,可以使用graph的contain_name进行访问,而不需要宿主机的ip
或者使用 docker-compose 启动 hubble,另外如果 hubble 和 graph 在同一个 docker 网络下,可以使用 graph 的 contain_name 进行访问,而不需要宿主机的 ip

使用`docker-compose up -d``docker-compose.yml`如下:

Expand All @@ -67,7 +67,7 @@ services:
#### 2.2 下载 toolchain 二进制包
`hubble`项目在`toolchain`项目中, 首先下载`toolchain`的tar包
`hubble`项目在`toolchain`项目中首先下载`toolchain`的 tar 包

```bash
wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-{version}.tar.gz
Expand All @@ -92,11 +92,11 @@ starting HugeGraphHubble ..............timed out with http status 502
2023-08-30 20:38:41 [main] [INFO ] o.a.h.HugeGraphHubble [] - Started HugeGraphHubble in 7.379 seconds (JVM running for 8.499)
```

然后使用浏览器访问 `ip:8088` 可看到`hubble`页面, 通过`bin/stop-hubble.sh`则可以停止服务
然后使用浏览器访问 `ip:8088` 可看到`hubble`页面通过`bin/stop-hubble.sh`则可以停止服务

#### 2.3 源码编译

**注意:** 编译 hubble 需要用户本地环境有安装 `Nodejs V16.x` 与 `yarn` 环境
**注意** 编译 hubble 需要用户本地环境有安装 `Nodejs V16.x` 与 `yarn` 环境

```bash
apt install curl build-essential
Expand All @@ -117,7 +117,7 @@ node -v
npm install -g yarn
```

下载toolchain源码包
下载 toolchain 源码包

```shell
git clone https://github.com/apache/hugegraph-toolchain.git
Expand Down Expand Up @@ -152,7 +152,7 @@ bin/start-hubble.sh -d
### 4 平台使用说明
#### 4.1 图管理
##### 4.1.1 图创建
图管理模块下,点击【创建图】,通过填写图ID、图名称、主机名、端口号、用户名、密码的信息,实现多图的连接。
图管理模块下,点击【创建图】,通过填写图 ID、图名称、主机名、端口号、用户名、密码的信息,实现多图的连接。

<div style="text-align: center;">
<img src="/docs/images/images-hubble/311图创建.png" alt="image">
Expand All @@ -176,14 +176,14 @@ bin/start-hubble.sh -d

##### 4.1.3 图管理
1. 用户通过对图的概览、搜索以及单图的信息编辑与删除,实现图的统一管理。
2. 搜索范围:可对图名称和ID进行搜索
2. 搜索范围:可对图名称和 ID 进行搜索

<div style="text-align: center;">
<img src="/docs/images/images-hubble/313图管理.png" alt="image">
</div>


#### 4.2 元数据建模(列表+图模式)
#### 4.2 元数据建模(列表 + 图模式)
##### 4.2.1 模块入口
左侧导航处:

Expand Down Expand Up @@ -213,7 +213,7 @@ bin/start-hubble.sh -d

###### 4.2.2.2 复用
1. 平台提供【复用】功能,可直接复用其他图的元数据。
2. 选择需要复用的图ID,继续选择需要复用的属性,之后平台会进行是否冲突的校验,通过后,可实现元数据的复用。
2. 选择需要复用的图 ID,继续选择需要复用的属性,之后平台会进行是否冲突的校验,通过后,可实现元数据的复用。

选择复用项:

Expand All @@ -234,7 +234,7 @@ bin/start-hubble.sh -d

##### 4.2.3 顶点类型
###### 4.2.3.1 创建
1. 填写或选择顶点类型名称、ID策略、关联属性、主键属性,顶点样式、查询结果中顶点下方展示的内容,以及索引的信息:包括是否创建类型索引,及属性索引的具体内容,完成顶点类型的创建。
1. 填写或选择顶点类型名称、ID 策略、关联属性、主键属性,顶点样式、查询结果中顶点下方展示的内容,以及索引的信息:包括是否创建类型索引,及属性索引的具体内容,完成顶点类型的创建。

列表模式:

Expand All @@ -252,7 +252,7 @@ bin/start-hubble.sh -d

###### 4.2.3.2 复用
1. 顶点类型的复用,会将此类型关联的属性和属性索引一并复用。
2. 复用功能使用方法类似属性的复用,见3.2.2.2。
2. 复用功能使用方法类似属性的复用,见 3.2.2.2。

###### 4.2.3.3 管理
1. 可进行编辑操作,顶点样式、关联类型、顶点展示内容、属性索引可编辑,其余不可编辑。
Expand Down Expand Up @@ -285,7 +285,7 @@ bin/start-hubble.sh -d

###### 4.2.4.2 复用
1. 边类型的复用,会将此类型的起点类型、终点类型、关联的属性和属性索引一并复用。
2. 复用功能使用方法类似属性的复用,见3.2.2.2。
2. 复用功能使用方法类似属性的复用,见 3.2.2.2。


###### 4.2.4.3 管理
Expand Down Expand Up @@ -320,7 +320,7 @@ bin/start-hubble.sh -d


##### 4.3.3 上传文件
1. 上传需要构图的文件,目前支持的格式为CSV,后续会不断更新。
1. 上传需要构图的文件,目前支持的格式为 CSV,后续会不断更新。
2. 可同时上传多个文件。

<center>
Expand All @@ -335,9 +335,9 @@ bin/start-hubble.sh -d

1. 顶点映射和边映射:

【顶点类型】 :选择顶点类型,并为其ID映射上传文件中列数据
【顶点类型】 :选择顶点类型,并为其 ID 映射上传文件中列数据

【边类型】:选择边类型,为其起点类型和终点类型的ID列映射上传文件的列数据
【边类型】:选择边类型,为其起点类型和终点类型的 ID 列映射上传文件的列数据
2. 映射设置:为选定的顶点类型的属性映射上传文件中的列数据,此处,若属性名称与文件的表头名称一致,可自动匹配映射属性,无需手动填选
3. 完成设置后,显示设置列表,方可进行下一步操作,支持映射的新增、编辑、删除操作

Expand Down Expand Up @@ -391,9 +391,9 @@ bin/start-hubble.sh -d


##### 4.4.3 图分析与处理
HugeGraph支持Apache TinkerPop3的图遍历查询语言Gremlin,Gremlin是一种通用的图数据库查询语言,通过输入Gremlin语句,点击执行,即可执行图数据的查询分析操作,并可实现顶点/边的创建及删除、顶点/边的属性修改等。
HugeGraph 支持 Apache TinkerPop3 的图遍历查询语言 Gremlin,Gremlin 是一种通用的图数据库查询语言,通过输入 Gremlin 语句,点击执行,即可执行图数据的查询分析操作,并可实现顶点/边的创建及删除、顶点/边的属性修改等。

Gremlin查询后,下方为图结果展示区域,提供3种图结果展示方式,分别为:【图模式】、【表格模式】、【Json模式】。
Gremlin 查询后,下方为图结果展示区域,提供 3 种图结果展示方式,分别为:【图模式】、【表格模式】、【Json 模式】。

支持缩放、居中、全屏、导出等操作。

Expand All @@ -410,14 +410,14 @@ Gremlin查询后,下方为图结果展示区域,提供3种图结果展示方
</center>


Json模式
Json 模式
<center>
<img src="/docs/images/images-hubble/343图分析-json.png" alt="image">
</center>


##### 4.4.4 数据详情
点击顶点/边实体,可查看顶点/边的数据详情,包括:顶点/边类型,顶点ID,属性及对应值,拓展图的信息展示维度,提高易用性。
点击顶点/边实体,可查看顶点/边的数据详情,包括:顶点/边类型,顶点 ID,属性及对应值,拓展图的信息展示维度,提高易用性。


##### 4.4.5 图结果的多维路径查询
Expand All @@ -441,7 +441,7 @@ Gremlin查询后,下方为图结果展示区域,提供3种图结果展示方
1. 点击图区面板,出现添加顶点入口
2. 点击右上角的操作栏中的首个图标

通过选择或填写顶点类型、ID值、属性信息,完成顶点的增加。
通过选择或填写顶点类型、ID 值、属性信息,完成顶点的增加。

入口如下:

Expand Down Expand Up @@ -479,27 +479,27 @@ Gremlin查询后,下方为图结果展示区域,提供3种图结果展示方


##### 4.5.2 任务管理
1. 提供异步任务的统一的管理与结果查看,异步任务包括4类,分别为:
- gremlin:Gremlin任务
- algorithm:OLAP算法任务
1. 提供异步任务的统一的管理与结果查看,异步任务包括 4 类,分别为:
- gremlin:Gremlin 任务务
- algorithm:OLAP 算法任务务
- remove_schema:删除元数据
- rebuild_index:重建索引
2. 列表显示当前图的异步任务信息,包括:任务ID,任务名称,任务类型,创建时间,耗时,状态,操作,实现对异步任务的管理。
2. 列表显示当前图的异步任务信息,包括:任务 ID,任务名称,任务类型,创建时间,耗时,状态,操作,实现对异步任务的管理。
3. 支持对任务类型和状态进行筛选
4. 支持搜索任务ID和任务名称
4. 支持搜索任务 ID 和任务名称
5. 可对异步任务进行删除或批量删除操作

<center>
<img src="/docs/images/images-hubble/352任务列表.png" alt="image">
</center>


##### 4.5.3 Gremlin异步任务
##### 4.5.3 Gremlin 异步任务
1.创建任务

- 数据分析模块,目前支持两种Gremlin操作,Gremlin查询和Gremlin任务;若用户切换到Gremlin任务,点击执行后,在异步任务中心会建立一条异步任务;
- 数据分析模块,目前支持两种 Gremlin 操作,Gremlin 查询和 Gremlin 任务;若用户切换到 Gremlin 任务,点击执行后,在异步任务中心会建立一条异步任务;
2.任务提交
- 任务提交成功后,图区部分返回提交结果和任务ID
- 任务提交成功后,图区部分返回提交结果和任务 ID
3.任务详情
- 提供【查看】入口,可跳转到任务详情查看当前任务具体执行情况跳转到任务中心后,直接显示当前执行的任务行

Expand All @@ -516,11 +516,11 @@ Gremlin查询后,下方为图结果展示区域,提供3种图结果展示方


4.查看结果
- 结果通过json形式展示
- 结果通过 json 形式展示


##### 4.5.4 OLAP算法任务
Hubble上暂未提供可视化的OLAP算法执行,可调用RESTful API进行OLAP类算法任务,在任务管理中通过ID找到相应任务,查看进度与结果等。
##### 4.5.4 OLAP 算法任务
Hubble 上暂未提供可视化的 OLAP 算法执行,可调用 RESTful API 进行 OLAP 类算法任务,在任务管理中通过 ID 找到相应任务,查看进度与结果等。

##### 4.5.5 删除元数据、重建索引
1.创建任务
Expand All @@ -544,4 +544,3 @@ Hubble上暂未提供可视化的OLAP算法执行,可调用RESTful API进行OL
<center>
<img src="/docs/images/images-hubble/355任务详情.png" alt="image">
</center>

Loading

0 comments on commit db2b0e1

Please sign in to comment.