Skip to content

Commit 3ba897a

Browse files
authored
docs: use "node count" or "number of nodes" instead of "node number" (#24360)
1 parent f0af0e2 commit 3ba897a

10 files changed

Lines changed: 27 additions & 27 deletions

‎functions-and-operators/group-by-modifier.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -44,7 +44,7 @@ Before v8.3.0, TiDB only supports generating valid execution plans for the `WITH
4444

4545
<CustomContent platform="tidb-cloud">
4646

47-
Before v8.3.0, TiDB only supports generating valid execution plans for the `WITH ROLLUP` syntax in [TiFlash MPP mode](/tiflash/use-tiflash-mpp-mode.md). Therefore, your TiDB cluster needs to contain TiFlash nodes, and the target table must be configured with the correct TiFlash replica. For more information, see [Change node number](/tidb-cloud/scale-tidb-cluster.md#change-node-number).
47+
Before v8.3.0, TiDB only supports generating valid execution plans for the `WITH ROLLUP` syntax in [TiFlash MPP mode](/tiflash/use-tiflash-mpp-mode.md). Therefore, your TiDB cluster needs to contain TiFlash nodes, and the target table must be configured with the correct TiFlash replica. For more information, see [Change node count](/tidb-cloud/scale-tidb-cluster.md#change-node-count).
4848

4949
</CustomContent>
5050

‎grafana-overview-dashboard.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -18,7 +18,7 @@ To understand the key metrics displayed on the Overview dashboard, check the fol
1818

1919
| Service | Panel Name | Description | Normal Range |
2020
| ---- | ---------------- | ---------------------------------- | -------------- |
21-
| Services Port Status | Services Up | The online nodes number of each service. |
21+
| Services Port Status | Services Up | The number of online nodes of each service. |
2222
| PD | PD role | The role of the current PD. |
2323
| PD | Storage capacity | The total storage capacity of the TiDB cluster. |
2424
| PD | Current storage size | The occupied storage capacity of the TiDB cluster, including the space occupied by TiKV replicas. |

‎tidb-cloud/backup-and-restore.md‎

Lines changed: 2 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -309,7 +309,7 @@ To restore your TiDB Cloud Dedicated cluster data from a backup to a new cluster
309309

310310
- Set the cluster name.
311311
- Update the port number of the cluster.
312-
- Increase node number, vCPU and RAM, and storage for the cluster.
312+
- Increase the number of nodes, vCPU and RAM, and storage for the cluster.
313313

314314
7. Click **Restore**.
315315

@@ -337,7 +337,7 @@ To restore a deleted TiDB Cloud Dedicated cluster from the Recycle Bin, take the
337337
5. On the **Restore** page, specify a name for the new cluster, and then make the following changes if necessary:
338338

339339
- Update the port number of the cluster.
340-
- Increase the node number, vCPU and RAM, and storage for the cluster.
340+
- Increase the number of nodes, vCPU and RAM, and storage for the cluster.
341341

342342
6. In the **Summary** section, check the restore information, and then click **Restore**.
343343

‎tidb-cloud/monitor-built-in-alerting.md‎

Lines changed: 12 additions & 12 deletions
Original file line numberDiff line numberDiff line change
@@ -68,18 +68,18 @@ TiDB Cloud provides different alert rules for each [TiDB Cloud plan](/tidb-cloud
6868

6969
| Condition | Recommended Action |
7070
|:--- |:--- |
71-
| Total TiDB node memory utilization across cluster exceeded 70% for 10 minutes | Consider increasing the node number or node size for TiDB to reduce the memory usage percentage of the current workload.|
72-
| Total TiKV node memory utilization across cluster exceeded 70% for 10 minutes | Consider increasing the node number or node size for TiKV to reduce the memory usage percentage of the current workload. |
73-
| Total TiFlash node memory utilization across cluster exceeded 70% for 10 minutes | Consider increasing the node number or node size for TiFlash to reduce the memory usage percentage of the current workload. |
74-
| Total TiDB node CPU utilization exceeded 80% for 10 minutes | Consider increasing the node number or node size for TiDB to reduce the CPU usage percentage of the current workload.|
75-
| Total TiKV node CPU utilization exceeded 80% for 10 minutes | Consider increasing the node number or node size for TiKV to reduce the CPU usage percentage of the current workload. |
76-
| Total TiFlash node CPU utilization exceeded 80% for 10 minutes | Consider increasing the node number or node size for TiFlash to reduce the CPU usage percentage of the current workload. |
77-
| TiKV storage utilization exceeds 80% | Consider increasing the node number or node storage size for TiKV to increase your storage capacity. When the storage usage of TiKV exceeds 80%, latency spikes might occur, and higher usage might cause requests to fail. |
78-
| TiFlash storage utilization exceeds 80% | Consider increasing the node number or node storage size for TiFlash to increase your storage capacity. When the storage usage of all TiFlash nodes reaches 80%, any DDL statement that adds a TiFlash replica hangs indefinitely. |
79-
| Max memory utilization across TiDB nodes exceeded 70% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node number or node size for TiDB to reduce the memory usage percentage of the current workload. |
80-
| Max memory utilization across TiKV nodes exceeded 70% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node number or node size for TiKV to reduce the memory usage percentage of the current workload. |
81-
| Max CPU utilization across TiDB nodes exceeded 80% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node number or node size for TiDB to reduce the CPU usage percentage of the current workload. |
82-
| Max CPU utilization across TiKV nodes exceeded 80% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node number or node size for TiKV to reduce the CPU usage percentage of the current workload. |
71+
| Total TiDB node memory utilization across cluster exceeded 70% for 10 minutes | Consider increasing the node count or node size for TiDB to reduce the memory usage percentage of the current workload.|
72+
| Total TiKV node memory utilization across cluster exceeded 70% for 10 minutes | Consider increasing the node count or node size for TiKV to reduce the memory usage percentage of the current workload. |
73+
| Total TiFlash node memory utilization across cluster exceeded 70% for 10 minutes | Consider increasing the node count or node size for TiFlash to reduce the memory usage percentage of the current workload. |
74+
| Total TiDB node CPU utilization exceeded 80% for 10 minutes | Consider increasing the node count or node size for TiDB to reduce the CPU usage percentage of the current workload.|
75+
| Total TiKV node CPU utilization exceeded 80% for 10 minutes | Consider increasing the node count or node size for TiKV to reduce the CPU usage percentage of the current workload. |
76+
| Total TiFlash node CPU utilization exceeded 80% for 10 minutes | Consider increasing the node count or node size for TiFlash to reduce the CPU usage percentage of the current workload. |
77+
| TiKV storage utilization exceeds 80% | Consider increasing the node count or node storage size for TiKV to increase your storage capacity. When the storage usage of TiKV exceeds 80%, latency spikes might occur, and higher usage might cause requests to fail. |
78+
| TiFlash storage utilization exceeds 80% | Consider increasing the node count or node storage size for TiFlash to increase your storage capacity. When the storage usage of all TiFlash nodes reaches 80%, any DDL statement that adds a TiFlash replica hangs indefinitely. |
79+
| Max memory utilization across TiDB nodes exceeded 70% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node count or node size for TiDB to reduce the memory usage percentage of the current workload. |
80+
| Max memory utilization across TiKV nodes exceeded 70% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node count or node size for TiKV to reduce the memory usage percentage of the current workload. |
81+
| Max CPU utilization across TiDB nodes exceeded 80% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node count or node size for TiDB to reduce the CPU usage percentage of the current workload. |
82+
| Max CPU utilization across TiKV nodes exceeded 80% for 10 minutes | Consider checking if there is any [hotspot](/tidb-cloud/tidb-cloud-sql-tuning-overview.md#hotspot-issues) in the cluster or increasing the node count or node size for TiKV to reduce the CPU usage percentage of the current workload. |
8383

8484
### Data migration alerts
8585

‎tidb-cloud/releases/notification-2023-11-14-scale-feature-maintenance.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -19,7 +19,7 @@ This notification describes the details that you need to know about the maintena
1919
2020
## Impact
2121

22-
During the maintenance window, [change vCPU and RAM](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-vcpu-and-ram) is disabled and you can not change vCPU and RAM for your Dedicated Clusters. However, you can still change the node number or storage in the Modify Cluster page. Your TiDB cluster will maintain its regular operations for data read and write, ensuring no adverse effects on your online business.
22+
During the maintenance window, [change vCPU and RAM](https://docs.pingcap.com/tidbcloud/scale-tidb-cluster#change-vcpu-and-ram) is disabled and you can not change vCPU and RAM for your Dedicated Clusters. However, you can still change the node count or storage in the Modify Cluster page. Your TiDB cluster will maintain its regular operations for data read and write, ensuring no adverse effects on your online business.
2323

2424
### Affected features of TiDB Cloud console UI
2525

‎tidb-cloud/releases/release-notes-2023.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -898,7 +898,7 @@ This page lists the release notes of [TiDB Cloud](https://www.pingcap.com/tidb-c
898898

899899
- Support decreasing the number of TiKV and TiFlash nodes to scale in a TiDB [Dedicated Tier](/tidb-cloud/select-cluster-tier.md#tidb-cloud-dedicated) cluster.
900900

901-
You can decrease the node number [via the TiDB Cloud console](/tidb-cloud/scale-tidb-cluster.md#change-node-number) or [via the TiDB Cloud API (beta)](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster).
901+
You can decrease the number of nodes [via the TiDB Cloud console](/tidb-cloud/scale-tidb-cluster.md#change-node-count) or [via the TiDB Cloud API (beta)](https://docs.pingcap.com/tidbcloud/api/v1beta#tag/Cluster/operation/UpdateCluster).
902902

903903
**Console changes**
904904

‎tidb-cloud/scalability-concepts.md‎

Lines changed: 3 additions & 3 deletions
Original file line numberDiff line numberDiff line change
@@ -26,18 +26,18 @@ A combination of both vertical and horizontal scaling is also supported in TiDB
2626

2727
## TiDB scalability
2828

29-
TiDB is for computing only and does not store data. You can configure the node number, vCPU, and RAM for TiDB.
29+
TiDB is for computing only and does not store data. You can configure the node count, vCPU, and RAM for TiDB.
3030

3131
In general, TiDB performance increases linearly with the number of TiDB nodes.
3232

3333
## TiKV scalability
3434

35-
TiKV is responsible for storing row-based data. You can configure the node number, vCPU and RAM, and storage for TiKV. The number of TiKV nodes should be at least 1 set (3 nodes in 3 different availability zones) and increase by 3 nodes.
35+
TiKV is responsible for storing row-based data. You can configure the node count, vCPU and RAM, and storage for TiKV. The number of TiKV nodes should be at least 1 set (3 nodes in 3 different availability zones) and increase by 3 nodes.
3636

3737
TiDB Cloud deploys TiKV nodes evenly to 3 availability zones in the region you select to achieve durability and high availability. In a typical 3-replica setup, your data is distributed evenly among the TiKV nodes across all availability zones and is persisted to the disk of each TiKV node. Although TiKV is mainly used for data storage, the performance of the TiKV node also varies depending on different workloads.
3838

3939
## TiFlash scalability
4040

41-
TiFlash is responsible for storing columnar data. TiFlash synchronizes data from TiKV in real time and supports real-time analytics workloads right out of the box. You can configure the node number, vCPU and RAM, and storage for TiFlash.
41+
TiFlash is responsible for storing columnar data. TiFlash synchronizes data from TiKV in real time and supports real-time analytics workloads right out of the box. You can configure the node count, vCPU and RAM, and storage for TiFlash.
4242

4343
TiDB Cloud deploys TiFlash nodes evenly to different availability zones in a region. It is recommended that you configure at least two TiFlash nodes in each TiDB Cloud Dedicated cluster and create at least two replicas of the data for high availability in your production environment.

‎tidb-cloud/scale-tidb-cluster.md‎

Lines changed: 4 additions & 4 deletions
Original file line numberDiff line numberDiff line change
@@ -12,7 +12,7 @@ summary: Learn how to scale your TiDB Cloud cluster.
1212
1313
You can scale a TiDB cluster in the following dimensions:
1414

15-
- Node number of TiDB, TiKV, and TiFlash
15+
- Node count of TiDB, TiKV, and TiFlash
1616
- vCPU and RAM of TiDB, TiKV, and TiFlash
1717
- Storage of TiKV and TiFlash
1818

@@ -22,17 +22,17 @@ For information about how to determine the size of your TiDB cluster, see [Deter
2222
>
2323
> If the vCPU and RAM size of TiDB or TiKV is set as **4 vCPU, 16 GiB**, note the following restrictions. To bypass these restrictions, you can [increase the vCPU and RAM](#change-vcpu-and-ram) first.
2424
>
25-
> - The node number of TiDB can only be set to 1 or 2, and the node number of TiKV is fixed to 3.
25+
> - The node count of TiDB can only be set to 1 or 2, and the node count of TiKV is fixed to 3.
2626
> - 4 vCPU TiDB can only be used with 4 vCPU TiKV, and 4 vCPU TiKV can only be used with 4 vCPU TiDB.
2727
> - TiFlash is unavailable.
2828
29-
## Change node number
29+
## Change node count
3030

3131
You can increase or decrease the number of TiDB, TiKV, or TiFlash nodes.
3232

3333
> **Warning:**
3434
>
35-
> Decreasing TiKV or TiFlash node number can be risky, which might lead to insufficient storage space, excessive CPU usage, or excessive memory usage on remaining nodes.
35+
> Decreasing TiKV or TiFlash node count can be risky, which might lead to insufficient storage space, excessive CPU usage, or excessive memory usage on remaining nodes.
3636
3737
To change the number of TiDB, TiKV, or TiFlash nodes, take the following steps:
3838

‎tidb-cloud/terraform-use-cluster-resource.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -265,7 +265,7 @@ In the results:
265265
266266
- `cloud_provider` is the cloud provider on which a TiDB cluster can be hosted.
267267
- `region` is the region of `cloud_provider`.
268-
- `node_quantity_range` shows the minimum node number and the step to scale a node.
268+
- `node_quantity_range` shows the minimum node count and the step to scale a node.
269269
- `node_size` is the size of a node.
270270
- `storage_size_gib_range` shows the minimum and maximum storage size you can set for a node.
271271

‎tidb-cloud/tiproxy-management.md‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -26,7 +26,7 @@ The following table shows the maximum QPS and network bandwidth of each TiProxy
2626
| Small | 30K | 93 MiB/s |
2727
| Large | 120K | 312 MiB/s |
2828

29-
The available TiProxy sizes are `Small` and `Large`. The available TiProxy node numbers are 2, 3, 6, 9, 12, 15, 18, 21, and 24. The default two small-sized TiProxy nodes can provide 60K QPS and 186 MiB/s network bandwidth. It is recommended that you reserve 20% of the QPS capacity to prevent high latency.
29+
The available TiProxy sizes are `Small` and `Large`. The available TiProxy node counts are 2, 3, 6, 9, 12, 15, 18, 21, and 24. The default two small-sized TiProxy nodes can provide 60K QPS and 186 MiB/s network bandwidth. It is recommended that you reserve 20% of the QPS capacity to prevent high latency.
3030

3131
For example, if your cluster's maximum QPS is 100K and the maximum network bandwidth is 100 MiB/s, the size and number of TiProxy nodes mainly depend on the QPS. In this case, you can select 6 small-sized TiProxy nodes.
3232

0 commit comments

Comments
 (0)