Skip to content

Commit 6203b6e

Browse files
committed
doc: fix some mistakes in docs about vermeer
1 parent 1c68478 commit 6203b6e

File tree

4 files changed

+27
-8
lines changed

4 files changed

+27
-8
lines changed

AGENTS.md

Lines changed: 5 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -100,7 +100,9 @@ make clean-all # Also remove downloaded tools
100100
```bash
101101
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0
102102
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
103-
tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
103+
104+
# Generate (adjust protoc path for your platform)
105+
vermeer/tools/protoc/linux64/protoc vermeer/apps/protos/*.proto --go-grpc_out=vermeer/apps/protos/. --go_out=vermeer/apps/protos/. # please note remove license header if any
104106
```
105107

106108
## Architecture
@@ -174,6 +176,7 @@ tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
174176
- Master scheduling: `vermeer/apps/master/tasks/tasks.go`
175177
- Worker management: `vermeer/apps/master/workers/workers.go`
176178
- HTTP endpoints: `vermeer/apps/master/services/http_master.go`
179+
- Scheduler: `vermeer/apps/master/bl/scheduler_bl.go`
177180

178181
## Integration with HugeGraph
179182

@@ -213,7 +216,7 @@ tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
213216
- Unit tests run in isolation without external dependencies
214217

215218
**Vermeer:**
216-
- Test scripts in `vermeer/test/`
219+
- Test scripts in `vermeer/test/`,with `vermeer_test.go` and `vermeer_test.sh`
217220
- Configuration files in `vermeer/config/` (master.ini, worker.ini templates)
218221

219222
## CI/CD

README.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -60,12 +60,13 @@ graph TB
6060
UI[Web UI Dashboard]
6161
end
6262
63-
subgraph Master["Master Node :6688"]
64-
HTTP[HTTP Server]
63+
subgraph Master["Master Node"]
64+
HTTP[HTTP Server :6688]
6565
GRPC_M[gRPC Server :6689]
6666
GM[Graph Manager]
6767
TM[Task Manager]
6868
WM[Worker Manager]
69+
SCH[Scheduler]
6970
end
7071
7172
subgraph Workers["Worker Nodes"]
@@ -145,6 +146,10 @@ For quick start and single-machine deployments, we recommend **Vermeer**:
145146
# Pull the image
146147
docker pull hugegraph/vermeer:latest
147148

149+
# Change config path in docker-compose.yml
150+
volumes:
151+
- ~/:/go/bin/config # Change here to your actual config path, e.g., vermeer/config
152+
148153
# Run with docker-compose
149154
docker-compose up -d
150155
```

vermeer/AGENTS.md

Lines changed: 7 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -61,7 +61,9 @@ go test -tags=vermeer_test -v -mode=scheduler
6161
```bash
6262
go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0
6363
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
64-
tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
64+
65+
# Generate (adjust protoc path for your platform)
66+
vermeer/tools/protoc/linux64/protoc vermeer/apps/protos/*.proto --go-grpc_out=vermeer/apps/protos/. --go_out=vermeer/apps/protos/. # please note remove license header if any
6567
```
6668

6769
## Architecture
@@ -81,6 +83,7 @@ vermeer/
8183
│ │ ├── services/ # HTTP handlers
8284
│ │ ├── workers/ # Worker management (WorkerManager, WorkerClient)
8385
│ │ ├── tasks/ # Task scheduling
86+
│ │ ├── schedules/ # Task scheduling strategies
8487
│ │ └── graphs/ # Graph metadata management
8588
│ ├── worker/ # Worker service entry
8689
│ ├── compute/ # Worker-side compute logic
@@ -146,6 +149,7 @@ Algorithms implement the interface defined in `apps/compute/api.go`. Each algori
146149
- Master scheduling: `apps/master/tasks/tasks.go`
147150
- Worker management: `apps/master/workers/workers.go`
148151
- HTTP endpoints: `apps/master/services/http_master.go`
152+
- Scheduler: `vermeer/apps/master/bl/scheduler_bl.go`
149153

150154
## Development Workflow
151155

@@ -167,7 +171,8 @@ Algorithms implement the interface defined in `apps/compute/api.go`. Each algori
167171
1. Edit `.proto` files in `apps/protos/`
168172
2. Regenerate Go code using protoc (adjust path for platform):
169173
```bash
170-
tools/protoc/osxm1/protoc apps/protos/*.proto --go-grpc_out=. --go_out=.
174+
# Generate (adjust protoc path for your platform)
175+
vermeer/tools/protoc/linux64/protoc vermeer/apps/protos/*.proto --go-grpc_out=vermeer/apps/protos/. --go_out=vermeer/apps/protos/. # please note remove license header if any
171176
```
172177

173178
## Configuration

vermeer/README.md

Lines changed: 8 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -78,6 +78,7 @@ vermeer/
7878
│ ├── master/ # Master service
7979
│ │ ├── services/ # HTTP handlers
8080
│ │ ├── workers/ # Worker management
81+
| | ├── schedules/ # Task scheduling strategies
8182
│ │ └── tasks/ # Task scheduling
8283
│ ├── compute/ # Worker-side compute logic
8384
│ ├── graphio/ # Graph I/O (HugeGraph, CSV, HDFS)
@@ -117,7 +118,12 @@ docker run -v ~/vermeer-config:/go/bin/config hugegraph/vermeer --env=worker
117118
118119
#### Docker Compose
119120

120-
Update `master_peer` in `~/worker.ini` to `172.20.0.10:6689`, then:
121+
Update `master_peer` in `~/worker.ini` to `172.20.0.10:6689`, and edit ``docker-compose.yml`` to mount your config directory:
122+
123+
```yaml
124+
volumes:
125+
- ~/:/go/bin/config # Change here to your actual config path
126+
```
121127
122128
```bash
123129
docker-compose up -d
@@ -479,7 +485,7 @@ go install google.golang.org/protobuf/cmd/protoc-gen-go@v1.28.0
479485
go install google.golang.org/grpc/cmd/protoc-gen-go-grpc@v1.2.0
480486

481487
# Generate (adjust protoc path for your platform)
482-
tools/protoc/osxm1/protoc *.proto --go-grpc_out=. --go_out=.
488+
vermeer/tools/protoc/linux64/protoc vermeer/apps/protos/*.proto --go-grpc_out=vermeer/apps/protos/. --go_out=vermeer/apps/protos/. # please note remove license header if any
483489
```
484490

485491
## Performance Tuning

0 commit comments

Comments
 (0)