Google Git
Sign in
apache / kvrocks-controller / 4433b17aa6d8b32ae2e4718e0c62adb51c968e46
commit4433b17aa6d8b32ae2e4718e0c62adb51c968e46[log] [tgz]
authorhulk <hulk.website@gmail.com>Mon Apr 29 20:48:01 2024 +0800
committerGitHub <noreply@github.com>Mon Apr 29 20:48:01 2024 +0800
tree57ba9f660ce68adb587defb5f535baab00a26c58
parent590a0b4a5f67d25a4852c69af2539a6f9aee888b [diff]
Fix flaky test in controller module (#170)
6 files changed
tree: 57ba9f660ce68adb587defb5f535baab00a26c58
  1. .github/
  2. cmd/
  3. config/
  4. consts/
  5. controller/
  6. docs/
  7. logger/
  8. metrics/
  9. scripts/
  10. server/
  11. store/
  12. util/
  13. version/
  14. webui/
  15. .asf.yaml
  16. .gitignore
  17. .golangci.yml
  18. build.sh
  19. Dockerfile
  20. go.mod
  21. go.sum
  22. LICENSE
  23. Makefile
  24. NOTICE
  25. README.md
  26. VERSION.txt
README.md

Apache Kvrocks Controller

Build Status Go Report Card codecov

Apache Kvrocks Controller is a cluster management tool for Apache Kvrocks, including the following key features:

  • Failover - controller will failover or remove the master/slave node when probing failed
  • Scale out the cluster in one line command
  • Manage many clusters in one controller cluster
  • Support multi metadata storages like etcd and so on

Build and Running

Requirements

  • Go >= 1.16

Build binaries

$ git clone https://github.com/apache/kvrocks-controller
$ cd kvrocks-controller
$ make # You can find the binary file in the `_build` dir if all goes good
# ---
# If you do not have a suitable Golang compilation environment locally, you can also use 'make BUILDER_IMAGE=<golang:version>' to choose a Golang image for compilation.
# $ make BUILDER_IMAGE=golang:1.20.3

Overview

image For the storage, the ETCD is used as the default storage now. Welcome to contribute other storages like MySQL, Redis, Consul and so on. And what you need to do is to implement the persistence interface.

1. Run the controller server

# Use docker-compose to setup the etcd
$ make setup
# Run the controller server
$ ./_build/kvctl-server -c config/config.yaml

image

For the HTTP API, you can find the HTTP API(work in progress) for more details.