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 ab9e203 chore: improve readme (#203)
ab9e203 is described below
commit ab9e203cb4b325c423b61f456883752e2cc1edff
Author: Cancai Cai <[email protected]>
AuthorDate: Mon Sep 23 08:46:16 2024 +0800
chore: improve readme (#203)
---
README.md | 14 +++++++++-----
1 file changed, 9 insertions(+), 5 deletions(-)
diff --git a/README.md b/README.md
index 6837793..0d23fba 100644
--- a/README.md
+++ b/README.md
@@ -15,7 +15,7 @@ Apache Kvrocks Controller is a cluster management tool for
[Apache Kvrocks](http
* Go >= 1.16
-### Build binaries
+### Build binaries
```shell
$ git clone https://github.com/apache/kvrocks-controller
@@ -27,12 +27,12 @@ $ 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 [persistence
interface](https://github.com/apache/kvrocks-controller/blob/unstable/storage/persistence/persistence.go).
+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
+### 1. Run the controller server
```shell
-# Use docker-compose to setup the etcd
+# Use docker-compose to setup the etcd or zookeeper
$ make setup
# Run the controller server
$ ./_build/kvctl-server -c config/config.yaml
@@ -51,7 +51,7 @@ $ ./_build/kvctl create namespace test-ns
# List namespaces
$ ./_build/kvctl list namespaces
-# Create cluster in the namespace
+# Create cluster in the namespace
$ ./_build/kvctl create cluster test-cluster --nodes
127.0.0.1:6666,127.0.0.1:6667 -n test-ns
# List clusters in the namespace
@@ -65,3 +65,7 @@ $ ./_build/kvctl migrate slot 123 --target 1 -n test-ns -c
test-cluster
```
For the HTTP API, you can find the [HTTP API(work in progress)](docs/API.md)
for more details.
+
+## License
+
+Licensed under the [Apache License, Version 2.0](LICENSE)
