[incubator-uniffle] branch master updated: [#397] docs: add the usage of AccessQuotaChecker (#692)

[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 8f1dd1fa [#397] docs: add the usage of AccessQuotaChecker (#692)
8f1dd1fa is described below

commit 8f1dd1fac6bacf6604ebf7410d08a205b97d7162
Author: jokercurry <84...@users.noreply.github.com>
AuthorDate: Wed Mar 8 10:52:31 2023 +0800

    [#397] docs: add the usage of AccessQuotaChecker (#692)
    
    ### What changes were proposed in this pull request?
    Add the usage of `AccessQuotaChecker`
    
    ### Why are the changes needed?
    Fix: #397
    
    ### Does this PR introduce _any_ user-facing change?
    No.
    
    ### How was this patch tested?
    No need.
---
 docs/coordinator_guide.md | 12 +++++++++---
 1 file changed, 9 insertions(+), 3 deletions(-)

diff --git a/docs/coordinator_guide.md b/docs/coordinator_guide.md
index d53a5b37..09593f55 100644
--- a/docs/coordinator_guide.md
+++ b/docs/coordinator_guide.md
@@ -102,9 +102,6 @@ This document will introduce how to deploy Uniffle coordinators.
 |rss.coordinator.startup-silent-period.enabled|false|Enable the startup-silent-period to reject the assignment requests for avoiding partial assignments. To avoid service interruption, this mechanism is disabled by default. Especially it's recommended to use in coordinator HA mode when restarting single coordinator.|
 |rss.coordinator.startup-silent-period.duration|20000|The waiting duration(ms) when conf of rss.coordinator.startup-silent-period.enabled is enabled.|
 |rss.coordinator.select.partition.strategy|ROUND|There are two strategies for selecting partitions: ROUND and CONTINUOUS. ROUND will poll to allocate partitions to ShuffleServer, and CONTINUOUS will try to allocate consecutive partitions to ShuffleServer, this feature can improve performance in AQE scenarios.|
-|rss.coordinator.quota.update.interval|60000|Update interval for the default number of submitted apps per user.|
-|rss.coordinator.quota.default.path|-|A configuration file for the number of apps for a user-defined user.|
-|rss.coordinator.quota.default.app.num|5|Default number of apps at user level.|
 |rss.metrics.reporter.class|-|The class of metrics reporter.|
 |rss.reconfigure.interval.sec|5|Reconfigure check interval.|
 
@@ -121,6 +118,15 @@ AccessCandidatesChecker is one of the built-in access checker, which will allow
 |rss.coordinator.access.candidates.updateIntervalSec|120|Accessed candidates update interval in seconds, which is only valid when AccessCandidatesChecker is enabled.|
 |rss.coordinator.access.candidates.path|-|Accessed candidates file path, the file can be stored on HDFS|
 
+### AccessQuotaChecker settings
+AccessQuotaChecker is a checker when the number of concurrent tasks submitted by users increases sharply, some important apps may be affected. Therefore, we restrict users to submit to the uniffle cluster, and rejected apps will be submitted to ESS.
+
+|Property Name|Default|	Description|
+|---|---|---|
+|rss.coordinator.quota.update.interval|60000|Update interval for the default number of submitted apps per user.|
+|rss.coordinator.quota.default.path|-|A configuration file for the number of apps for a user-defined user.|
+|rss.coordinator.quota.default.app.num|5|Default number of apps at user level.|
+
 ### PrometheusPushGatewayMetricReporter settings
 PrometheusPushGatewayMetricReporter is one of the built-in metrics reporter, which will allow user pushes metrics to a [Prometheus Pushgateway](https://github.com/prometheus/pushgateway), which can be scraped by Prometheus.