Google Git
Sign in
apache / kvrocks-controller / refs/tags/v0.3.0
commitd01e98541f872d9b961fd1e3e665393ed099c1b4[log] [tgz]
authorgit-hulk <hulk.website@gmail.com>Tue Sep 12 10:07:47 2023 +0800
committergit-hulk <hulk.website@gmail.com>Tue Sep 12 10:07:47 2023 +0800
tree9c314cf0b5d54e3c28293728137f2c7fee5f4e32
parent661d994c854498f89c630e3da98fe66f62037007 [diff]
Validate config
3 files changed
tree: 9c314cf0b5d54e3c28293728137f2c7fee5f4e32
  1. .github/
  2. cmd/
  3. config/
  4. consts/
  5. controller/
  6. docs/
  7. logger/
  8. metadata/
  9. metrics/
  10. scripts/
  11. server/
  12. storage/
  13. util/
  14. version/
  15. .gitignore
  16. .golangci.yml
  17. build.sh
  18. Dockerfile
  19. go.mod
  20. go.sum
  21. LICENSE
  22. Makefile
  23. README.md
  24. VERSION.txt
README.md

Kvrocks Cluster Controller

Build Status Go Report Card codecov

Controller for the Kvrocks cluster has 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/RocksLabs/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

2. Create the namespace and cluster via kvctl

image

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