Skip to content

doc(docker): add docker usage into README files; add a docker-compose file #335

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 22 additions & 0 deletions vermeer/README.md
Original file line number Diff line number Diff line change
Expand Up @@ -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

```
Expand Down
20 changes: 20 additions & 0 deletions vermeer/README.zh-CN.md
Original file line number Diff line number Diff line change
Expand Up @@ -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
```

## 运行

```
Expand Down
29 changes: 29 additions & 0 deletions vermeer/docker-compose.yaml
Original file line number Diff line number Diff line change
@@ -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
Loading