From c72f1f6cd022c80d1a82572e8bb96da27799743c Mon Sep 17 00:00:00 2001
From: Ti Chi Robot <ti-community-prow-bot@tidb.io>
Date: Wed, 24 Jul 2024 09:45:05 +0800
Subject: [PATCH] Document pre/post upgrade and reload scripts (#17880)
 (#18084)

---
 tiup/tiup-component-cluster-reload.md  | 20 ++++++++++++++++++++
 tiup/tiup-component-cluster-upgrade.md | 20 ++++++++++++++++++++
 2 files changed, 40 insertions(+)

diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md
index 7b8652eaa3ae..79807c6d4c57 100644
--- a/tiup/tiup-component-cluster-reload.md
+++ b/tiup/tiup-component-cluster-reload.md
@@ -71,6 +71,26 @@ tiup cluster reload <cluster-name> [flags]
 - 数据类型：`BOOLEAN`
 - 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
+#### --pre-restart-script
+
+> **警告：**
+>
+> 该选项目前为实验特性，不建议在生产环境中使用。
+
+- 在重新加载配置前运行该脚本。
+- 数据类型：`STRINGS`
+- 该选项指定节点在重新加载配置前要运行的脚本的路径。当 `--skip-restart` 为 `true`，该选项不生效。
+
+### --post-restart-script
+
+> **警告：**
+>
+> 该选项目前为实验特性，不建议在生产环境中使用。
+
+- 在重新加载配置后运行该脚本。
+- 数据类型：`STRINGS`
+- 该选项指定节点在重新加载配置后要运行的脚本的路径。当 `--skip-restart` 为 `true`，该选项不生效。
+
 ## 输出
 
 tiup-cluster 的执行日志。
diff --git a/tiup/tiup-component-cluster-upgrade.md b/tiup/tiup-component-cluster-upgrade.md
index 67645c844d6d..e7c01526a1b0 100644
--- a/tiup/tiup-component-cluster-upgrade.md
+++ b/tiup/tiup-component-cluster-upgrade.md
@@ -119,6 +119,26 @@ tiup cluster upgrade <cluster-name> <version> [flags]
 - 数据类型：`BOOLEAN`
 - 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
+### ---pre-upgrade-script
+
+> **警告：**
+>
+> 该选项目前为实验特性，不建议在生产环境中使用。
+
+- 在升级前运行该脚本。
+- 数据类型：`STRINGS`
+- 该选项指定节点在升级前要运行的脚本的路径。
+
+### ---post-upgrade-script
+
+> **警告：**
+>
+> 该选项目前为实验特性，不建议在生产环境中使用。
+
+- 在升级后运行该脚本。
+- 数据类型：`STRINGS`
+- 该选项指定节点在升级后要运行的脚本的路径。该脚本只会在已完成升级的节点上运行。
+
 ## 输出
 
 升级服务的日志。