Skip to content

Commit

Permalink
*: add a note to clarify IP addresses (#20049)
Browse files Browse the repository at this point in the history
  • Loading branch information
lilin90 authored Jan 20, 2025
1 parent cdc3caa commit 26e8462
Show file tree
Hide file tree
Showing 8 changed files with 32 additions and 0 deletions.
4 changes: 4 additions & 0 deletions geo-distributed-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ This document takes the typical architecture of three data centers (DC) in two c
| TiKV | 5 | 16 VCore 32GB 4TB (nvme ssd) * 1 | 10.0.1.11 <br/> 10.0.1.12 <br/> 10.0.1.13 <br/> 10.0.1.14 | 10.0.1.15 | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.16 | | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology templates

- [The geo-distributed topology template](https://github.com/pingcap/docs/blob/master/config-templates/geo-redundancy-deployment.yaml)
Expand Down
4 changes: 4 additions & 0 deletions hybrid-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -21,6 +21,10 @@ The deployment machine has multiple CPU processors with sufficient memory. To im
| TiKV | 6 | 32 VCore 64GB | 10.0.1.7<br/> 10.0.1.8<br/> 10.0.1.9 | 1. Separate the instance-level port and status_port; <br/> 2. Configure the global parameters `readpool`, `storage` and `raftstore`; <br/> 3. Configure labels of the instance-level host; <br/> 4. Configure NUMA to bind CPU cores |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.10 | Default configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology templates

- [The simple template for the hybrid deployment](https://github.com/pingcap/docs/blob/master/config-templates/simple-multi-instance.yaml)
Expand Down
4 changes: 4 additions & 0 deletions minimal-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -17,6 +17,10 @@ This document describes the minimal deployment topology of TiDB clusters.
| TiKV | 3 | 16 VCore 32 GiB <br/> 2 TiB (NVMe SSD) for storage | 10.0.1.7 <br/> 10.0.1.8 <br/> 10.0.1.9 | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8 GiB <br/> 500 GiB (SSD) for storage | 10.0.1.10 | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology templates

- [The simple template for the minimal topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-mini.yaml)
Expand Down
4 changes: 4 additions & 0 deletions pd-microservices-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -18,6 +18,10 @@ This document describes the deployment topology of [PD microservices](/pd-micros
| TiKV | 3 | 16 VCore 32GB 2TB (nvme ssd) * 1 | 10.0.1.10 <br/> 10.0.1.11 <br/> 10.0.1.12 | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.13 | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology template

<details>
Expand Down
4 changes: 4 additions & 0 deletions ticdc-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -24,6 +24,10 @@ TiCDC is a tool for replicating the incremental data of TiDB, introduced in TiDB
| CDC | 3 | 8 VCore 16GB * 1 | 10.0.1.11 <br/> 10.0.1.12 <br/> 10.0.1.13 | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.11 | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology templates

- [The simple template for the TiCDC topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-cdc.yaml)
Expand Down
4 changes: 4 additions & 0 deletions tiflash-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -20,6 +20,10 @@ TiFlash is a columnar storage engine, and gradually becomes the standard cluster
| TiFlash | 1 | 32 VCore 64 GB 2TB (nvme ssd) * 1 | 10.0.1.11 | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.10 | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology templates

- [The simple template for the TiFlash topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-tiflash.yaml)
Expand Down
4 changes: 4 additions & 0 deletions tiproxy/tiproxy-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ TiProxy is a L7 proxy server for TiDB, which can balance connections and migrate
| TiProxy | 2 | 4 VCore 8 GB * 1 | 10.0.1.11 <br/> 10.0.1.12 | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.13 | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
### Topology templates

For more information about the template for TiProxy, see [The simple template for the TiProxy topology](https://github.com/pingcap/docs/blob/master/config-templates/simple-tiproxy.yaml).
Expand Down
4 changes: 4 additions & 0 deletions tispark-deployment-topology.md
Original file line number Diff line number Diff line change
Expand Up @@ -25,6 +25,10 @@ For more information about the TiSpark architecture and how to use it, see [TiSp
| TiSpark | 3 | 8 VCore 16GB * 1 | 10.0.1.21 (master) <br/> 10.0.1.22 (worker) <br/> 10.0.1.23 (worker) | Default port <br/> Global directory configuration |
| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.11 | Default port <br/> Global directory configuration |

> **Note:**
>
> The IP addresses of the instances are given as examples only. In your actual deployment, replace the IP addresses with your actual IP addresses.
## Topology templates

- [Simple TiSpark topology template](https://github.com/pingcap/docs/blob/master/config-templates/simple-tispark.yaml)
Expand Down

0 comments on commit 26e8462

Please sign in to comment.