Skip to content
Merged
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
22 changes: 12 additions & 10 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -9,11 +9,7 @@ Apache Kvrocks Controller is a cluster management tool for [Apache Kvrocks](http
* Manage many clusters in one controller cluster
* Support multi metadata storages like etcd and so on

## Build and Running

### Requirements

* Go >= 1.19
## Building and Running

### Build binaries

Expand All @@ -22,16 +18,16 @@ $ 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
```

### Overview
![image](docs/images/overview.png)
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 [Engine interface](https://github.com/apache/kvrocks-controller/blob/unstable/store/engine/engine.go).

### Supported Storage Engine

- [x] ETCD
- [x] Zookeeper
- [x] Consul by HashiCorp
- [x] Embedded Storage based on Raft (experimental)
- ETCD
- Zookeeper
- Consul by HashiCorp
- Embedded Raft storage (experimental)

### Run the controller server

Expand All @@ -42,6 +38,12 @@ $ make setup
$ ./_build/kvctl-server -c config/config.yaml
```

### Run the controller server in Docker

```shell
$ docker run -it -p 9379:9379 apache/kvrocks-controller:latest
```

![image](docs/images/server.gif)

### Run server with the embedded Raft engine
Expand Down
Loading