[incubator-uniffle] branch master updated: Supplement doc about assignment tags (#47)

[ro...@apache.org]

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

roryqi pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/incubator-uniffle.git


The following commit(s) were added to refs/heads/master by this push:
     new 36bd95a  Supplement doc about assignment tags (#47)
36bd95a is described below

commit 36bd95a86afba6b20e8cc3d17c680e1c281c3379
Author: Junfan Zhang <ju...@outlook.com>
AuthorDate: Sun Jul 10 19:14:58 2022 +0800

    Supplement doc about assignment tags (#47)
    
    ### What changes were proposed in this pull request?
    Supplement doc about assignment tags
    
    ### Why are the changes needed?
    Supplement doc about assignment tags
    
    ### Does this PR introduce _any_ user-facing change?
    Yes
    
    ### How was this patch tested?
    No need
---
 README.md            | 2 +-
 docs/client_guide.md | 2 +-
 2 files changed, 2 insertions(+), 2 deletions(-)

diff --git a/README.md b/README.md
index 0ba73ce..7cbdf45 100644
--- a/README.md
+++ b/README.md
@@ -252,7 +252,7 @@ The important configuration is listed as following.
 |rss.server.commit.timeout|600000|Timeout when commit shuffle data (ms)|
 |rss.storage.type|-|Supports MEMORY_LOCALFILE, MEMORY_HDFS, MEMORY_LOCALFILE_HDFS|
 |rss.server.flush.cold.storage.threshold.size|64M| The threshold of data size for LOACALFILE and HDFS if MEMORY_LOCALFILE_HDFS is used|
-
+|rss.server.tags|-|The comma-separated list of tags to indicate the shuffle server's attributes. It will be used as the assignment basis for the coordinator|
 
 ### Shuffle Client
 
diff --git a/docs/client_guide.md b/docs/client_guide.md
index ac0ec10..ba26f3c 100644
--- a/docs/client_guide.md
+++ b/docs/client_guide.md
@@ -86,7 +86,7 @@ These configurations are shared by all types of clients.
 |<client_type>.rss.storage.type|-|Supports MEMORY_LOCALFILE, MEMORY_HDFS, MEMORY_LOCALFILE_HDFS|
 |<client_type>.rss.client.read.buffer.size|14m|The max data size read from storage|
 |<client_type>.rss.client.send.threadPool.size|5|The thread size for send shuffle data to shuffle server|
-
+|<client_type>.rss.client.assignment.tags|-|The comma-separated list of tags for deciding assignment shuffle servers. Notice that the SHUFFLE_SERVER_VERSION will always as the assignment tag whether this conf is set or not|
 Notice:
 
 1. `<client_type>` should be `spark` or `mapreduce`