This is an automated email from the ASF dual-hosted git repository. twice pushed a commit to branch twice/fix-readme in repository https://gitbox.apache.org/repos/asf/kvrocks-controller.git
commit 9d7d1c92d43c5fcaa9c0cd0975d5fb98a1d87142 Author: Twice <[email protected]> AuthorDate: Wed Dec 18 10:20:37 2024 +0800 Fix some wording about Raft in the README --- README.md | 10 +++++----- 1 file changed, 5 insertions(+), 5 deletions(-) diff --git a/README.md b/README.md index 7975b3f..a4a58b7 100644 --- a/README.md +++ b/README.md @@ -43,7 +43,7 @@ $ ./_build/kvctl-server -c config/config.yaml  -### 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. @@ -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.
