update workload group docs about create and alter, show

Author: Doris-Extras

docs/sql-manual/sql-statements/cluster-management/compute-management/ALTER-WORKLOAD-GROUP.md

@@ -23,14 +23,7 @@ PROPERTIES (
 
 1.`<property>`
 
-`<property>` 格式为 `<key>` = `<value>`，`<key>`的具体可选值如下：
-
-| Parameter | Description | Required |
-| -- | -- | -- |
-| `<cpu_share>` | used to set how much cpu time the workload group can acquire, which can achieve soft isolation of cpu resources. cpu_share is a relative value indicating the weight of cpu resources available to the running workload group. For example, if a user creates 3 workload groups rg-a, rg-b and rg-c with cpu_share of 10, 30 and 40 respectively, and at a certain moment rg-a and rg-b are running tasks while rg-c has no tasks, then rg-a can get (10 / (10 + 30)) = 25% of the cpu resources while workload group rg-b can get 75% of the cpu resources. If the system has only one workload group running, it gets all the cpu resources regardless of the value of its cpu_share. | Y |
-| `<memory_limit>` | set the percentage of be memory that can be used by the workload group. The absolute value of the workload group memory limit is: `physical_memory * mem_limit * memory_limit`, where mem_limit is a be configuration item. The total memory_limit of all workload groups in the system must not exceed 100%. Workload groups are guaranteed to use the memory_limit for the tasks in the group in most cases. When the workload group memory usage exceeds this limit, tasks in the group with larger memory usage may be canceled to release the excess memory, refer to enable_memory_overcommit. | Y |
-| `<enable_memory_overcommit>` | enable soft memory isolation for the workload group, default is false. if set to false, the workload group is hard memory isolated and the tasks with the largest memory usage will be canceled immediately after the workload group memory usage exceeds the limit to release the excess memory. if set to true, the workload group is hard memory isolated and the tasks with the largest memory usage will be canceled immediately after the workload group memory usage exceeds the limit to release the excess memory. if set to true, the workload group is softly isolated, if the system has free memory resources, the workload group can continue to use system memory after exceeding the memory_limit limit, and when the total system memory is tight, it will cancel several tasks in the group with the largest memory occupation, releasing part of the excess memory to relieve the system memory pressure. It is recommended that when this configuration is enabled for a workload group, the total memory_limit of all workload groups should be less than 100%, and the remaining portion should be used for workload group memory overcommit. | Y |
-
+`<property>` format is `<key>` = `<value>`，`<key>`'s specific optional values can be referred to [workload group](../../../../admin-manual/workload-management/workload-group.md).
 
 ## Examples
 
@@ -39,7 +32,7 @@ PROPERTIES (
     ```sql
     alter workload group g1
     properties (
-        "cpu_share"="30",
-        "memory_limit"="30%"
+        "max_cpu_percent"="20%",
+        "max_memory_percent"="40%"
     );
     ```

docs/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-GROUP.md

@@ -23,13 +23,7 @@ PROPERTIES (
 
 1.`<property>`
 
-`<property>` 格式为 `<key>` = `<value>`，`<key>`的具体可选值如下：
-
-| Parameter | Description | Required |
-| -- | -- | -- |
-| `<cpu_share>` | used to set how much cpu time the workload group can acquire, which can achieve soft isolation of cpu resources. cpu_share is a relative value indicating the weight of cpu resources available to the running workload group. For example, if a user creates 3 workload groups rg-a, rg-b and rg-c with cpu_share of 10, 30 and 40 respectively, and at a certain moment rg-a and rg-b are running tasks while rg-c has no tasks, then rg-a can get (10 / (10 + 30)) = 25% of the cpu resources while workload group rg-b can get 75% of the cpu resources. If the system has only one workload group running, it gets all the cpu resources regardless of the value of its cpu_share. | Y |
-| `<memory_limit>` | set the percentage of be memory that can be used by the workload group. The absolute value of the workload group memory limit is: `physical_memory * mem_limit * memory_limit`, where mem_limit is a be configuration item. The total memory_limit of all workload groups in the system must not exceed 100%. Workload groups are guaranteed to use the memory_limit for the tasks in the group in most cases. When the workload group memory usage exceeds this limit, tasks in the group with larger memory usage may be canceled to release the excess memory, refer to enable_memory_overcommit. | Y |
-| `<enable_memory_overcommit>` | enable soft memory isolation for the workload group, default is false. if set to false, the workload group is hard memory isolated and the tasks with the largest memory usage will be canceled immediately after the workload group memory usage exceeds the limit to release the excess memory. if set to true, the workload group is hard memory isolated and the tasks with the largest memory usage will be canceled immediately after the workload group memory usage exceeds the limit to release the excess memory. if set to true, the workload group is softly isolated, if the system has free memory resources, the workload group can continue to use system memory after exceeding the memory_limit limit, and when the total system memory is tight, it will cancel several tasks in the group with the largest memory occupation, releasing part of the excess memory to relieve the system memory pressure. It is recommended that when this configuration is enabled for a workload group, the total memory_limit of all workload groups should be less than 100%, and the remaining portion should be used for workload group memory overcommit. | Y |
+`<property>` format is `<key>` = `<value>`，`<key>`'s specific optional values can be referred to [workload group](../../../../admin-manual/workload-management/workload-group.md).
 
 
 ## Examples
@@ -39,8 +33,7 @@ PROPERTIES (
    ```sql
     create workload group if not exists g1
     properties (
-        "cpu_share"="10",
-        "memory_limit"="30%",
-        "enable_memory_overcommit"="true"
+        "max_cpu_percent"="10%",
+        "max_memory_percent"="30%"
     );
    ```

docs/sql-manual/sql-statements/cluster-management/compute-management/SHOW-WORKLOAD-GROUPS.md

@@ -24,27 +24,74 @@ This statement only does a simple display of workload groups, for a more complex
 1. Show all workload groups:
 
     ```sql
-    mysql> show workload groups;
-    +----------+--------+--------------------------+---------+
-    | Id       | Name   | Item                     | Value   |
-    +----------+--------+--------------------------+---------+
-    | 10343386 | normal | cpu_share                | 10      |
-    | 10343386 | normal | memory_limit             | 30%     |
-    | 10343386 | normal | enable_memory_overcommit | true    |
-    | 10352416 | g1     | memory_limit             | 20%     |
-    | 10352416 | g1     | cpu_share                | 10      |
-    +----------+--------+--------------------------+---------+
+mysql> show workload groups \G;
+*************************** 1. row ***************************
+                          Id: 1754728930516
+                        Name: normal
+             min_cpu_percent: 20%
+             max_cpu_percent: 30%
+          min_memory_percent: 0%
+          max_memory_percent: 50%
+             max_concurrency: 1
+              max_queue_size: 1
+               queue_timeout: 0
+             scan_thread_num: 16
+  max_remote_scan_thread_num: -1
+  min_remote_scan_thread_num: -1
+        memory_low_watermark: 75%
+       memory_high_watermark: 85%
+               compute_group: default
+       read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+          slot_memory_policy: none
+           running_query_num: 0
+           waiting_query_num: 0
+*************************** 2. row ***************************
+                          Id: 1754740507946
+                        Name: test_group2
+             min_cpu_percent: 10%
+             max_cpu_percent: 30%
+          min_memory_percent: 0%
+          max_memory_percent: 3%
+             max_concurrency: 2147483647
+              max_queue_size: 0
+               queue_timeout: 0
+             scan_thread_num: -1
+  max_remote_scan_thread_num: -1
+  min_remote_scan_thread_num: -1
+        memory_low_watermark: 75%
+       memory_high_watermark: 85%
+               compute_group: default
+       read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+          slot_memory_policy: none
+           running_query_num: 0
+           waiting_query_num: 0
     ```
 
 2. Show workload groups using pattern
 
     ```sql
-    mysql> show workload groups like "normal%";
-    +----------+--------+--------------------------+---------+
-    | Id       | Name   | Item                     | Value   |
-    +----------+--------+--------------------------+---------+
-    | 10343386 | normal | cpu_share                | 10      |
-    | 10343386 | normal | memory_limit             | 30%     |
-    | 10343386 | normal | enable_memory_overcommit | true    |
-    +----------+--------+--------------------------+---------+
+mysql> show workload groups like "normal%" \G;
+*************************** 1. row ***************************
+                          Id: 1754728930516
+                        Name: normal
+             min_cpu_percent: 20%
+             max_cpu_percent: 30%
+          min_memory_percent: 0%
+          max_memory_percent: 50%
+             max_concurrency: 1
+              max_queue_size: 1
+               queue_timeout: 0
+             scan_thread_num: 16
+  max_remote_scan_thread_num: -1
+  min_remote_scan_thread_num: -1
+        memory_low_watermark: 75%
+       memory_high_watermark: 85%
+               compute_group: default
+       read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+          slot_memory_policy: none
+           running_query_num: 0
+           waiting_query_num: 0
     ```

i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/ALTER-WORKLOAD-GROUP.md

@@ -23,13 +23,8 @@ PROPERTIES (
 
 1.`<property>`
 
-`<property>` 格式为 `<key>` = `<value>`，`<key>`的具体可选值如下：
+`<property>` 格式为 `<key>` = `<value>`，`<key>`的具体可选值可以参考[workload group](../../../../admin-manual/workload-management/workload-group.md).
 
-| 参数 | 说明 | 是否必填 |
-| -- | -- | -- |
-| `<cpu_share>` | 用于设置资源组获取 cpu 时间的多少，可以实现 cpu 资源软隔离。cpu_share 是相对值，表示正在运行的资源组可获取 cpu 资源的权重。例如，用户创建了 3 个资源组 rg-a、rg-b 和 rg-c，cpu_share 分别为 10、30、40，某一时刻 rg-a 和 rg-b 正在跑任务，而 rg-c 没有任务，此时 rg-a 可获得 (10 / (10 + 30)) = 25% 的 cpu 资源，而资源组 rg-b 可获得 75% 的 cpu 资源。如果系统只有一个资源组正在运行，则不管其 cpu_share 的值为多少，它都可以获取全部的 cpu 资源。 | 是 |
-| `<memory_limit>` | 用于设置资源组可以使用 be 内存的百分比。资源组内存限制的绝对值为：`物理内存 * mem_limit * memory_limit`，其中 mem_limit 为 be 配置项。系统所有资源组的 memory_limit 总合不可超过 100%。资源组在绝大多数情况下保证组内任务可使用 memory_limit 的内存，当资源组内存使用超出该限制后，组内内存占用较大的任务可能会被 cancel 以释放超出的内存，参考 enable_memory_overcommit。 | 是 |
-| `<enable_memory_overcommit>` | 用于开启资源组内存软隔离，默认为 false。如果设置为 false，则该资源组为内存硬隔离，系统检测到资源组内存使用超出限制后将立即 cancel 组内内存占用最大的若干个任务，以释放超出的内存；如果设置为 true，则该资源组为内存软隔离，如果系统有空闲内存资源则该资源组在超出 memory_limit 的限制后可继续使用系统内存，在系统总内存紧张时会 cancel 组内内存占用最大的若干个任务，释放部分超出的内存以缓解系统内存压力。建议在有资源组开启该配置时，所有资源组的 memory_limit 总和低于 100%，剩余部分用于资源组内存超发。 | 否 |
 
 ## 示例
 
@@ -38,7 +33,7 @@ PROPERTIES (
     ```sql
     alter workload group g1
     properties (
-        "cpu_share"="30",
-        "memory_limit"="30%"
+        "max_cpu_percent"="20%",
+        "max_memory_percent"="40%"
     );
     ```

i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/CREATE-WORKLOAD-GROUP.md

@@ -23,13 +23,8 @@ PROPERTIES (
 
 1.`<property>`
 
-`<property>` 格式为 `<key>` = `<value>`，`<key>`的具体可选值如下：
+`<property>` 格式为 `<key>` = `<value>`，`<key>`的具体可选值可以参考[workload group](../../../../admin-manual/workload-management/workload-group.md).
 
-| 参数 | 说明 | 是否必填 |
-| -- | -- | -- |
-| `<cpu_share>` | 用于设置资源组获取 cpu 时间的多少，可以实现 cpu 资源软隔离。cpu_share 是相对值，表示正在运行的资源组可获取 cpu 资源的权重。例如，用户创建了 3 个资源组 rg-a、rg-b 和 rg-c，cpu_share 分别为 10、30、40，某一时刻 rg-a 和 rg-b 正在跑任务，而 rg-c 没有任务，此时 rg-a 可获得 (10 / (10 + 30)) = 25% 的 cpu 资源，而资源组 rg-b 可获得 75% 的 cpu 资源。如果系统只有一个资源组正在运行，则不管其 cpu_share 的值为多少，它都可以获取全部的 cpu 资源。 | 是 |
-| `<memory_limit>` | 用于设置资源组可以使用 be 内存的百分比。资源组内存限制的绝对值为：`物理内存 * mem_limit * memory_limit`，其中 mem_limit 为 be 配置项。系统所有资源组的 memory_limit 总合不可超过 100%。资源组在绝大多数情况下保证组内任务可使用 memory_limit 的内存，当资源组内存使用超出该限制后，组内内存占用较大的任务可能会被 cancel 以释放超出的内存，参考 enable_memory_overcommit。 | 是 |
-| `<enable_memory_overcommit>` | 用于开启资源组内存软隔离，默认为 false。如果设置为 false，则该资源组为内存硬隔离，系统检测到资源组内存使用超出限制后将立即 cancel 组内内存占用最大的若干个任务，以释放超出的内存；如果设置为 true，则该资源组为内存软隔离，如果系统有空闲内存资源则该资源组在超出 memory_limit 的限制后可继续使用系统内存，在系统总内存紧张时会 cancel 组内内存占用最大的若干个任务，释放部分超出的内存以缓解系统内存压力。建议在有资源组开启该配置时，所有资源组的 memory_limit 总和低于 100%，剩余部分用于资源组内存超发。 | 否 |
 
 
 ## 示例
@@ -39,8 +34,7 @@ PROPERTIES (
    ```sql
     create workload group if not exists g1
     properties (
-        "cpu_share"="10",
-        "memory_limit"="30%",
-        "enable_memory_overcommit"="true"
+        "max_cpu_percent"="10%",
+        "max_memory_percent"="30%"
     );
    ```

i18n/zh-CN/docusaurus-plugin-content-docs/current/sql-manual/sql-statements/cluster-management/compute-management/SHOW-WORKLOAD-GROUPS.md

@@ -26,27 +26,75 @@ SHOW WORKLOAD GROUPS [LIKE "<pattern>"];
 1. 展示所有资源组：
 
     ```sql
-    mysql> show workload groups;
-    +----------+--------+--------------------------+---------+
-    | Id       | Name   | Item                     | Value   |
-    +----------+--------+--------------------------+---------+
-    | 10343386 | normal | cpu_share                | 10      |
-    | 10343386 | normal | memory_limit             | 30%     |
-    | 10343386 | normal | enable_memory_overcommit | true    |
-    | 10352416 | g1     | memory_limit             | 20%     |
-    | 10352416 | g1     | cpu_share                | 10      |
-    +----------+--------+--------------------------+---------+
+mysql> show workload groups \G;
+*************************** 1. row ***************************
+                          Id: 1754728930516
+                        Name: normal
+             min_cpu_percent: 20%
+             max_cpu_percent: 30%
+          min_memory_percent: 0%
+          max_memory_percent: 50%
+             max_concurrency: 1
+              max_queue_size: 1
+               queue_timeout: 0
+             scan_thread_num: 16
+  max_remote_scan_thread_num: -1
+  min_remote_scan_thread_num: -1
+        memory_low_watermark: 75%
+       memory_high_watermark: 85%
+               compute_group: default
+       read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+          slot_memory_policy: none
+           running_query_num: 0
+           waiting_query_num: 0
+*************************** 2. row ***************************
+                          Id: 1754740507946
+                        Name: test_group2
+             min_cpu_percent: 10%
+             max_cpu_percent: 30%
+          min_memory_percent: 0%
+          max_memory_percent: 3%
+             max_concurrency: 2147483647
+              max_queue_size: 0
+               queue_timeout: 0
+             scan_thread_num: -1
+  max_remote_scan_thread_num: -1
+  min_remote_scan_thread_num: -1
+        memory_low_watermark: 75%
+       memory_high_watermark: 85%
+               compute_group: default
+       read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+          slot_memory_policy: none
+           running_query_num: 0
+           waiting_query_num: 0
     ```
 
 2. 使用 LIKE 模糊匹配：
 
+
     ```sql
-    mysql> show workload groups like "normal%"
-    +----------+--------+--------------------------+---------+
-    | Id       | Name   | Item                     | Value   |
-    +----------+--------+--------------------------+---------+
-    | 10343386 | normal | cpu_share                | 10      |
-    | 10343386 | normal | memory_limit             | 30%     |
-    | 10343386 | normal | enable_memory_overcommit | true    |
-    +----------+--------+--------------------------+---------+
+mysql> show workload groups like "normal%" \G;
+*************************** 1. row ***************************
+                          Id: 1754728930516
+                        Name: normal
+             min_cpu_percent: 20%
+             max_cpu_percent: 30%
+          min_memory_percent: 0%
+          max_memory_percent: 50%
+             max_concurrency: 1
+              max_queue_size: 1
+               queue_timeout: 0
+             scan_thread_num: 16
+  max_remote_scan_thread_num: -1
+  min_remote_scan_thread_num: -1
+        memory_low_watermark: 75%
+       memory_high_watermark: 85%
+               compute_group: default
+       read_bytes_per_second: -1
+remote_read_bytes_per_second: -1
+          slot_memory_policy: none
+           running_query_num: 0
+           waiting_query_num: 0
     ```