PragmaTwice commented on code in PR #233: URL: https://github.com/apache/kvrocks-controller/pull/233#discussion_r1888557283
########## README.md: ########## @@ -21,25 +21,74 @@ Apache Kvrocks Controller is a cluster management tool for [Apache Kvrocks](http $ 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  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). -### 1. Run the controller server +### Supported Storage Engine + +- [x] ETCD +- [x] Zookeeper +- [x] Embedding based on Raft(experimental) + +### Run the controller server ```shell # Use docker-compose to setup the etcd or zookeeper $ make setup # Run the controller server $ ./_build/kvctl-server -c config/config.yaml ``` +  -### 2. Use the terminal client to interact with the controller server +### Run server with the raft embedding engine + +> Note: The raft embedding engine is still in the experimental stage, and it's not recommended to use it in the production environment. Review Comment: ```suggestion > Note: The embedded Raft engine is still in the experimental stage, and it's not recommended to use it in the production environment. ``` -- This is an automated message from the Apache Git Service. To respond to the message, please log on to GitHub and use the URL above to go to the specific comment. To unsubscribe, e-mail: [email protected] For queries about this service, please contact Infrastructure at: [email protected]
