Document pre/post upgrade and reload scripts (#17880)

pingcap · Jul 23, 2024 · 182f45b · 182f45b
1 parent 5e14992
commit 182f45b
Show file tree

Hide file tree

Showing 2 changed files with 40 additions and 0 deletions.
diff --git a/tiup/tiup-component-cluster-reload.md b/tiup/tiup-component-cluster-reload.md
@@ -72,6 +72,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
@@ -120,6 +120,26 @@ tiup cluster upgrade <cluster-name> <version> [flags]
 - 数据类型：`BOOLEAN`
 - 该选项默认关闭，默认值为 `false`。在命令中添加该选项，并传入 `true` 值或不传值，均可开启此功能。
 
+### ---pre-upgrade-script
+
+> **警告：**
+>
+> 该选项目前为实验特性，不建议在生产环境中使用。
+
+- 在升级前运行该脚本。
+- 数据类型：`STRINGS`
+- 该选项指定节点在升级前要运行的脚本的路径。
+
+### ---post-upgrade-script
+
+> **警告：**
+>
+> 该选项目前为实验特性，不建议在生产环境中使用。
+
+- 在升级后运行该脚本。
+- 数据类型：`STRINGS`
+- 该选项指定节点在升级后要运行的脚本的路径。该脚本只会在已完成升级的节点上运行。
+
 ## 输出
 
 升级服务的日志。