From 7f196c94d5a6c8038618ce5ecf5709c2d2a36956 Mon Sep 17 00:00:00 2001 From: Lilian Lee Date: Mon, 20 Jan 2025 16:47:23 +0800 Subject: [PATCH 1/2] This is an automated cherry-pick of #19594 Signed-off-by: ti-chi-bot --- geo-distributed-deployment-topology.md | 4 + hybrid-deployment-topology.md | 4 + minimal-deployment-topology.md | 4 + pd-microservices-deployment-topology.md | 96 +++++++++++++++++++++ ticdc-deployment-topology.md | 4 + tiflash-deployment-topology.md | 4 + tiproxy/tiproxy-deployment-topology.md | 108 ++++++++++++++++++++++++ tispark-deployment-topology.md | 4 + 8 files changed, 228 insertions(+) create mode 100644 pd-microservices-deployment-topology.md create mode 100644 tiproxy/tiproxy-deployment-topology.md diff --git a/geo-distributed-deployment-topology.md b/geo-distributed-deployment-topology.md index 2fe3770245d1..a4f62ea772a8 100644 --- a/geo-distributed-deployment-topology.md +++ b/geo-distributed-deployment-topology.md @@ -16,6 +16,10 @@ summary: 介绍跨数据中心部署 TiDB 集群的拓扑结构。 | TiKV | 5 | 16 VCore 32GB 4TB (nvme ssd) * 1 | 10.0.1.11
10.0.1.12
10.0.1.13
10.0.1.14 | 10.0.1.15 | 默认端口
全局目录配置 | | Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.16 || 默认端口
全局目录配置 | +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + ### 拓扑模版
diff --git a/hybrid-deployment-topology.md b/hybrid-deployment-topology.md index 55a1aa61b4e1..43d7546f8789 100644 --- a/hybrid-deployment-topology.md +++ b/hybrid-deployment-topology.md @@ -16,6 +16,10 @@ summary: 介绍混合部署 TiDB 集群的拓扑结构。 | TiKV | 6 | 32 VCore 64GB | 10.0.1.7
10.0.1.8
10.0.1.9 | 1. 区分实例级别的 port、status_port；
2. 配置全局参数 readpool、storage 以及 raftstore；
3. 配置实例级别 host 维度的 labels；
4. 配置 numa 绑核操作| | Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.10 | 默认配置 | +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + ### 拓扑模版
diff --git a/minimal-deployment-topology.md b/minimal-deployment-topology.md index 078f95e8168d..3596b9080163 100644 --- a/minimal-deployment-topology.md +++ b/minimal-deployment-topology.md @@ -16,6 +16,10 @@ summary: 介绍 TiDB 集群的最小拓扑。 | TiKV | 3 | 16 VCore 32 GiB
2 TiB (NVMe SSD) 用于存储 | 10.0.1.7
10.0.1.8
10.0.1.9 | 默认端口
全局目录配置 | | Monitoring & Grafana | 1 | 4 VCore 8 GiB
500 GiB (SSD) 用于存储 | 10.0.1.10 | 默认端口
全局目录配置 | +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + ### 拓扑模版
diff --git a/pd-microservices-deployment-topology.md b/pd-microservices-deployment-topology.md new file mode 100644 index 000000000000..a66383cc9c37 --- /dev/null +++ b/pd-microservices-deployment-topology.md @@ -0,0 +1,96 @@ +--- +title: PD 微服务部署拓扑 +summary: 了解在部署最小拓扑集群的基础上，部署 PD 微服务的拓扑结构。 +--- + +# PD 微服务部署拓扑 + +本文介绍在部署最小拓扑集群的基础上，部署 [PD 微服务](/pd-microservices.md)的拓扑结构。 + +## 拓扑信息 + +| 实例 | 个数 | 物理机配置 | IP | 配置 | +| :------------------- | :--- | :-------------------------------- | :---------------------------------------- | :-------------------------- | +| TiDB | 2 | 16 VCore 32GB \* 1 | 10.0.1.1
10.0.1.2 | 默认端口
全局目录配置 | +| PD | 3 | 4 VCore 8GB \* 1 | 10.0.1.3
10.0.1.4
10.0.1.5 | 默认端口
全局目录配置 | +| TSO | 2 | 4 VCore 8GB \* 1 | 10.0.1.6
10.0.1.7 | 默认端口
全局目录配置 | +| Scheduling | 2 | 4 VCore 8GB \* 1 | 10.0.1.8
10.0.1.9 | 默认端口
全局目录配置 | +| TiKV | 3 | 16 VCore 32GB 2TB (nvme ssd) \* 1 | 10.0.1.10
10.0.1.11
10.0.1.12 | 默认端口
全局目录配置 | +| Monitoring & Grafana | 1 | 4 VCore 8GB \* 1 500GB (ssd) | 10.0.1.13 | 默认端口
全局目录配置 | + +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + +### 拓扑模版 + +
+简单 PD 微服务配置模版 + +```yaml +# # Global variables are applied to all deployments and used as the default value of +# # the deployments if a specific deployment value is missing. +global: + user: "tidb" + ssh_port: 22 + deploy_dir: "/tidb-deploy" + data_dir: "/tidb-data" + listen_host: 0.0.0.0 + arch: "amd64" + pd_mode: "ms" # To enable PD microservices, you must specify this field as "ms". + +monitored: + node_exporter_port: 9200 + blackbox_exporter_port: 9215 + +# # Specifies the configuration of PD servers. +pd_servers: + - host: 10.0.1.3 + - host: 10.0.1.4 + - host: 10.0.1.5 + +# # Specifies the configuration of TiDB servers. +tidb_servers: + - host: 10.0.1.1 + - host: 10.0.1.2 + +# # Specifies the configuration of TiKV servers. +tikv_servers: + - host: 10.0.1.10 + - host: 10.0.1.11 + - host: 10.0.1.12 + +# # Specifies the configuration of TSO servers. +tso_servers: + - host: 10.0.1.6 + - host: 10.0.1.7 + +# # Specifies the configuration of Scheduling servers. +scheduling_servers: + - host: 10.0.1.8 + - host: 10.0.1.9 + +# # Specifies the configuration of Prometheus servers. +monitoring_servers: + - host: 10.0.1.13 + +# # Specifies the configuration of Grafana servers. +grafana_servers: + - host: 10.0.1.13 +``` + +
+ +以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。 + +### 关键参数介绍 + +- `tso_servers` 实例级别配置 `host` 目前只支持 IP 地址，不支持域名。 +- TSO 具体的参数配置介绍可参考 [TSO 参数配置](/tso-configuration-file.md)。 +- `scheduling_servers` 实例级别配置 `host` 目前只支持 IP 地址，不支持域名。 +- Scheduling 具体的参数配置介绍可参考 [Scheduling 参数配置](/scheduling-configuration-file.md)。 + +> **注意：** +> +> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。 +> - 如果部署目录配置为相对路径，会部署在用户的 Home 目录下。 diff --git a/ticdc-deployment-topology.md b/ticdc-deployment-topology.md index f6330b54156c..cc6379bd3853 100644 --- a/ticdc-deployment-topology.md +++ b/ticdc-deployment-topology.md @@ -21,6 +21,10 @@ summary: 介绍 TiCDC 部署 TiDB 集群的拓扑结构。 | CDC | 3 | 8 VCore 16GB * 1 | 10.0.1.11
10.0.1.12
10.0.1.13 | 默认端口
全局目录配置 | | Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.11 | 默认端口
全局目录配置 | +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + ### 拓扑模版
diff --git a/tiflash-deployment-topology.md b/tiflash-deployment-topology.md index d73fff225071..5205857b24c8 100644 --- a/tiflash-deployment-topology.md +++ b/tiflash-deployment-topology.md @@ -17,6 +17,10 @@ summary: 了解在部署最小拓扑集群的基础上，部署 TiFlash 的拓 | TiFlash | 1 | 32 VCore 64 GB 2TB (nvme ssd) * 1 | 10.0.1.11 | 默认端口
全局目录配置 | | Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.10 | 默认端口
全局目录配置 | +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + ### 拓扑模版
diff --git a/tiproxy/tiproxy-deployment-topology.md b/tiproxy/tiproxy-deployment-topology.md new file mode 100644 index 000000000000..6d52b23c620b --- /dev/null +++ b/tiproxy/tiproxy-deployment-topology.md @@ -0,0 +1,108 @@ +--- +title: TiProxy 部署拓扑 +summary: 了解在部署最小拓扑集群的基础上，部署 TiProxy 的拓扑结构。 +--- + +# TiProxy 部署拓扑 + +本文介绍在部署最小拓扑集群的基础上，部署 [TiProxy](/tiproxy/tiproxy-overview.md) 的拓扑结构。 + +其他部署方式，请参考以下文档： + +- 使用 TiDB Operator 部署 TiProxy，请参见 [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tiproxy) 文档。 +- 使用 TiUP 本地快速部署 TiProxy，请参见[部署 TiProxy](/tiup/tiup-playground.md#部署-tiproxy)。 +- 使用 TiUP 部署 TiProxy，请参见 [TiProxy 安装和使用](/tiproxy/tiproxy-overview.md#安装和使用)。 + +TiProxy 是 TiDB 的 L7 代理，可以平衡连接并迁移会话。 + +## 拓扑信息 + +| 实例 | 个数 | 物理机配置 | IP | 配置 | +| :-- | :-- | :-- | :-- | :-- | +| TiDB | 3 | 16 VCore 32GB * 3 | 10.0.1.4
10.0.1.5
10.0.1.6 | 默认端口
全局目录配置 | +| PD | 3 | 4 VCore 8GB * 3 | 10.0.1.1
10.0.1.2
10.0.1.3 | 默认端口
全局目录配置 | +| TiKV | 3 | 16 VCore 32GB 2TB (nvme ssd) * 3 | 10.0.1.7
10.0.1.8
10.0.1.9 | 默认端口
全局目录配置 | +| TiProxy | 2 | 4 VCore 8 GB * 1 | 10.0.1.11
10.0.1.12 | 默认端口
全局目录配置 | +| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.13 | 默认端口
全局目录配置 | + +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + +### 拓扑模版 + +
+简单 TiProxy 配置模版 + +```yaml +# # Global variables are applied to all deployments and used as the default value of +# # the deployments if a specific deployment value is missing. +global: + user: "tidb" + ssh_port: 22 + deploy_dir: "/tidb-deploy" + data_dir: "/tidb-data" +component_versions: + tiproxy: "v1.2.0" +server_configs: + tidb: + graceful-wait-before-shutdown: 15 + tiproxy: + ha.virtual-ip: "10.0.1.10/24" + ha.interface: "eth0" + graceful-wait-before-shutdown: 15 + +pd_servers: + - host: 10.0.1.1 + - host: 10.0.1.2 + - host: 10.0.1.3 + +tidb_servers: + - host: 10.0.1.4 + - host: 10.0.1.5 + - host: 10.0.1.6 + +tikv_servers: + - host: 10.0.1.7 + - host: 10.0.1.8 + - host: 10.0.1.9 + +tiproxy_servers: + - host: 10.0.1.11 + deploy_dir: "/tiproxy-deploy" + data_dir: "/tiproxy-data" + port: 6000 + status_port: 3080 + config: + labels: { zone: "east" } + - host: 10.0.1.12 + deploy_dir: "/tiproxy-deploy" + data_dir: "/tiproxy-data" + port: 6000 + status_port: 3080 + config: + labels: { zone: "west" } + +monitoring_servers: + - host: 10.0.1.13 + +grafana_servers: + - host: 10.0.1.13 + +alertmanager_servers: + - host: 10.0.1.13 +``` + +
+ +以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。 + +### 关键参数介绍 + +- `tiproxy_servers` 实例级别配置 `"-host"` 目前只支持 IP，不支持域名。 +- TiProxy 具体的参数配置介绍可参考 [TiProxy 参数配置](/tiproxy/tiproxy-configuration.md)。 + +> **注意：** +> +> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。 +> - 如果部署目录配置为相对路径，会部署在用户的 Home 目录下。 diff --git a/tispark-deployment-topology.md b/tispark-deployment-topology.md index cff9a8bf31cd..93c8e2c6bc8f 100644 --- a/tispark-deployment-topology.md +++ b/tispark-deployment-topology.md @@ -23,6 +23,10 @@ summary: 介绍 TiUP 部署包含 TiSpark 组件的 TiDB 集群的拓扑结构 | TiSpark | 3 | 8 VCore 16GB * 1 | 10.0.1.21 (master)
10.0.1.22 (worker)
10.0.1.23 (worker) | 默认端口
全局目录配置 | | Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.11 | 默认端口
全局目录配置 | +> **注意：** +> +> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 + ### 拓扑模版
From 864d5130e6f85686268a68fc220edff709e29cc6 Mon Sep 17 00:00:00 2001 From: lilin90 Date: Mon, 20 Jan 2025 18:07:30 +0800 Subject: [PATCH 2/2] Remove two inapplicable files --- pd-microservices-deployment-topology.md | 96 --------------------- tiproxy/tiproxy-deployment-topology.md | 108 ------------------------ 2 files changed, 204 deletions(-) delete mode 100644 pd-microservices-deployment-topology.md delete mode 100644 tiproxy/tiproxy-deployment-topology.md diff --git a/pd-microservices-deployment-topology.md b/pd-microservices-deployment-topology.md deleted file mode 100644 index a66383cc9c37..000000000000 --- a/pd-microservices-deployment-topology.md +++ /dev/null @@ -1,96 +0,0 @@ ---- -title: PD 微服务部署拓扑 -summary: 了解在部署最小拓扑集群的基础上，部署 PD 微服务的拓扑结构。 ---- - -# PD 微服务部署拓扑 - -本文介绍在部署最小拓扑集群的基础上，部署 [PD 微服务](/pd-microservices.md)的拓扑结构。 - -## 拓扑信息 - -| 实例 | 个数 | 物理机配置 | IP | 配置 | -| :------------------- | :--- | :-------------------------------- | :---------------------------------------- | :-------------------------- | -| TiDB | 2 | 16 VCore 32GB \* 1 | 10.0.1.1
10.0.1.2 | 默认端口
全局目录配置 | -| PD | 3 | 4 VCore 8GB \* 1 | 10.0.1.3
10.0.1.4
10.0.1.5 | 默认端口
全局目录配置 | -| TSO | 2 | 4 VCore 8GB \* 1 | 10.0.1.6
10.0.1.7 | 默认端口
全局目录配置 | -| Scheduling | 2 | 4 VCore 8GB \* 1 | 10.0.1.8
10.0.1.9 | 默认端口
全局目录配置 | -| TiKV | 3 | 16 VCore 32GB 2TB (nvme ssd) \* 1 | 10.0.1.10
10.0.1.11
10.0.1.12 | 默认端口
全局目录配置 | -| Monitoring & Grafana | 1 | 4 VCore 8GB \* 1 500GB (ssd) | 10.0.1.13 | 默认端口
全局目录配置 | - -> **注意：** -> -> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 - -### 拓扑模版 - -
-简单 PD 微服务配置模版 - -```yaml -# # Global variables are applied to all deployments and used as the default value of -# # the deployments if a specific deployment value is missing. -global: - user: "tidb" - ssh_port: 22 - deploy_dir: "/tidb-deploy" - data_dir: "/tidb-data" - listen_host: 0.0.0.0 - arch: "amd64" - pd_mode: "ms" # To enable PD microservices, you must specify this field as "ms". - -monitored: - node_exporter_port: 9200 - blackbox_exporter_port: 9215 - -# # Specifies the configuration of PD servers. -pd_servers: - - host: 10.0.1.3 - - host: 10.0.1.4 - - host: 10.0.1.5 - -# # Specifies the configuration of TiDB servers. -tidb_servers: - - host: 10.0.1.1 - - host: 10.0.1.2 - -# # Specifies the configuration of TiKV servers. -tikv_servers: - - host: 10.0.1.10 - - host: 10.0.1.11 - - host: 10.0.1.12 - -# # Specifies the configuration of TSO servers. -tso_servers: - - host: 10.0.1.6 - - host: 10.0.1.7 - -# # Specifies the configuration of Scheduling servers. -scheduling_servers: - - host: 10.0.1.8 - - host: 10.0.1.9 - -# # Specifies the configuration of Prometheus servers. -monitoring_servers: - - host: 10.0.1.13 - -# # Specifies the configuration of Grafana servers. -grafana_servers: - - host: 10.0.1.13 -``` - -
- -以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。 - -### 关键参数介绍 - -- `tso_servers` 实例级别配置 `host` 目前只支持 IP 地址，不支持域名。 -- TSO 具体的参数配置介绍可参考 [TSO 参数配置](/tso-configuration-file.md)。 -- `scheduling_servers` 实例级别配置 `host` 目前只支持 IP 地址，不支持域名。 -- Scheduling 具体的参数配置介绍可参考 [Scheduling 参数配置](/scheduling-configuration-file.md)。 - -> **注意：** -> -> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。 -> - 如果部署目录配置为相对路径，会部署在用户的 Home 目录下。 diff --git a/tiproxy/tiproxy-deployment-topology.md b/tiproxy/tiproxy-deployment-topology.md deleted file mode 100644 index 6d52b23c620b..000000000000 --- a/tiproxy/tiproxy-deployment-topology.md +++ /dev/null @@ -1,108 +0,0 @@ ---- -title: TiProxy 部署拓扑 -summary: 了解在部署最小拓扑集群的基础上，部署 TiProxy 的拓扑结构。 ---- - -# TiProxy 部署拓扑 - -本文介绍在部署最小拓扑集群的基础上，部署 [TiProxy](/tiproxy/tiproxy-overview.md) 的拓扑结构。 - -其他部署方式，请参考以下文档： - -- 使用 TiDB Operator 部署 TiProxy，请参见 [TiDB Operator](https://docs.pingcap.com/zh/tidb-in-kubernetes/stable/deploy-tiproxy) 文档。 -- 使用 TiUP 本地快速部署 TiProxy，请参见[部署 TiProxy](/tiup/tiup-playground.md#部署-tiproxy)。 -- 使用 TiUP 部署 TiProxy，请参见 [TiProxy 安装和使用](/tiproxy/tiproxy-overview.md#安装和使用)。 - -TiProxy 是 TiDB 的 L7 代理，可以平衡连接并迁移会话。 - -## 拓扑信息 - -| 实例 | 个数 | 物理机配置 | IP | 配置 | -| :-- | :-- | :-- | :-- | :-- | -| TiDB | 3 | 16 VCore 32GB * 3 | 10.0.1.4
10.0.1.5
10.0.1.6 | 默认端口
全局目录配置 | -| PD | 3 | 4 VCore 8GB * 3 | 10.0.1.1
10.0.1.2
10.0.1.3 | 默认端口
全局目录配置 | -| TiKV | 3 | 16 VCore 32GB 2TB (nvme ssd) * 3 | 10.0.1.7
10.0.1.8
10.0.1.9 | 默认端口
全局目录配置 | -| TiProxy | 2 | 4 VCore 8 GB * 1 | 10.0.1.11
10.0.1.12 | 默认端口
全局目录配置 | -| Monitoring & Grafana | 1 | 4 VCore 8GB * 1 500GB (ssd) | 10.0.1.13 | 默认端口
全局目录配置 | - -> **注意：** -> -> 该表中拓扑实例的 IP 为示例 IP。在实际部署时，请替换为实际的 IP。 - -### 拓扑模版 - -
-简单 TiProxy 配置模版 - -```yaml -# # Global variables are applied to all deployments and used as the default value of -# # the deployments if a specific deployment value is missing. -global: - user: "tidb" - ssh_port: 22 - deploy_dir: "/tidb-deploy" - data_dir: "/tidb-data" -component_versions: - tiproxy: "v1.2.0" -server_configs: - tidb: - graceful-wait-before-shutdown: 15 - tiproxy: - ha.virtual-ip: "10.0.1.10/24" - ha.interface: "eth0" - graceful-wait-before-shutdown: 15 - -pd_servers: - - host: 10.0.1.1 - - host: 10.0.1.2 - - host: 10.0.1.3 - -tidb_servers: - - host: 10.0.1.4 - - host: 10.0.1.5 - - host: 10.0.1.6 - -tikv_servers: - - host: 10.0.1.7 - - host: 10.0.1.8 - - host: 10.0.1.9 - -tiproxy_servers: - - host: 10.0.1.11 - deploy_dir: "/tiproxy-deploy" - data_dir: "/tiproxy-data" - port: 6000 - status_port: 3080 - config: - labels: { zone: "east" } - - host: 10.0.1.12 - deploy_dir: "/tiproxy-deploy" - data_dir: "/tiproxy-data" - port: 6000 - status_port: 3080 - config: - labels: { zone: "west" } - -monitoring_servers: - - host: 10.0.1.13 - -grafana_servers: - - host: 10.0.1.13 - -alertmanager_servers: - - host: 10.0.1.13 -``` - -
- -以上 TiDB 集群拓扑文件中，详细的配置项说明见[通过 TiUP 部署 TiDB 集群的拓扑文件配置](/tiup/tiup-cluster-topology-reference.md)。 - -### 关键参数介绍 - -- `tiproxy_servers` 实例级别配置 `"-host"` 目前只支持 IP，不支持域名。 -- TiProxy 具体的参数配置介绍可参考 [TiProxy 参数配置](/tiproxy/tiproxy-configuration.md)。 - -> **注意：** -> -> - 无需手动创建配置文件中的 `tidb` 用户，TiUP cluster 组件会在目标主机上自动创建该用户。可以自定义用户，也可以和中控机的用户保持一致。 -> - 如果部署目录配置为相对路径，会部署在用户的 Home 目录下。