This is an automated email from the ASF dual-hosted git repository.
urfree pushed a commit to branch main
in repository https://gitbox.apache.org/repos/asf/pulsar-site.git
The following commit(s) were added to refs/heads/main by this push:
new d44d52ce2da Docs sync done from apache/pulsar (#31fe347)
d44d52ce2da is described below
commit d44d52ce2da44b01e5c99cb2eb71b2c6fcfe6371
Author: github-actions[bot]
<41898282+github-actions[bot]@users.noreply.github.com>
AuthorDate: Fri Feb 3 01:36:15 2023 +0000
Docs sync done from apache/pulsar (#31fe347)
---
.../next/config/reference-configuration-broker.md | 66 ++++++++++++++++++++++
.../config/reference-configuration-standalone.md | 66 ++++++++++++++++++++++
static/reference/next/pulsar-admin/namespaces.md | 2 +-
.../reference/next/pulsar-admin/topicPolicies.md | 4 +-
4 files changed, 135 insertions(+), 3 deletions(-)
diff --git a/static/reference/next/config/reference-configuration-broker.md
b/static/reference/next/config/reference-configuration-broker.md
index 5ad60cd72e5..8a7b4c0f46f 100644
--- a/static/reference/next/config/reference-configuration-broker.md
+++ b/static/reference/next/config/reference-configuration-broker.md
@@ -550,6 +550,17 @@ In FlowOrQpsEquallyDivideBundleSplitAlgorithm, if msgRate
\>= loadBalancerNamesp
**Category**: Load Balancer
+### loadBalanceUnloadDelayInSeconds
+Delay (in seconds) to the next unloading cycle after unloading. The logic
tries to give enough time for brokers to recompute load after unloading. The
bigger value will delay the next unloading cycle longer. (only used in load
balancer extension TransferSheddeer)
+
+**Type**: `long`
+
+**Default**: `600`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerAutoBundleSplitEnabled
enable/disable automatic namespace bundle split
@@ -605,6 +616,28 @@ BandwithOut Resource Usage Weight
**Category**: Load Balancer
+### loadBalancerBrokerLoadDataTTLInSeconds
+Broker load data time to live (TTL in seconds). The logic tries to avoid
(possibly unavailable) brokers with out-dated load data, and those brokers will
be ignored in the load computation. When tuning this value, please consider
loadBalancerReportUpdateMaxIntervalMinutes. The current default is
loadBalancerReportUpdateMaxIntervalMinutes * 2. (only used in load balancer
extension TransferSheddeer)
+
+**Type**: `long`
+
+**Default**: `1800`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
+### loadBalancerBrokerLoadTargetStd
+The target standard deviation of the resource usage across brokers (100%
resource usage is 1.0 load). The shedder logic tries to distribute bundle load
across brokers to meet this target std. The smaller value will incur load
balancing more frequently. (only used in load balancer extension
TransferSheddeer)
+
+**Type**: `double`
+
+**Default**: `0.25`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerBrokerMaxTopics
Usage threshold to allocate max number of topics to broker
@@ -660,6 +693,17 @@ CPU Resource Usage Weight
**Category**: Load Balancer
+### loadBalancerDebugModeEnabled
+Option to enable the debug mode for the load balancer logics. The debug mode
prints more logs to provide more information such as load balance states and
decisions. (only used in load balancer extension logics)
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerDirectMemoryResourceWeight
Direct Memory Resource Usage Weight
@@ -737,6 +781,17 @@ load balance load shedding strategy (It requires broker
restart if value is chan
**Category**: Load Balancer
+### loadBalancerMaxNumberOfBrokerTransfersPerCycle
+Maximum number of brokers to transfer bundle load for each unloading cycle.
The bigger value will incur more unloading/transfers for each unloading cycle.
(only used in load balancer extension TransferSheddeer)
+
+**Type**: `int`
+
+**Default**: `3`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerMemoryResourceWeight
Memory Resource Usage Weight
@@ -915,6 +970,17 @@ Broker periodically checks whether some traffic should be
offload from some over
**Category**: Load Balancer
+### loadBalancerTransferEnabled
+Option to enable the bundle transfer mode when distributing bundle loads. On:
transfer bundles from overloaded brokers to underloaded -- pre-assigns the
destination broker upon unloading). Off: unload bundles from overloaded brokers
-- post-assigns the destination broker upon lookups). (only used in load
balancer extension TransferSheddeer)
+
+**Type**: `boolean`
+
+**Default**: `true`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadManagerClassName
Name of load manager to use
diff --git a/static/reference/next/config/reference-configuration-standalone.md
b/static/reference/next/config/reference-configuration-standalone.md
index 5ad60cd72e5..8a7b4c0f46f 100644
--- a/static/reference/next/config/reference-configuration-standalone.md
+++ b/static/reference/next/config/reference-configuration-standalone.md
@@ -550,6 +550,17 @@ In FlowOrQpsEquallyDivideBundleSplitAlgorithm, if msgRate
\>= loadBalancerNamesp
**Category**: Load Balancer
+### loadBalanceUnloadDelayInSeconds
+Delay (in seconds) to the next unloading cycle after unloading. The logic
tries to give enough time for brokers to recompute load after unloading. The
bigger value will delay the next unloading cycle longer. (only used in load
balancer extension TransferSheddeer)
+
+**Type**: `long`
+
+**Default**: `600`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerAutoBundleSplitEnabled
enable/disable automatic namespace bundle split
@@ -605,6 +616,28 @@ BandwithOut Resource Usage Weight
**Category**: Load Balancer
+### loadBalancerBrokerLoadDataTTLInSeconds
+Broker load data time to live (TTL in seconds). The logic tries to avoid
(possibly unavailable) brokers with out-dated load data, and those brokers will
be ignored in the load computation. When tuning this value, please consider
loadBalancerReportUpdateMaxIntervalMinutes. The current default is
loadBalancerReportUpdateMaxIntervalMinutes * 2. (only used in load balancer
extension TransferSheddeer)
+
+**Type**: `long`
+
+**Default**: `1800`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
+### loadBalancerBrokerLoadTargetStd
+The target standard deviation of the resource usage across brokers (100%
resource usage is 1.0 load). The shedder logic tries to distribute bundle load
across brokers to meet this target std. The smaller value will incur load
balancing more frequently. (only used in load balancer extension
TransferSheddeer)
+
+**Type**: `double`
+
+**Default**: `0.25`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerBrokerMaxTopics
Usage threshold to allocate max number of topics to broker
@@ -660,6 +693,17 @@ CPU Resource Usage Weight
**Category**: Load Balancer
+### loadBalancerDebugModeEnabled
+Option to enable the debug mode for the load balancer logics. The debug mode
prints more logs to provide more information such as load balance states and
decisions. (only used in load balancer extension logics)
+
+**Type**: `boolean`
+
+**Default**: `false`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerDirectMemoryResourceWeight
Direct Memory Resource Usage Weight
@@ -737,6 +781,17 @@ load balance load shedding strategy (It requires broker
restart if value is chan
**Category**: Load Balancer
+### loadBalancerMaxNumberOfBrokerTransfersPerCycle
+Maximum number of brokers to transfer bundle load for each unloading cycle.
The bigger value will incur more unloading/transfers for each unloading cycle.
(only used in load balancer extension TransferSheddeer)
+
+**Type**: `int`
+
+**Default**: `3`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadBalancerMemoryResourceWeight
Memory Resource Usage Weight
@@ -915,6 +970,17 @@ Broker periodically checks whether some traffic should be
offload from some over
**Category**: Load Balancer
+### loadBalancerTransferEnabled
+Option to enable the bundle transfer mode when distributing bundle loads. On:
transfer bundles from overloaded brokers to underloaded -- pre-assigns the
destination broker upon unloading). Off: unload bundles from overloaded brokers
-- post-assigns the destination broker upon lookups). (only used in load
balancer extension TransferSheddeer)
+
+**Type**: `boolean`
+
+**Default**: `true`
+
+**Dynamic**: `true`
+
+**Category**: Load Balancer
+
### loadManagerClassName
Name of load manager to use
diff --git a/static/reference/next/pulsar-admin/namespaces.md
b/static/reference/next/pulsar-admin/namespaces.md
index 949be7b429d..d39ebe34986 100644
--- a/static/reference/next/pulsar-admin/namespaces.md
+++ b/static/reference/next/pulsar-admin/namespaces.md
@@ -359,7 +359,7 @@ $ pulsar-admin namespaces set-backlog-quota options
|---|---|---|
| `-lt, --limitTime` | Time limit in second (or minutes, hours, days, weeks
eg: 100m, 3h, 2d, 5w), non-positive number for disabling time limit.|null||
| `-l, --limit` | Size limit (eg: 10M, 16G)|null||
-| `-t, --type` | Backlog quota type to set. Valid options are:
destination_storage and message_age. destination_storage limits backlog by size
(in bytes). message_age limits backlog by time, that is, message timestamp
(broker or publish timestamp). You can set size or time to control the backlog,
or combine them together to control the backlog. |destination_storage||
+| `-t, --type` | Backlog quota type to set. Valid options are:
destination_storage (default) and message_age. destination_storage limits
backlog by size. message_age limits backlog by time, that is, message timestamp
(broker or publish timestamp). You can set size or time to control the backlog,
or combine them together to control the backlog. |destination_storage||
| `-p, --policy` | Retention policy to enforce when the limit is reached.
Valid options are: [producer_request_hold, producer_exception,
consumer_backlog_eviction]|null||
diff --git a/static/reference/next/pulsar-admin/topicPolicies.md
b/static/reference/next/pulsar-admin/topicPolicies.md
index 0cfd9c56d49..abf4036ab12 100644
--- a/static/reference/next/pulsar-admin/topicPolicies.md
+++ b/static/reference/next/pulsar-admin/topicPolicies.md
@@ -305,11 +305,11 @@ $ pulsar-admin topicPolicies set-backlog-quota options
|Flag|Description|Default|
|---|---|---|
-| `-t, --type` | Backlog quota type to set. Valid options are:
destination_storage and message_age. destination_storage limits backlog by size
(in bytes). message_age limits backlog by time, that is, message timestamp
(broker or publish timestamp). You can set size or time to control the backlog,
or combine them together to control the backlog. |destination_storage||
+| `-t, --type` | Backlog quota type to set. Valid options are:
destination_storage (default) and message_age. destination_storage limits
backlog by size. message_age limits backlog by time, that is, message timestamp
(broker or publish timestamp). You can set size or time to control the backlog,
or combine them together to control the backlog. |destination_storage||
| `-p, --policy` | Retention policy to enforce when the limit is reached.
Valid options are: [producer_request_hold, producer_exception,
consumer_backlog_eviction]|null||
| `-lt, --limitTime` | Time limit in second (or minutes, hours, days, weeks
eg: 100m, 3h, 2d, 5w), non-positive number for disabling time limit.|null||
| `--global, -g` | Whether to set this policy globally. If set to true, the
policy will be replicate to other clusters asynchronously|false||
-| `-l, --limit` | Size limit (eg: 10M, 16G)|-1||
+| `-l, --limit` | Size limit (eg: 10M, 16G)|null||
## <em>remove-backlog-quota</em>
