update

Signed-off-by: husharp <[email protected]>
pingcap · Jan 2, 2024 · 8062cbe · 8062cbe
1 parent e18175c
commit 8062cbe
Show file tree

Hide file tree

Showing 2 changed files with 48 additions and 0 deletions.
diff --git a/pd-configuration-file.md b/pd-configuration-file.md
@@ -516,3 +516,38 @@ PD 中内置的 [Resource Control](/tidb-resource-control.md) 相关的配置项
 + CPU 转换成 RU 的基准系数
 + 默认值: 1/3
 + 1 RU = 3 毫秒 CPU 时间
+
+### 微服务部署
+
+PD 在 7.3.0 后支持了 [MicroServices](https://en.wikipedia.org/wiki/Microservices) 功能，下面是相关的配置项。
+
+PD 微服务的运行需要依赖一个 API 服务为其提供元信息存储以及 API 转发等功能，在实际的部署中，这个 API 服务其实就是以 API Mode 启动的 PD。所以我们的部署步骤基本上就是分为了 2 步，分别为：启动 API 服务、启动各个微服务。
+
+1.以 API Mode 启动 PD
+
+```
+./pd-server services api
+```
+
+2.启动其他微服务
+
+以 TSO 服务举例：
+
+```
+./pd-server services tso --backend-endpoints=http://{PD_API_SERVER_IP}:2379 --listen-addr=http://$(INSTANCE_IP):2379 --advertise-listen-addr=http://$(INSTANCE_IP):2379
+```
+
+这里主要注意其中几个个参数即可：
+
+- backend-endpoints 需要传入以 API Mode 启动后的 PD 服务器地址。
+- listen-addr 为 TSO 服务的连接地址。
+- advertise-listen-addr 如无特殊需要，不指定或与 listen-addr 保持一致即可。
+
+其他诸如 TLS 证书等参数没有特殊之处，按照正常情况指定即可。
+
+> **警告：**
+>
+> 当前支持的微服务包括：TSO，Scheduling，Resource Manager。
+> ./pd-server services 服务分别为：tso，scheduling，resource-manager。
+
+目前支持 [tiup playground 部署方式](./tiup/tiup-playground.md#pd-微服务部署) 以及 [TiDB-operator]()。
diff --git a/tiup/tiup-playground.md b/tiup/tiup-playground.md
@@ -184,3 +184,16 @@ tiup playground scale-out --db 2
 ```shell
 tiup playground scale-in --pid 86526
 ```
+
+## PD 微服务部署
+
+正如 [PD 微服务](/pd-configuration-file.md#微服务部署) 中介绍，我们在 playground 中提供了简易的方式进行部署。
+
+- 需要指定 `--pd.mode` 为 `ms`，启动 PD 微服务模式需要指定参数 `--pd.api num`(num>=1)
+- 目前支持 TSO, Scheduling, resource manager 三个微服务，可以通过 `--pd.tso num`，`--pd.scheduling num`，`--pd.rm num` 来分别指定启动的实例数量。
+
+{{< copyable "shell-regular" >}}
+
+```shell
+./tiup-playground v7.5.0 --pd.mode ms --pd.api 3  --pd.tso 2 --pd.rm 1 --pd.scheduling 3
+```