Skip to content

Commit

Permalink
doc: enhance a string of problems to improve UE (#288)
Browse files Browse the repository at this point in the history
* doc: fix hubble(cn) a subtitle with a level error

* doc: optimization of server quickstart

* doc: change the order of hubble quick start

---------

Co-authored-by: imbajin <jin@apache.org>
  • Loading branch information
aroundabout and imbajin committed Oct 9, 2023
1 parent 1b5c1c5 commit 69c2009
Show file tree
Hide file tree
Showing 12 changed files with 430 additions and 432 deletions.
4 changes: 2 additions & 2 deletions content/cn/docs/SUMMARY.md
Expand Up @@ -5,11 +5,11 @@
## Quickstart
* [Install HugeGraph-Server](quickstart/hugegraph-server.md)
* [Load data with HugeGraph-Loader](quickstart/hugegraph-loader.md)
* [Manage with HugeGraph-Tools](quickstart/hugegraph-tools.md)
* [Visual with HugeGraph-Hubble](quickstart/hugegraph-hubble.md)
* [Display with HugeGraph-Studio](quickstart/hugegraph-studio.md)
* [Develop with HugeGraph-Client](quickstart/hugegraph-client.md)
* [Manage with HugeGraph-Tools](quickstart/hugegraph-tools.md)
* [Analysis with HugeGraph-Computer](quickstart/hugegraph-computer.md)
* [Display with HugeGraph-Studio](quickstart/hugegraph-studio.md)

## Config
* [Config Guide](config/config-guide.md)
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-client.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph-Client Quick Start"
linkTitle: "Develop with HugeGraph-Client"
weight: 6
weight: 4
---

### 1 HugeGraph-Client 概述
Expand Down
2 changes: 1 addition & 1 deletion content/cn/docs/quickstart/hugegraph-computer.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph-Computer Quick Start"
linkTitle: "Analysis with HugeGraph-Computer"
weight: 7
weight: 6
---

## 1 HugeGraph-Computer 概述
Expand Down
62 changes: 31 additions & 31 deletions content/cn/docs/quickstart/hugegraph-hubble.md
@@ -1,7 +1,7 @@
---
title: "HugeGraph-Hubble Quick Start"
linkTitle: "Visual with HugeGraph-Hubble"
weight: 4
weight: 3
---

### 1 HugeGraph-Hubble概述
Expand Down Expand Up @@ -32,14 +32,40 @@ HugeGraph是一款面向分析型,支持批量操作的图数据库系统,

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

#### 2 部署
### 2 部署

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

#### 2.1 下载 toolchain 二进制包
#### 2.1 使用Docker (推荐)

> **特别注意**: 如果使用 docker 启动 hubble,且 hubble 和 server 位于同一宿主机,在后续 hubble 页面中设置 graph 的 hostname 的时候请不要直接设置 `localhost/127.0.0.1`,这将指向 hubble 容器内部而非宿主机,导致无法连接到 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 up -d``docker-compose.yml`如下:

```yaml
version: '3'
services:
server:
image: hugegraph/hugegraph
container_name: graph
ports:
- 18080:8080

hubble:
image: hugegraph/hubble
container_name: hubble
ports:
- 8088:8088
```

#### 2.2 下载 toolchain 二进制包

`hubble`项目在`toolchain`项目中, 首先下载`toolchain`的tar包

Expand Down Expand Up @@ -68,7 +94,7 @@ starting HugeGraphHubble ..............timed out with http status 502

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

#### 2.2 源码编译
#### 2.3 源码编译

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

Expand Down Expand Up @@ -114,32 +140,6 @@ cd apache-hugegraph-hubble-incubating*
bin/start-hubble.sh -d
```

#### 2.3 使用Docker

> **特别注意**: 如果使用 docker 启动 hubble,且 hubble 和 server 位于同一宿主机,在后续 hubble 页面中设置 graph 的 hostname 的时候请不要直接设置 `localhost/127.0.0.1`,这将指向 hubble 容器内部而非宿主机,导致无法连接到 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 up -d``docker-compose.yml`如下:

```yaml
version: '3'
services:
graph_hubble:
image: hugegraph/hugegraph
container_name: graph
ports:
- 18080:8080

hubble:
image: hugegraph/hubble
container_name: hubble
ports:
- 8088:8088
```

### 3 平台使用流程

平台的模块使用流程如下:
Expand Down

0 comments on commit 69c2009

Please sign in to comment.