cruvie/kk-scheduler repository overview

⁠kk-scheduler

A job scheduling system based on cron and gRPC

⁠Screenshot

⁠System Design

graph TB
  U[SDK RPCClient]
  W[Web UI]

  subgraph kk-scheduler
    C[API Handlers]
    G[Global Client]
    F[Cron Scheduler]
    C -- Update Job --> F
  end

  subgraph App
    A[kk-scheduler Client server]
    A2[User Jobs]
    A -- Trigger --> A2
  end

  subgraph Storage Layer
    J[Store Interface]
    I[Default Etcd Store]
  end

  U -- Get/Put/Enable/Trigger Job/Service --> C
  W -- Get/Put/Enable/Trigger Job/Service --> C
  C --> G
  F --> G
  G -- RPC Trigger --> A
  G <-- Get/Put --> J
  J --> I

⁠Deploy

⁠Docker

docker-compose⁠

visit http://localhost:8668⁠

⁠Usage

• Install

go get github.com/cruvie/kk-scheduler@latest

• Run a gRPC server that implements kk_scheduler.UnimplementedKKScheduleTriggerServer see client_server_test.go⁠
• Put a service and job into kk-scheduler and enable the job see readme_test.go⁠

⁠Contribute

⁠Provide more test cases

Any test case PR is welcome

⁠Support more storage engines

kk-scheduler uses Etcd as default storage engine, but any storage engine that implements StoreDriver⁠ can be used

Step1 create a store_xxxx.go like store_etcd.go⁠

Step2 test it

Step3 add config field in config.go⁠ and config.toml⁠

⁠Improve readme doc and code comments

⁠Web UI improvements