Skip to content

Commit 8af8aba

Browse files
authored
Add docker instructions to README (#261)
1 parent 29bd95a commit 8af8aba

File tree

1 file changed

+12
-10
lines changed

1 file changed

+12
-10
lines changed

README.md

Lines changed: 12 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -9,11 +9,7 @@ Apache Kvrocks Controller is a cluster management tool for [Apache Kvrocks](http
99
* Manage many clusters in one controller cluster
1010
* Support multi metadata storages like etcd and so on
1111

12-
## Build and Running
13-
14-
### Requirements
15-
16-
* Go >= 1.19
12+
## Building and Running
1713

1814
### Build binaries
1915

@@ -22,16 +18,16 @@ $ git clone https://github.com/apache/kvrocks-controller
2218
$ cd kvrocks-controller
2319
$ make # You can find the binary file in the `_build` dir if all goes good
2420
```
21+
2522
### Overview
2623
![image](docs/images/overview.png)
2724
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).
2825

2926
### Supported Storage Engine
30-
31-
- [x] ETCD
32-
- [x] Zookeeper
33-
- [x] Consul by HashiCorp
34-
- [x] Embedded Storage based on Raft (experimental)
27+
- ETCD
28+
- Zookeeper
29+
- Consul by HashiCorp
30+
- Embedded Raft storage (experimental)
3531

3632
### Run the controller server
3733

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

41+
### Run the controller server in Docker
42+
43+
```shell
44+
$ docker run -it -p 9379:9379 apache/kvrocks-controller:latest
45+
```
46+
4547
![image](docs/images/server.gif)
4648

4749
### Run server with the embedded Raft engine

0 commit comments

Comments
 (0)