Skip to content

Commit

Permalink
Fix some wording about Raft in the README
Browse files Browse the repository at this point in the history
  • Loading branch information
PragmaTwice authored Dec 18, 2024
1 parent 25030c6 commit 9d7d1c9
Showing 1 changed file with 5 additions and 5 deletions.
10 changes: 5 additions & 5 deletions README.md
Original file line number Diff line number Diff line change
Expand Up @@ -43,7 +43,7 @@ $ ./_build/kvctl-server -c config/config.yaml

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

### Run server with the raft embedding engine
### Run server with the embedded Raft engine

> Note: The embedded Raft engine is still in the experimental stage, and it's not recommended to use it in the production environment.
Expand All @@ -62,10 +62,10 @@ raft:
- "http://127.0.0.1:6003"
```
- id: the node id for the raft node, it's also an index in the peers list
- data_dir: the directory to store the raft data
- cluster_state: the state of the raft cluster, it should be `new` when the cluster is initialized. And it should be `existing` when the cluster is already bootstrapped.
- peers: the list of the raft peers, it should include all the nodes in the cluster.
- `id`: the id for the raft node, it's also an index in the `peers` list
- `data_dir`: the directory to store the raft data
- `cluster_state`: the state of the raft cluster, it should be `new` when the cluster is initialized. And it should be `existing` when the cluster is already bootstrapped.
- `peers`: the list of the raft peers, it should include all the nodes in the cluster.

And then you can run the controller server with the configuration file.

Expand Down

0 comments on commit 9d7d1c9

Please sign in to comment.