Ecosyste.ms: Awesome
An open API service indexing awesome lists of open source software.
https://github.com/paulja/go-work
Go project that schedules workers and uses a heartbeat all over gRPC
https://github.com/paulja/go-work
grpc
Last synced: 9 days ago
JSON representation
Go project that schedules workers and uses a heartbeat all over gRPC
- Host: GitHub
- URL: https://github.com/paulja/go-work
- Owner: paulja
- Created: 2024-12-23T17:29:23.000Z (29 days ago)
- Default Branch: main
- Last Pushed: 2025-01-06T11:38:41.000Z (16 days ago)
- Last Synced: 2025-01-06T12:30:32.268Z (15 days ago)
- Topics: grpc
- Language: Go
- Homepage:
- Size: 61.5 KB
- Stars: 0
- Watchers: 1
- Forks: 0
- Open Issues: 0
-
Metadata Files:
- Readme: README.md
Awesome Lists containing this project
README
# go-work
This a repository to demonstrate how to have cluster of workers in go.
### Design
The Leader performs two main functions: heartbeat management i.e. the health of the workers in the cluster, and scheduling new work based the workers available.
```mermaid
flowchart LR
subgraph leader
c[cluster]
s[scheduler]
end
w1["worker..n"]
w1-- health -->c
w1-- join / leave -->c
w1-- work complete -->s
s-- start/cancel work -->w1
c-- members -->s
```
There are 3 core contracts:
- cluster - the cluster manages joining and leaving the cluster and the health of workers.
- scheduler - the scheduler manages the receiving of work request and the dishing out to the workers.
- worker - the worker receives commands to start (or stop) work, and then reports health and completion of work to the cluster and schedule respectively.
All the communication is over gRPC (non-TLS in this example) using client and server RPC calls (non streaming).
### Testing
The test coverage in the codebase is relatively high, however, there are a few gaps that can be closed, the plan is to close these in the not too distant future.
### Future
- [x] Write a CLI to get a list of members, tasks and schedule work
- [x] The system hangs after work is scheduled and you try to list tasks
- [x] Only one worker is scheduled to work no matter if more are free
- [ ] Put the comms over mTLS (outside of the implementation code, i.e. NGINX or Envoy)
- [ ] Covert the heartbeat comms between the cluster leader and the members (workers) over a stream
- [ ] Create a consumer library to enable custom code to become a worker
- [ ] Get it working in ECS
- [ ] Implement RAFT and have multiple leaders
- [ ] The current task list is an in-memory linked list, make more resilient
- [ ] There are some TODOs in the code, work to remove them (mainly tests)
### Useful Commands
List all the operations available on the Leader server.
```sh
grpcurl -plaintext :50051 describe cluster.v1.LeaderService
```
List all the operations available on the Scheduler server.
```sh
grpcurl -plaintext :50052 describe scheduler.v1.SchedulerService
```
Get the list of worker members in the cluster.
```sh
grpcurl -plaintext :50051 cluster.v1.LeaderService.Members
```
Get the list of tasks pushed through the leader.
```sh
grpcurl -plaintext :50052 scheduler.v1.SchedulerService.GetTasks
```
Add a task to the scheduler.
```sh
grpcurl -plaintext -d '{"task": {"id":"1","payload":"do some work"}}' :50052 scheduler.v1.SchedulerService.ScheduleTask
```
Cancel a task from the scheduler.
```sh
grpcurl -plaintext -d '{"id":"1"}' :50052 scheduler.v1.SchedulerService.CancelTask
```