This is an automated email from the ASF dual-hosted git repository.
hulk pushed a commit to branch unstable
in repository https://gitbox.apache.org/repos/asf/kvrocks-controller.git
The following commit(s) were added to refs/heads/unstable by this push:
new 8af8aba Add docker instructions to README (#261)
8af8aba is described below
commit 8af8aba6dd2cb01955d38f95f4a43973b304b458
Author: Twice <[email protected]>
AuthorDate: Wed Jan 29 23:05:36 2025 +0800
Add docker instructions to README (#261)
---
README.md | 22 ++++++++++++----------
1 file changed, 12 insertions(+), 10 deletions(-)
diff --git a/README.md b/README.md
index bc33c69..502b43a 100644
--- a/README.md
+++ b/README.md
@@ -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
@@ -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

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
@@ -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
+```
+

### Run server with the embedded Raft engine