Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Jump to bottom

[Doc] Update Replication configurations (backport #52009) #52016

Merged
merged 1 commit into from
Oct 17, 2024
Merged

[Doc] Update Replication configurations (backport #52009) #52016

Show file tree
Hide file tree
Changes from all commits
Commits
Show all changes
1 commit
Select commit
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
2 changes: 1 addition & 1 deletion docs/en/administration/data_migration_tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ The following FE parameters are dynamic configuration items. Refer to [Configure

#### BE Parameters

The following BE parameter is a dynamic configuration item. Refer to [Configure BE Dynamic Parameters](../administration/management/BE_configuration.md#configure-be-dynamic-parameters) on how to modify it.
The following BE parameter is a dynamic configuration item. Refer to [Configure BE Dynamic Parameters](../administration/management/BE_configuration.md) on how to modify it.

| **Parameter** | **Default** | **Unit** | **Description** |
| ------------------- | ----------- | -------- | ------------------------------------------------------------ |
Expand Down
38 changes: 30 additions & 8 deletions docs/en/administration/management/BE_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -720,27 +720,49 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- Description: The time interval at which to monitor health status of disks.
- Introduced in: -

<!--
##### replication_threads

- Default: 0
- Type: Int
- Unit: -
- Is mutable: Yes
- Description:
- Introduced in: -
-->
- Description: The maximum number of threads used for replication. `0` indicates setting the thread number to four times the BE CPU core count.
- Introduced in: v3.3.5

##### replication_max_speed_limit_kbps

- Default: 50000
- Type: Int
- Unit: KB/s
- Is mutable: Yes
- Description: The maximum speed of each replication thread.
- Introduced in: v3.3.5

##### replication_min_speed_limit_kbps

- Default: 50
- Type: Int
- Unit: KB/s
- Is mutable: Yes
- Description: The minimum speed of each replication thread.
- Introduced in: v3.3.5
##### replication_min_speed_time_seconds

- Default: 300
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description: The time duration allowed for a replication thread to be under the minimum speed. Replication will fail if the time when the actual speed is lower than `replication_min_speed_limit_kbps` exceeds this value.
- Introduced in: v3.3.5

<!--
##### clear_expired_replication_snapshots_interval_seconds

- Default: 3600
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description:
- Introduced in: -
-->
- Description: The time interval at which the system clears the expired snapshots left by abnormal replications.
- Introduced in: v3.3.5

##### unused_rowset_monitor_interval

Expand Down
42 changes: 27 additions & 15 deletions docs/en/administration/management/FE_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4864,38 +4864,50 @@ ADMIN SET FRONTEND CONFIG ("key" = "value");
- Introduced in: -
-->

<!--
##### replication_interval_ms

- Default: 100
- Type: Int
- Unit: -
- Is mutable: No
- Description: The minimum time interval at which the replication tasks are scheduled.
- Introduced in: v3.3.5

##### replication_max_parallel_table_count

- Default: 100
- Type: Int
- Unit:
- Unit: -
- Is mutable: Yes
- Description:
- Introduced in: -
-->
- Description: The maximum number of concurrent data synchronization tasks allowed. StarRocks creates one synchronization task for each table.
- Introduced in: v3.3.5

<!--
##### replication_max_parallel_data_size_mb
##### replication_max_parallel_replica_count

- Default: 10240
- Type: Int
- Unit: -
- Is mutable: Yes
- Description: The maximum number of tablet replicas allowed for concurrent synchronization.
- Introduced in: v3.3.5

##### replication_max_parallel_data_size_mb

- Default: 1048576
- Type: Int
- Unit: MB
- Is mutable: Yes
- Description:
- Introduced in: -
-->
- Description: The maximum size of data allowed for concurrent synchronization.
- Introduced in: v3.3.5

<!--
##### replication_transaction_timeout_sec

- Default: 24 * 60 * 60
- Default: 86400
- Type: Int
- Unit: Seconds
- Is mutable: Yes
- Description:
- Introduced in: -
-->
- Description: The timeout duration for synchronization tasks.
- Introduced in: v3.3.5

##### jdbc_meta_default_cache_enable

Expand Down
2 changes: 1 addition & 1 deletion docs/zh/administration/data_migration_tool.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -100,7 +100,7 @@ ADMIN SET FRONTEND CONFIG("lake_compaction_max_tasks"="-1");

#### BE 参数

以下 BE 参数为动态参数。修改方式请参考 [配置 BE 动态参数](../administration/management/BE_configuration.md#配置-be-动态参数)。
以下 BE 参数为动态参数。修改方式请参考 [配置 BE 动态参数](../administration/management/BE_configuration.md)。

| **参数名** | **默认值** | **单位** | **描述** |
| ------------------- | ---------- | -------- | ------------------------------------------------------------ |
Expand Down
41 changes: 32 additions & 9 deletions docs/zh/administration/management/BE_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -716,27 +716,50 @@ curl http://<BE_IP>:<BE_HTTP_PORT>/varz
- 描述：磁盘健康状态检测的间隔。
- 引入版本：-

<!--
##### replication_threads

- 默认值：0
- 类型：Int
- 单位：-
- 是否动态：是
- 描述：
- 引入版本：-
-->
- 描述：用于同步的最大线程数。0 表示将线程数设置为 BE CPU 内核数的四倍。
- 引入版本：v3.3.5

<!--
##### clear_expired_replcation_snapshots_interval_seconds
##### replication_max_speed_limit_kbps

- 默认值：50000
- 类型：Int
- 单位：KB/s
- 是否动态：是
- 描述：每个同步线程的最大速度。
- 引入版本：v3.3.5

##### replication_min_speed_limit_kbps

- 默认值：50
- 类型：Int
- 单位：KB/s
- 是否动态：是
- 描述：每个同步线程的最小速度。
- 引入版本：v3.3.5

##### replication_min_speed_time_seconds

- 默认值：300
- 类型：Int
- 单位：Seconds
- 是否动态：是
- 描述：同步线程低于最低速度所允许的持续时间。如果实际速度低于 `replication_min_speed_limit_kbps` 的时间超过此值，同步将失败。
- 引入版本：v3.3.5

##### clear_expired_replication_snapshots_interval_seconds

- 默认值：3600
- 类型：Int
- 单位：Seconds
- 是否动态：是
- 描述：
- 引入版本：-
-->
- 描述：系统清除异常同步遗留的过期快照的时间间隔。
- 引入版本：v3.3.5

##### unused_rowset_monitor_interval

Expand Down
42 changes: 27 additions & 15 deletions docs/zh/administration/management/FE_configuration.md
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -4859,38 +4859,50 @@ Compaction Score 代表了一个表分区是否值得进行 Compaction 的评分
- 引入版本：-
-->

<!--
##### replication_interval_ms

- 默认值：100
- 类型：Int
- 单位：-
- 是否动态：否
- 描述：调度执行同步任务的最小时间间隔。
- 引入版本：v3.3.5

##### replication_max_parallel_table_count

- 默认值：100
- 类型：Int
- Unit:
- 单位：-
- 是否动态：是
- 描述：
- 引入版本：-
-->
- 描述：允许并发执行的数据同步任务数。StarRocks 为一张表创建一个同步任务。
- 引入版本：v3.3.5

<!--
##### replication_max_parallel_data_size_mb
##### replication_max_parallel_replica_count

- 默认值：10240
- 类型：Int
- 单位：-
- 是否动态：是
- 描述：允许并发同步的 Tablet 副本数。
- 引入版本：v3.3.5

##### replication_max_parallel_data_size_mb

- 默认值：1048576
- 类型：Int
- 单位：MB
- 是否动态：是
- 描述：
- 引入版本：-
-->
- 描述：允许并发同步的数据量。
- 引入版本：v3.3.5

<!--
##### replication_transaction_timeout_sec

- 默认值：24 * 60 * 60
- 默认值：86400
- 类型：Int
- 单位：Seconds
- 是否动态：是
- 描述：
- 引入版本：-
-->
- 描述：同步任务的超时时间。
- 引入版本：v3.3.5

##### jdbc_meta_default_cache_enable

Expand Down
Loading