Skip to content

Commit

Permalink
Update cli.md
Browse files Browse the repository at this point in the history
  • Loading branch information
idellzheng committed Aug 16, 2023
1 parent 74ca5ae commit f3c9be2
Showing 1 changed file with 8 additions and 2 deletions.
10 changes: 8 additions & 2 deletions ratis-docs/src/site/markdown/cli.md
Original file line number Diff line number Diff line change
Expand Up @@ -77,7 +77,7 @@ The following command can be invoked in order to get the basic usage:
$ ratis sh
Usage: ratis sh [generic options]
[election [transfer] [stepDown] [pause] [resume]]
[group [info] [list]]
[group [info] [list] [raftMetaConf]]
[peer [add] [remove] [setPriority]]
[snapshot [create]]
```
Expand Down Expand Up @@ -125,7 +125,7 @@ $ ratis sh election resume -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PO
## group
The `group` command manages ratis groups.
It has the following subcommands:
`info`, `list`
`info`, `list`, `raftMetaConf`
### group info
Display the information of a specific raft group.
Expand All @@ -139,6 +139,12 @@ Display the group information of a specific raft server
$ ratis sh group list -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> [-groupid <RAFT_GROUP_ID>] <[-serverAddress <P0_HOST:P0_PORT>]|[-peerId <peerId0>]>
```
### group raftMetaConf
Generate a new raft-meta.conf file, which is used to move a raft node to a new node
```
$ ratis sh group raftMetaConf -peers <P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path <PARENT_PATH_OF_RAFT_META_CONF>
```
## peer
The `peer` command manages ratis cluster peers.
It has the following subcommands:
Expand Down

0 comments on commit f3c9be2

Please sign in to comment.