Skip to content

Commit

Permalink
doc: adjust docker related desc in readme (apache#306)
Browse files Browse the repository at this point in the history

---------

Co-authored-by: imbajin <jin@apache.org>
  • Loading branch information
aroundabout and imbajin authored Dec 17, 2023
1 parent 23d0df1 commit 2c19f98
Show file tree
Hide file tree
Showing 6 changed files with 470 additions and 428 deletions.
69 changes: 38 additions & 31 deletions content/cn/docs/quickstart/hugegraph-hubble.md
Original file line number Diff line number Diff line change
Expand Up @@ -35,39 +35,12 @@ HugeGraph 是一款面向分析型,支持批量操作的图数据库系统,
### 2 部署

有三种方式可以部署`hugegraph-hubble`
- 使用 docker (推荐)

- 下载 toolchain 二进制包
- 源码编译
- 使用 docker (便于**测试**)

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

> **特别注意**: docker 模式下,若 hubble 和 server 在同一宿主机,hubble 页面中设置 graph 的 `hostname` **不能设置**`localhost/127.0.0.1`,因这会指向 hubble **容器内部**而非宿主机,导致无法连接到 server.
>
> 若 hubble 和 server 在同一 docker 网络下,**推荐**直接使用`container_name` (如下例的 `graph`) 作为主机名。或者也可以使用 **宿主机 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 up -d``docker-compose.yml`如下:

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

hubble:
image: hugegraph/hubble
container_name: hubble
ports:
- 8088:8088
```
#### 2.2 下载 toolchain 二进制包
#### 2.1 下载 toolchain 二进制包

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

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

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

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

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

Expand Down Expand Up @@ -142,6 +115,40 @@ cd apache-hugegraph-hubble-incubating*
bin/start-hubble.sh -d
```

#### 2.3 使用 Docker (便于**测试**)

> **特别注意**: docker 模式下,若 hubble 和 server 在同一宿主机,hubble 页面中设置 graph 的 `hostname` **不能设置**`localhost/127.0.0.1`,因这会指向 hubble **容器内部**而非宿主机,导致无法连接到 server.
>
> 若 hubble 和 server 在同一 docker 网络下,**推荐**直接使用`container_name` (如下例的 `graph`) 作为主机名。或者也可以使用 **宿主机 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 up -d``docker-compose.yml`如下:

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

hubble:
image: hugegraph/hubble
container_name: hubble
ports:
- 8088:8088
```
> 注意:
>
> 1. hugegraph-hubble 的 docker 镜像是一个便捷版本,用于快速启动 hubble,并不是**官方发布物料包方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
>
> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。

### 3 平台使用流程

平台的模块使用流程如下:
Expand Down
81 changes: 44 additions & 37 deletions content/cn/docs/quickstart/hugegraph-loader.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,52 +24,20 @@ HugeGraph-Loader 是 HugeGraph 的数据导入组件,能够将多种数据源

有两种方式可以获取 HugeGraph-Loader:

- 使用 Docker 镜像 (推荐)
- 下载已编译的压缩包
- 克隆源码编译安装
- 使用 Docker 镜像 (便于**测试**)

#### 2.1 使用 Docker 镜像

我们可以使用 `docker run -itd --name loader hugegraph/loader`部署 loader 服务。对于需要加载的数据,则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker cp`的方式将文件复制到 loader 容器内部。

或者使用 docker-compose 启动 loader, 启动命令为 `docker-compose up -d`, 样例的 docker-compose.yml 如下所示:

```yaml
version: '3'

services:
server:
image: hugegraph/hugegraph
container_name: graph
ports:
- 8080:8080

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

loader:
image: hugegraph/loader
container_name: loader
# mount your own data here
# volumes:
# - /path/to/data/file:/loader/file
```

具体的数据导入流程可以参考 [4.5 使用 docker 导入](#45-使用-docker-导入)

#### 2.2 下载已编译的压缩包
#### 2.1 下载已编译的压缩包

下载最新版本的 HugeGraph-Toolchain Release 包,里面包含了 loader + tool + hubble 全套工具,如果你已经下载,可跳过重复步骤

```bash
wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0.tar.gz
wget https://downloads.apache.org/incubator/hugegraph/{version}//apache-hugegraph-toolchain-incubating-{version}.tar.gz
tar zxf *hugegraph*.tar.gz
```

#### 2.3 克隆源码编译安装
#### 2.2 克隆源码编译安装

克隆最新版本的 HugeGraph-Loader 源码包:

Expand All @@ -78,7 +46,7 @@ tar zxf *hugegraph*.tar.gz
git clone https://github.com/apache/hugegraph-toolchain.git

# 2. get from direct (e.g. here is 1.0.0, please choose the latest version)
wget https://downloads.apache.org/incubator/hugegraph/1.0.0/apache-hugegraph-toolchain-incubating-1.0.0-src.tar.gz
wget https://downloads.apache.org/incubator/hugegraph/{version}/apache-hugegraph-toolchain-incubating-{version}-src.tar.gz
```

由于 Oracle ojdbc license 的限制,需要手动安装 ojdbc 到本地 maven 仓库。
Expand All @@ -98,6 +66,45 @@ cd hugegraph-loader
mvn clean package -DskipTests
```

#### 2.3 使用 Docker 镜像 (便于**测试**)

我们可以使用 `docker run -itd --name loader hugegraph/loader`部署 loader 服务。对于需要加载的数据,则可以通过挂载 `-v /path/to/data/file:/loader/file` 或者`docker cp`的方式将文件复制到 loader 容器内部。

或者使用 docker-compose 启动 loader, 启动命令为 `docker-compose up -d`, 样例的 docker-compose.yml 如下所示:

```yaml
version: '3'

services:
server:
image: hugegraph/hugegraph
container_name: graph
ports:
- 8080:8080

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

loader:
image: hugegraph/loader
container_name: loader
# mount your own data here
# volumes:
# - /path/to/data/file:/loader/file
```

具体的数据导入流程可以参考 [4.5 使用 docker 导入](#45-使用-docker-导入)


> 注意:
>
> 1. hugegraph-loader 的 docker 镜像是一个便捷版本,用于快速启动 loader,并不是**官方发布物料包方式**。你可以从 [ASF Release Distribution Policy](https://infra.apache.org/release-distribution.html#dockerhub) 中得到更多细节。
>
> 2. 推荐使用 `release tag`(如 `1.0.0`) 以获取稳定版。使用 `latest` tag 可以使用开发中的最新功能。
### 3 使用流程

使用 HugeGraph-Loader 的基本流程分为以下几步:
Expand Down
Loading

0 comments on commit 2c19f98

Please sign in to comment.