From 879a31b96e6d9499fdd07c719267208e24b0f080 Mon Sep 17 00:00:00 2001 From: ethereal Date: Wed, 18 Jun 2025 15:22:17 +0800 Subject: [PATCH 1/7] doc(docker): add docker usage into README files; add a docker-compose file --- vermeer/README.md | 22 ++++++++++++++++++++++ vermeer/README.zh-CN.md | 20 ++++++++++++++++++++ vermeer/docker-compose.yaml | 29 +++++++++++++++++++++++++++++ 3 files changed, 71 insertions(+) create mode 100644 vermeer/docker-compose.yaml diff --git a/vermeer/README.md b/vermeer/README.md index 776956625..55ca14b02 100644 --- a/vermeer/README.md +++ b/vermeer/README.md @@ -3,6 +3,28 @@ ## Introduction Vermeer is a high-performance distributed graph computing platform based on memory, supporting more than 15 graph algorithms, custom algorithm extensions, and custom data source access. +## Run with Docker + +Pull the image: +``` +docker pull hugegraph/vermeer:latest +``` + +Create local configuration files, for example, `~/master.ini` and `~/worker.ini`. + +Run with Docker. The `--env` flag specifies the file name. + +``` +master: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=master +worker: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=worker +``` + +We've also provided a `docker-compose` file. Once you've created `~/master.ini` and `~/worker.ini`, and updated the `master_peer` in `worker.ini` to `172.20.0.10:6689`, you can run it using the following command: + +``` +docker-compose up -d +``` + ## Start ``` diff --git a/vermeer/README.zh-CN.md b/vermeer/README.zh-CN.md index 34dcec04c..1b125fa38 100644 --- a/vermeer/README.zh-CN.md +++ b/vermeer/README.zh-CN.md @@ -3,6 +3,26 @@ ## 简介 Vermeer是一个基于内存的高性能分布式图计算平台，支持15+图算法。支持自定义算法扩展，支持自定义数据源接入。 +## 基于 Docker 运行 + +拉取镜像 +``` +docker pull hugegraph/vermeer:latest +``` + +创建好本地配置文件，例如`~/master.ini`与`~/worker.ini` + +基于docker运行，其中`--env`指定的是文件名称。 +``` +master: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=master +worker: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=worker +``` + +我们也提供了`docker-compose`文件，当创建好`~/master.ini`与`~/worker.ini`，将`worker.ini`中的`master_peer`修改为`172.20.0.10:6689`后，即可通过以下命令运行： +``` +docker-compose up -d +``` + ## 运行 ``` diff --git a/vermeer/docker-compose.yaml b/vermeer/docker-compose.yaml new file mode 100644 index 000000000..35a506170 --- /dev/null +++ b/vermeer/docker-compose.yaml @@ -0,0 +1,29 @@ +version: '3.8' + +services: + vermeer-master: + image: hugegraph/vermeer + container_name: vermeer-master + volumes: + - ~/:/go/bin/config # Change here to your actual config path + command: --env=master + networks: + vermeer_network: + ipv4_address: 172.20.0.10 # Assign a static IP for the master + + vermeer-worker: + image: hugegraph/vermeer + container_name: vermeer-worker + volumes: + - ~/:/go/bin/config # Change here to your actual config path + command: --env=worker + networks: + vermeer_network: + ipv4_address: 172.20.0.11 # Assign a static IP for the worker + +networks: + vermeer_network: + driver: bridge + ipam: + config: + - subnet: 172.20.0.0/24 # Define the subnet for your network \ No newline at end of file From 5c264eb89cb40860e286b1c5d1011f48e11d7eeb Mon Sep 17 00:00:00 2001 From: Ethereal-O <91931223+Ethereal-O@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:25:31 +0800 Subject: [PATCH 2/7] Update vermeer/docker-compose.yaml Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- vermeer/docker-compose.yaml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/vermeer/docker-compose.yaml b/vermeer/docker-compose.yaml index 35a506170..324e4f123 100644 --- a/vermeer/docker-compose.yaml +++ b/vermeer/docker-compose.yaml @@ -5,7 +5,7 @@ services: image: hugegraph/vermeer container_name: vermeer-master volumes: - - ~/:/go/bin/config # Change here to your actual config path + - ${HOME}/:/go/bin/config # Change here to your actual config path command: --env=master networks: vermeer_network: From 217adc3247dc16b05d801a80d43ca547119f128e Mon Sep 17 00:00:00 2001 From: Ethereal-O <91931223+Ethereal-O@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:25:42 +0800 Subject: [PATCH 3/7] Update vermeer/README.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- vermeer/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vermeer/README.md b/vermeer/README.md index 55ca14b02..2f7502600 100644 --- a/vermeer/README.md +++ b/vermeer/README.md @@ -15,8 +15,8 @@ Create local configuration files, for example, `~/master.ini` and `~/worker.ini` Run with Docker. The `--env` flag specifies the file name. ``` -master: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=master -worker: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=worker +master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master +worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker ``` We've also provided a `docker-compose` file. Once you've created `~/master.ini` and `~/worker.ini`, and updated the `master_peer` in `worker.ini` to `172.20.0.10:6689`, you can run it using the following command: From c31bec7b581a81186b038994bcab153471ab3935 Mon Sep 17 00:00:00 2001 From: Ethereal-O <91931223+Ethereal-O@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:26:01 +0800 Subject: [PATCH 4/7] Update vermeer/README.zh-CN.md Co-authored-by: Copilot <175728472+Copilot@users.noreply.github.com> --- vermeer/README.zh-CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vermeer/README.zh-CN.md b/vermeer/README.zh-CN.md index 1b125fa38..4ea03c783 100644 --- a/vermeer/README.zh-CN.md +++ b/vermeer/README.zh-CN.md @@ -14,8 +14,8 @@ docker pull hugegraph/vermeer:latest 基于docker运行，其中`--env`指定的是文件名称。 ``` -master: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=master -worker: docker run -v ~/:/go/bin/config hugegraph/vermeer --env=worker +master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master +worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker ``` 我们也提供了`docker-compose`文件，当创建好`~/master.ini`与`~/worker.ini`，将`worker.ini`中的`master_peer`修改为`172.20.0.10:6689`后，即可通过以下命令运行： From f41ca5cb7b98ac98dda1019cb2ab0e6be64a0f75 Mon Sep 17 00:00:00 2001 From: Ethereal-O <91931223+Ethereal-O@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:34:49 +0800 Subject: [PATCH 5/7] Update docker-compose.yaml --- vermeer/docker-compose.yaml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vermeer/docker-compose.yaml b/vermeer/docker-compose.yaml index 324e4f123..61cc45250 100644 --- a/vermeer/docker-compose.yaml +++ b/vermeer/docker-compose.yaml @@ -15,7 +15,7 @@ services: image: hugegraph/vermeer container_name: vermeer-worker volumes: - - ~/:/go/bin/config # Change here to your actual config path + - ${HOME}/:/go/bin/config # Change here to your actual config path command: --env=worker networks: vermeer_network: @@ -26,4 +26,4 @@ networks: driver: bridge ipam: config: - - subnet: 172.20.0.0/24 # Define the subnet for your network \ No newline at end of file + - subnet: 172.20.0.0/24 # Define the subnet for your network From f4c96d9c9e35754fa8db0c24dcdb9e452b2ee76b Mon Sep 17 00:00:00 2001 From: Ethereal-O <91931223+Ethereal-O@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:35:21 +0800 Subject: [PATCH 6/7] Update README.zh-CN.md --- vermeer/README.zh-CN.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vermeer/README.zh-CN.md b/vermeer/README.zh-CN.md index 4ea03c783..c56d173a8 100644 --- a/vermeer/README.zh-CN.md +++ b/vermeer/README.zh-CN.md @@ -10,7 +10,7 @@ Vermeer是一个基于内存的高性能分布式图计算平台，支持15+图 docker pull hugegraph/vermeer:latest ``` -创建好本地配置文件，例如`~/master.ini`与`~/worker.ini` +创建好本地配置文件，例如`${HOME}/master.ini`与`${HOME}/worker.ini` 基于docker运行，其中`--env`指定的是文件名称。 ``` @@ -18,7 +18,7 @@ master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker ``` -我们也提供了`docker-compose`文件，当创建好`~/master.ini`与`~/worker.ini`，将`worker.ini`中的`master_peer`修改为`172.20.0.10:6689`后，即可通过以下命令运行： +我们也提供了`docker-compose`文件，当创建好`${HOME}/master.ini`与`${HOME}/worker.ini`，将`worker.ini`中的`master_peer`修改为`172.20.0.10:6689`后，即可通过以下命令运行： ``` docker-compose up -d ``` From a3839cbd4e1b654c8abeea3b075e70188f169784 Mon Sep 17 00:00:00 2001 From: Ethereal-O <91931223+Ethereal-O@users.noreply.github.com> Date: Fri, 20 Jun 2025 15:35:46 +0800 Subject: [PATCH 7/7] Update README.md --- vermeer/README.md | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/vermeer/README.md b/vermeer/README.md index 2f7502600..870108306 100644 --- a/vermeer/README.md +++ b/vermeer/README.md @@ -10,7 +10,7 @@ Pull the image: docker pull hugegraph/vermeer:latest ``` -Create local configuration files, for example, `~/master.ini` and `~/worker.ini`. +Create local configuration files, for example, `${HOME}/master.ini` and `${HOME}/worker.ini`. Run with Docker. The `--env` flag specifies the file name. @@ -19,7 +19,7 @@ master: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=master worker: docker run -v ${HOME}/:/go/bin/config hugegraph/vermeer --env=worker ``` -We've also provided a `docker-compose` file. Once you've created `~/master.ini` and `~/worker.ini`, and updated the `master_peer` in `worker.ini` to `172.20.0.10:6689`, you can run it using the following command: +We've also provided a `docker-compose` file. Once you've created `${HOME}/master.ini` and `${HOME}/worker.ini`, and updated the `master_peer` in `worker.ini` to `172.20.0.10:6689`, you can run it using the following command: ``` docker-compose up -d