This is an automated email from the ASF dual-hosted git repository.
ethanfeng pushed a commit to branch branch-0.5
in repository https://gitbox.apache.org/repos/asf/celeborn.git
The following commit(s) were added to refs/heads/branch-0.5 by this push:
new aa3a8c03f [CELEBORN-1466] Add local command in celeborn_ratis_shell.md
aa3a8c03f is described below
commit aa3a8c03f595cdd8d40bd8fb1992cf2b8e0df74d
Author: SteNicholas <[email protected]>
AuthorDate: Wed Jun 19 14:13:04 2024 +0800
[CELEBORN-1466] Add local command in celeborn_ratis_shell.md
### What changes were proposed in this pull request?
Add `local` command in `celeborn_ratis_shell.md` to sync document
[cli.md](https://github.com/apache/ratis/blob/ratis-3.0.1/ratis-docs/src/site/markdown/cli.md).
### Why are the changes needed?
Celeborn has already bumped Ratis version from 2.5.1 to 3.0.1. Ratis v3.0.1
supports `local` command to process local operation, which no need to connect
to ratis server. `celeborn_ratis_shell.md` should add local command to guide
users to process local operation.
Backport: https://github.com/apache/ratis/pull/901
### Does this PR introduce _any_ user-facing change?
No.
### How was this patch tested?
No.
Closes #2575 from SteNicholas/CELEBORN-1466.
Authored-by: SteNicholas <[email protected]>
Signed-off-by: mingji <[email protected]>
(cherry picked from commit e4d3b8020c841cea8ca2c7e8bf6b70d133df11ad)
Signed-off-by: mingji <[email protected]>
---
docs/celeborn_ratis_shell.md | 12 ++++++++++++
1 file changed, 12 insertions(+)
diff --git a/docs/celeborn_ratis_shell.md b/docs/celeborn_ratis_shell.md
index 6576a51b3..0d0565997 100644
--- a/docs/celeborn_ratis_shell.md
+++ b/docs/celeborn_ratis_shell.md
@@ -61,6 +61,7 @@ Usage: celeborn-ratis sh [generic options]
[group [info] [list]]
[peer [add] [remove] [setPriority]]
[snapshot [create]]
+ [local [raftMetaConf]]
```
## generic options
@@ -156,3 +157,14 @@ Trigger the specified server take snapshot.
```
$ celeborn-ratis sh snapshot create -peers
<P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -peerId <peerId0> [-groupid
<RAFT_GROUP_ID>]
```
+
+## local
+The `local` command is used to process local operation, which no need to
connect to ratis server.
+It has the following subcommands:
+`raftMetaConf`
+
+### local raftMetaConf
+Generate a new raft-meta.conf file based on original raft-meta.conf and new
peers, which is used to move a raft node to a new node.
+```
+$ celeborn-ratis sh local raftMetaConf -peers
<P0_HOST:P0_PORT,P1_HOST:P1_PORT,P2_HOST:P2_PORT> -path
<PARENT_PATH_OF_RAFT_META_CONF>
+```
