Skip to content
This repository was archived by the owner on Dec 28, 2025. It is now read-only.

Commit 85fc9c1

Browse files
Ethereal-OEthereal-O
committed
chore(doc): change some details
1 parent ff7a732 commit 85fc9c1

File tree

2 files changed

+129
-27
lines changed

2 files changed

+129
-27
lines changed

‎content/cn/docs/quickstart/computing/hugegraph-vermeer.md‎

Lines changed: 62 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -18,16 +18,67 @@ master 是负责通信、转发、汇总的节点，计算量和占用资源量
1818

1919
1. **方案一：Docker Compose（推荐）**
2020

21-
确保docker-compose.yaml存在于您的项目目录中。如果没有，你需要根据项目的docker-compose.yaml模板创建一个。
21+
确保docker-compose.yaml存在于您的项目根目录中。如果没有，以下是一个示例：
22+
```yaml
23+
#
24+
# Licensed to the Apache Software Foundation (ASF) under one or more
25+
# contributor license agreements. See the NOTICE file distributed with
26+
# this work for additional information regarding copyright ownership.
27+
# The ASF licenses this file to You under the Apache License, Version 2.0
28+
# (the "License"); you may not use this file except in compliance with
29+
# the License. You may obtain a copy of the License at
30+
#
31+
# http://www.apache.org/licenses/LICENSE-2.0
32+
#
33+
# Unless required by applicable law or agreed to in writing, software
34+
# distributed under the License is distributed on an "AS IS" BASIS,
35+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
36+
# See the License for the specific language governing permissions and
37+
# limitations under the License.
38+
#
39+
40+
version: '3.8'
41+
42+
services:
43+
vermeer-master:
44+
image: hugegraph/vermeer
45+
container_name: vermeer-master
46+
volumes:
47+
- ~/:/go/bin/config # Change here to your actual config path
48+
command: --env=master
49+
networks:
50+
vermeer_network:
51+
ipv4_address: 172.20.0.10 # Assign a static IP for the master
52+
53+
vermeer-worker:
54+
image: hugegraph/vermeer
55+
container_name: vermeer-worker
56+
volumes:
57+
- ~/:/go/bin/config # Change here to your actual config path
58+
command: --env=worker
59+
networks:
60+
vermeer_network:
61+
ipv4_address: 172.20.0.11 # Assign a static IP for the worker
62+
63+
networks:
64+
vermeer_network:
65+
driver: bridge
66+
ipam:
67+
config:
68+
- subnet: 172.20.0.0/24 # Define the subnet for your network
69+
```
70+
71+
修改 docker-compose.yaml
72+
- **Volume**：例如将两处 ~/:/go/bin/config 改为 /home/user/config:/go/bin/config（或您自己的配置目录）。
73+
- **Subnet**：根据实际情况修改子网IP。请注意，每个容器需要访问的端口在config文件中指定，具体请参照项目`config`文件夹下内容。
2274

23-
修改 docker-compose.yaml 中的 volume，例如将两处 ~/:/go/bin/config 改为 /home/user/config:/go/bin/config（或你自己的配置目录）。
2475
在项目目录构建镜像并启动（或者先用 docker build 再 docker-compose up）
2576

2677
```shell
2778
# 构建镜像（在项目根 vermeer 目录）
2879
docker build -t hugegraph/vermeer .
2980
30-
# 启动（在含 docker-compose.yaml 的目录）
81+
# 启动（在 vermeer 根目录）
3182
docker-compose up -d
3283
# 或使用新版 CLI：
3384
# docker compose up -d
@@ -42,7 +93,7 @@ docker-compose down
4293

4394
2. **方案二：通过 docker run 单独启动（手动创建网络并分配静态 IP）**
4495

45-
确保CONFIG_DIR对Docker进程具有适当的读取/执行权限（例如chmod 755 CONFIG_DIR）。
96+
确保CONFIG_DIR对Docker进程具有适当的读取/执行权限。
4697

4798
构建镜像：
4899

@@ -58,7 +109,7 @@ docker network create --driver bridge \
58109
vermeer_network
59110
```
60111

61-
运行 master（示例将容器 8080 映射到宿主机 8080；调整 CONFIG_DIR 为你的绝对配置路径）：
112+
运行 master（调整 CONFIG_DIR 为您的绝对配置路径，可以根据实际情况调整IP）：
62113

63114
```shell
64115
CONFIG_DIR=/home/user/config
@@ -67,7 +118,6 @@ docker run -d \
67118
--name vermeer-master \
68119
--network vermeer_network --ip 172.20.0.10 \
69120
-v ${CONFIG_DIR}:/go/bin/config \
70-
-p 8080:8080 \
71121
hugegraph/vermeer \
72122
--env=master
73123
```
@@ -98,7 +148,7 @@ docker network rm vermeer_network
98148

99149
3. **方案三：从源码构建**
100150

101-
构建
151+
构建。具体请参照[Vermeer Readme](https://github.com/apache/incubator-hugegraph-computer/tree/master/vermeer)。
102152

103153
```shell
104154
go build
@@ -157,7 +207,7 @@ POST http://localhost:8688/tasks/create
157207
"params": {
158208
"load.parallel": "50",
159209
"load.type": "hugegraph",
160-
"load.hg_pd_peers": "[\"10.14.139.69:8686\"]",
210+
"load.hg_pd_peers": "[\"<your-hugegraph-ip>:8686\"]",
161211
"load.hugegraph_name": "DEFAULT/hugegraph2/g",
162212
"load.hugegraph_username":"admin",
163213
"load.hugegraph_password":"xxxxx",
@@ -179,15 +229,15 @@ POST http://localhost:8688/tasks/create
179229
"params": {
180230
"load.parallel": "50",
181231
"load.type": "hdfs",
182-
"load.hdfs_namenode": "name_node",
183-
"load.hdfs_conf_path": "path",
232+
"load.hdfs_namenode": "name_node1:9000",
233+
"load.hdfs_conf_path": "/path/to/conf",
184234
"load.krb_realm":"admin",
185235
"load.krb_name":"xxxxx",
186236
"load.krb_keytab_path":"path",
187237
"load.krb_conf_path":"path",
188238
"load.hdfs_use_krb":"1",
189-
"load.vertex_files":"path",
190-
"load.edge_files":"path",
239+
"load.vertex_files":"/path/to/conf",
240+
"load.edge_files":"/path/to/conf",
191241
"load.use_out_degree": "1",
192242
"load.use_outedge": "1"
193243
}

‎content/en/docs/quickstart/computing/hugegraph-vermeer.md‎

Lines changed: 67 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -18,22 +18,75 @@ The framework's runtime configuration can be passed via command-line parameters
1818

1919
1. **Option 1: Docker Compose (Recommended)**
2020

21-
Ensure docker-compose.yaml exists in your project directory. If not, you'll need to create one based on the project's docker-compose.yaml template.
21+
Please ensure that `docker-compose.yaml` exists in your project root directory. If it doesn't, here is an example:
22+
23+
```yaml
24+
#
25+
# Licensed to the Apache Software Foundation (ASF) under one or more
26+
# contributor license agreements.  See the NOTICE file distributed with
27+
# this work for additional information regarding copyright ownership.
28+
# The ASF licenses this file to You under the Apache License, Version 2.0
29+
# (the "License"); you may not use this file except in compliance with
30+
# the License.  You may obtain a copy of the License at
31+
#
32+
#    http://www.apache.org/licenses/LICENSE-2.0
33+
#
34+
# Unless required by applicable law or agreed to in writing, software
35+
# distributed under the License is distributed on an "AS IS" BASIS,
36+
# WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
37+
# See the License for the specific language governing permissions and
38+
# limitations under the License.
39+
#
40+
41+
version: '3.8'
42+
43+
services:
44+
  vermeer-master:
45+
    image: hugegraph/vermeer
46+
    container_name: vermeer-master
47+
    volumes:
48+
      - ~/:/go/bin/config # Change here to your actual config path
49+
    command: --env=master
50+
    networks:
51+
      vermeer_network:
52+
        ipv4_address: 172.20.0.10 # Assign a static IP for the master
53+
54+
  vermeer-worker:
55+
    image: hugegraph/vermeer
56+
    container_name: vermeer-worker
57+
    volumes:
58+
      - ~/:/go/bin/config # Change here to your actual config path
59+
    command: --env=worker
60+
    networks:
61+
      vermeer_network:
62+
        ipv4_address: 172.20.0.11 # Assign a static IP for the worker
63+
64+
networks:
65+
  vermeer_network:
66+
    driver: bridge
67+
    ipam:
68+
      config:
69+
        - subnet: 172.20.0.0/24 # Define the subnet for your network
70+
```
71+
72+
Modify `docker-compose.yaml`
2273

23-
Modify the volume in `docker-compose.yaml`, for example, changing the two instances of `~/:/go/bin/config` to `/home/user/config:/go/bin/config` (or your own configuration directory).
24-
Build the image and start up in the project directory (or use `docker build` first, then `docker-compose up`)
74+
- **Volume**: For example, change both instances of `~/:/go/bin/config` to `/home/user/config:/go/bin/config` (or your own configuration directory).
75+
- **Subnet**: Modify the subnet IP based on your actual situation. Note that the ports each container needs to access are specified in the config file. Please refer to the contents of the project's `config` folder for details.
76+
77+
Build the Image and Start in the Project Directory (or `docker build` first, then `docker-compose up`)
2578

2679
```shell
27-
# Build the image (in the project root 'vermeer' directory)
80+
# Build the image (in the project root vermeer directory)
2881
docker build -t hugegraph/vermeer .
2982
30-
# Start up (in the directory containing docker-compose.yaml)
83+
# Start the services (in the vermeer root directory)
3184
docker-compose up -d
3285
# Or use the new CLI:
3386
# docker compose up -d
3487
```
3588

36-
View logs / Stop / Remove:
89+
View Logs / Stop / Remove
3790

3891
```shell
3992
docker-compose logs -f
@@ -42,7 +95,7 @@ docker-compose down
4295

4396
2. **Option 2: Start individually via `docker run` (Manually create network and assign static IP)**
4497

45-
Ensure the CONFIG_DIR has proper read/execute permissions for the Docker process (e.g., chmod 755 CONFIG_DIR).
98+
Ensure the CONFIG_DIR has proper read/execute permissions for the Docker process.
4699

47100
Build the image:
48101

@@ -58,7 +111,7 @@ docker network create --driver bridge \
58111
vermeer_network
59112
```
60113

61-
Run master (Example maps container port 8080 to host port 8080; adjust `CONFIG_DIR` to your absolute configuration path):
114+
Run master (adjust `CONFIG_DIR` to your **absolute** configuration path, and you can adjust the IP as needed based on your actual situation).
62115

63116
```shell
64117
CONFIG_DIR=/home/user/config
@@ -67,7 +120,6 @@ docker run -d \
67120
--name vermeer-master \
68121
--network vermeer_network --ip 172.20.0.10 \
69122
-v ${CONFIG_DIR}:/go/bin/config \
70-
-p 8080:8080 \
71123
hugegraph/vermeer \
72124
--env=master
73125
```
@@ -98,7 +150,7 @@ docker network rm vermeer_network
98150

99151
3. **Option 3: Build from Source**
100152

101-
Build
153+
Build. You can refer[Vermeer Readme](https://github.com/apache/incubator-hugegraph-computer/tree/master/vermeer).
102154

103155
```shell
104156
go build
@@ -157,7 +209,7 @@ POST http://localhost:8688/tasks/create
157209
"params": {
158210
"load.parallel": "50",
159211
"load.type": "hugegraph",
160-
"load.hg_pd_peers": "[\"10.14.139.69:8686\"]",
212+
"load.hg_pd_peers": "[\"<your-hugegraph-ip>:8686\"]",
161213
"load.hugegraph_name": "DEFAULT/hugegraph2/g",
162214
"load.hugegraph_username":"admin",
163215
"load.hugegraph_password":"xxxxx",
@@ -179,15 +231,15 @@ POST http://localhost:8688/tasks/create
179231
"params": {
180232
"load.parallel": "50",
181233
"load.type": "hdfs",
182-
"load.hdfs_namenode": "name_node",
183-
"load.hdfs_conf_path": "path",
234+
"load.hdfs_namenode": "name_node1:9000",
235+
"load.hdfs_conf_path": "/path/to/conf",
184236
"load.krb_realm":"admin",
185237
"load.krb_name":"xxxxx",
186238
"load.krb_keytab_path":"path",
187239
"load.krb_conf_path":"path",
188240
"load.hdfs_use_krb":"1",
189-
"load.vertex_files":"path",
190-
"load.edge_files":"path",
241+
"load.vertex_files":"/path/to/conf",
242+
"load.edge_files":"/path/to/conf",
191243
"load.use_out_degree": "1",
192244
"load.use_outedge": "1"
193245
}

0 commit comments

Comments
 (0)