[incubator-celeborn] branch branch-0.3 updated: [CELEBORN-623][DOCS] Document how to change RPC type in `celeborn-ratis`

[ch...@apache.org]

This is an automated email from the ASF dual-hosted git repository.

chengpan pushed a commit to branch branch-0.3
in repository https://gitbox.apache.org/repos/asf/incubator-celeborn.git


The following commit(s) were added to refs/heads/branch-0.3 by this push:
     new 593bf269c [CELEBORN-623][DOCS] Document how to change RPC type in `celeborn-ratis`
593bf269c is described below

commit 593bf269c939ce55c8e4fdd4c28163ead225606c
Author: liyihe <li...@bigo.sg>
AuthorDate: Fri Jun 2 20:23:09 2023 +0800

    [CELEBORN-623][DOCS] Document how to change RPC type in `celeborn-ratis`
    
    ### What changes were proposed in this pull request?
    Ratis-shell use GRPC by default. Celeborn support Netty for ratis, if `raft.rpc.type` is not specified, commands may fail.
    e.g.
    ```
    org.apache.ratis.thirdparty.io.grpc.StatusRuntimeException: DEADLINE_EXCEEDED: deadline exceeded after 14.947369960s. [closed=[], open=[[buffered_nanos=14962358255, waiting_for_connection]]]
    ```
    So I think we should update the document to mention how to change the RPC type to in `celeborn-ratis`.
    
    ### Why are the changes needed?
    
    Improve user experience
    
    ### Does this PR introduce _any_ user-facing change?
    No
    
    ### How was this patch tested?
    Manually test
    
    Closes #1530 from onebox-li/ratis-shell-default-rpc.
    
    Lead-authored-by: liyihe <li...@bigo.sg>
    Co-authored-by: Cheng Pan <pa...@gmail.com>
    Signed-off-by: Cheng Pan <ch...@apache.org>
    (cherry picked from commit 188b0697107fd7f2237eae973e3e54bfcd3dc134)
    Signed-off-by: Cheng Pan <ch...@apache.org>
---
 docs/celeborn_ratis_shell.md | 2 ++
 1 file changed, 2 insertions(+)

diff --git a/docs/celeborn_ratis_shell.md b/docs/celeborn_ratis_shell.md
index 865dcd7ef..4287dfa17 100644
--- a/docs/celeborn_ratis_shell.md
+++ b/docs/celeborn_ratis_shell.md
@@ -71,6 +71,8 @@ It support the following content:
 $ celeborn-ratis sh -D<property=value> ...
 ```
 
+For example: use `-Draft.rpc.type=NETTY` to set the RPC type of Ratis to Netty, the default is gRPC.
+
 ## election
 The `election` command manages leader election.
 It has the following subcommands: